/sessions

Cria uma payment session no melhor gateway para o método e a moeda (ou no fixado com gateway) e devolve para onde enviar o cliente.

Server URLhttps://pay.contagorda.com/api/v1
POST/sessions

Autorização

Bearer token: a key de um app, em Apps (sk_app_live_… ou sk_app_test_…), ou a tenant key, em Settings (sk_live_… ou sk_test_…). A key define o modo: uma key live só vê dados live, uma key test só dados de sandbox.

Parâmetros

Idempotency-Keystring · headerobrigatório

Qualquer string única por operação (um id de pedido serve). A mesma key devolve o primeiro resultado em vez de criar outro.

Request body

application/json, obrigatório

amountstringobrigatório

Positivo, com no máximo 2 casas decimais, ex.: "49.90".

currencystringobrigatório
Um de BRL, USD, EUR
methodstringobrigatório
Um de card, pix, boleto
localestringopcional

Idioma da página de pagamento e do checkout do gateway. Também aceita pt, en-US e parecidos. Sem ele, vale o Idioma do checkout do app; se não houver, o navegador do cliente.

Um de en, pt-BR
return_tostringobrigatório

Para onde o cliente volta, com session_id e um token assinado.

Formato uri
gatewaystringopcional

Fixa uma configuração de gateway; sem ele, o roteador escolhe pelo método e pela moeda.

Formato uuid
metadataobjectopcional

Suas próprias keys, devolvidas como enviadas.

customerobjectopcional

Encontrado pelo external_ref, criado quando é novo; os campos de contato são mantidos atualizados.

external_refstringobrigatório

O id do usuário no seu sistema.

emailstringopcional
Formato email
namestringopcional
documentstringopcional

CPF, CNPJ ou tax id.

phonestringopcional
address_line1stringopcional
address_line2stringopcional
address_numberstringopcional
neighborhoodstringopcional
citystringopcional
statestringopcional

Duas letras, ex.: SP.

zipcodestringopcional
countrystringopcional

Duas letras, ex.: BR.

Response body

201Session criada.
idstringopcional
Formato uuid
statusstringopcional
Um de pending, processing, paid, failed, expired, refunded
amountstringopcional
currencystringopcional
methodstringopcional
gatewayobjectopcional

A configuração que processa o pagamento.

idstringopcional
Formato uuid
namestringopcional
providerstringopcional
Um de stripe, asaas, abacatepay, pagarme, cielo
sandboxbooleanopcional
redirect_urlstringopcional

Envie o cliente para cá para pagar.

Formato uri
duplicatebooleanopcional

true quando a Idempotency-Key já tinha sido usada.

created_atstringopcional
Formato date-time
200Mesma Idempotency-Key de uma chamada anterior; a primeira session volta com `duplicate: true`.
idstringopcional
Formato uuid
statusstringopcional
Um de pending, processing, paid, failed, expired, refunded
amountstringopcional
currencystringopcional
methodstringopcional
gatewayobjectopcional

A configuração que processa o pagamento.

idstringopcional
Formato uuid
namestringopcional
providerstringopcional
Um de stripe, asaas, abacatepay, pagarme, cielo
sandboxbooleanopcional
redirect_urlstringopcional

Envie o cliente para cá para pagar.

Formato uri
duplicatebooleanopcional

true quando a Idempotency-Key já tinha sido usada.

created_atstringopcional
Formato date-time
401Secret key ausente ou inválida.
errorstringopcional

O que deu errado.

422Idempotency-Key ausente, nenhum gateway para o método e a moeda, amount inválido ou registro inválido.
errorsobjectopcional

Uma mensagem por campo (idempotency_key, gateway, amount, replaces, subscription ou record).

502O gateway recusou ou falhou a chamada.
errorsobjectopcional
gatewaystringopcional

A mensagem do gateway.

providerstringopcional

O provider que falhou.

Tem certeza?

Atalhos de teclado

⌘ KBuscar e navegar⌘ JAbrir e fechar o Workbenchg hIníciog pPagamentosg cClientesg sSubscriptionsg aAppsg gGateways?Esta listaEscFechar