/sessions/{id}

Lê uma session com status, gateway, cliente e metadados. O mesmo formato chega nos webhooks session.*.

Server URLhttps://pay.contagorda.com/api/v1
GET/sessions/{id}

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

idstring · pathobrigatório

O id do recurso.

Response body

200A session.
idstringopcional
Formato uuid
statusstringopcional

pending: criada; processing: no checkout do gateway; paid: paga; failed: recusada; expired: abandonada; refunded: reembolsada.

Um de pending, processing, paid, failed, expired, refunded
amountstringopcional

Decimal com ponto, como string.

refunded_amountstringopcional

O que o gateway reembolsou até agora, no máximo amount. Igual a amount num reembolso total; menor depois de um parcial. Cada reembolso manda session.refunded de novo com o novo total.

currencystringopcional
methodstringopcional
Um de card, pix, boleto
connection_testbooleanopcional

true para os pagamentos de teste de gateway do dashboard.

subscription_idstring | nullopcional

A subscription a que este ciclo pertence.

Formato uuid
gatewayobjectopcional

A configuração que processa o pagamento.

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

O que o produto mandou no /connect, devolvido de volta. Os ciclos de renovação de uma subscription também trazem o metadata do checkout, mais description e billing_reason.

customerobject | nullopcional
idstringopcional
Formato uuid
external_refstringopcional

O seu próprio id para o cliente, como mandado no /connect.

emailstring | nullopcional
namestring | nullopcional
documentstring | nullopcional
phonestring | nullopcional
address_line1string | nullopcional
address_line2string | nullopcional
address_numberstring | nullopcional
neighborhoodstring | nullopcional
citystring | nullopcional
statestring | nullopcional
zipcodestring | nullopcional
countrystring | nullopcional
disputeobject | nullopcional

O chargeback que o banco do cliente abriu neste pagamento, ou null. A resposta é feita no dashboard do gateway; o app recebe session.disputed quando ele abre e session.dispute_closed quando o banco decide.

idstringopcional

O id da disputa no gateway.

statusstringopcional

O status do gateway: needs_response ou under_review enquanto aberta; won ou lost depois de fechada.

reasonstring | nullopcional

Por que o cliente contestou, como o gateway informa.

amountstringopcional

O valor retido pelo banco, decimal com ponto.

due_bystring | nullopcional

O último dia para enviar provas ao gateway.

Formato date-time
opened_atstringopcional
Formato date-time
closed_atstring | nullopcional

Quando o banco decidiu; null enquanto aberta.

Formato date-time
return_tostringopcional
Formato uri
expires_atstring | nullopcional
Formato date-time
created_atstringopcional
Formato date-time
updated_atstringopcional
Formato date-time
401Secret key ausente ou inválida.
errorstringopcional

O que deu errado.

404Recurso não encontrado para este tenant.
errorstringopcional

O que deu errado.

Tem certeza?

Atalhos de teclado

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