API v1
Em breve · Cartão

Criar pagamento com cartão

POST/v1/card-paymentscard_payments:writeEM BREVE

Gera um checkout seguro. Você não recebe nem guarda dados do cartão.

Este recurso ainda não está disponível. O contrato abaixo mostra como ele vai funcionar, para você planejar a integração. Hoje a chamada é recusada e nada é criado; os campos podem mudar até a liberação, que sai no changelog.

Cabeçalhos

Authorizationstringobrigatório

Bearer seguido da sua chave: gw_test_ em teste, gw_live_ em produção.

Idempotency-Keystring · 8–128obrigatório

Corpo da requisição

external_idstring · 1–128obrigatório
amount_centsinteger · mín. 1obrigatório

Valor em centavos.

exemplo 4990 = R$ 49,90
descriptionstring · até 200obrigatório
success_urlurlobrigatório
cancel_urlurlobrigatório
customerobjectopcional
3 campos
namestring · 2–120opcional
emailstringopcional
documentstringopcional

CPF ou CNPJ só com dígitos. Volta mascarado nas respostas.

metadataobject · até 20 chavesopcional

Pares chave-valor seus, até 2 KB.

Resposta 201

Sucesso.

iduuid
external_idstring
statusstring
PENDINGPAIDEXPIREDCANCELEDREFUNDED
amount_centsinteger
exemplo 4990 = R$ 49,90
fee_centsinteger
exemplo 149 = R$ 1,49
net_amount_centsinteger
exemplo 4841 = R$ 48,41
checkout_urlurl | null

Página segura de pagamento. Expira em 30 minutos.

available_atdatetime | null

Quando o valor fica disponível para saque.

metadataobject · até 20 chaves

Pares chave-valor seus, até 2 KB.

expires_atdatetime | null

Vencimento do checkout.

paid_atdatetime | null

Pagamento confirmado.

created_atdatetime

Códigos de resposta

HTTPQuando acontece
201Sucesso.

Outras operações de Cartão

GET/v1/card-paymentsListar pagamentos com cartãoGET/v1/card-payments/{cardPaymentId}Consultar pagamento com cartão