Consultar cobrança
Lê uma cobrança pelo id devolvido na criação.
GET
/v1/charges/{id}escopo: charge:readcurl https://api.transakto.io/v1/charges/8f1c2a90-1f4b-4f0e-9d33-5a2c1b7e9a10 \
-H "x-api-key: sk_live_..."Estados
status
processingstringopcional | Gravada, aguardando o adquirente devolver o Pix. Dura segundos: termina em pending ou failed. |
pendingstringopcional | Criada, aguardando pagamento. |
paidstringopcional | Paga e confirmada pelo adquirente. |
expiredstringopcional | Passou de expires_at sem pagamento. |
canceledstringopcional | Cancelada antes do pagamento. |
failedstringopcional | O adquirente recusou a emissão ou o pagamento. O motivo vem em failure_reason. |
refundedstringopcional | Valor devolvido ao pagador. |
charged_backstringopcional | Contestada pelo pagador. |
infractionstringopcional | Pix pago com infração aberta no MED. Ainda sem desfecho: termina em charged_back (devolvido) ou volta a paid. |
expired é derivado de expires_at no momento da leitura: uma cobrança pendente cuja data já passou é devolvida como expirada, sem depender de rotina de varredura.
Campos da resposta
charge
iduuidopcional | Identificador da cobrança. |
amountinteiroopcional | Valor em centavos. |
methodstringopcional | Meio de pagamento: pix na v1. |
referencestring | nullopcional | O identificador que você enviou. |
customerobjeto | nullopcional | Nome, e-mail e documento do pagador. |
pix.br_codestring | nullopcional | Copia e cola do Pix. |
pix.end_to_end_idstring | nullopcional | Identificador da liquidação, preenchido após o pagamento. |
receiverobjeto | nullopcional | Dados da conta que recebeu: nome, documento, chave Pix, instituição, ISPB, agência e conta. null quando o adquirente não informa, e cada campo interno pode vir null. |
expires_atISO 8601 | nullopcional | Quando a cobrança deixa de aceitar pagamento. |
paid_atISO 8601 | nullopcional | Quando o pagamento foi confirmado. |
failure_reasonstring | nullopcional | Por que a emissão falhou, quando o status é failed. null nos demais casos. |
created_atISO 8601opcional | Quando a cobrança foi criada. |
Não encontrado
Cobranças criadas pelo checkout não são visíveis por aqui: a API pública enxerga apenas o que ela mesma criou. Consultar o id de uma delas devolve 404 com CHARGE_NOT_FOUND, o mesmo retorno de um id de outra conta.