Pagamentos
Buscar um pagamento
Devolve o pagamento com o status atual. Use como reforço do webhook, com intervalo mínimo.
GET
/v1/payments/{id} Requer o escopo PAYMENT:READ
Envie o id que a criação devolveu. A resposta tem o mesmo formato da criação, com o status atual.
Resposta
A API responde 200 com o pagamento.
| Campo | Tipo | Descrição |
|---|---|---|
id | string | Id do pagamento. |
status | string | Status atual. Veja os status. |
amount_cents | integer | Valor cobrado, em centavos. |
fee_cents | integer | Taxa da plataforma, em centavos. |
net_cents | integer | Valor que entra no seu saldo. |
pix | object | null | Dados do Pix. null quando o pagamento não pode mais ser pago. |
pix.copy_paste | string | Código Pix copia e cola. |
pix.qr_svg | string | QR Code do mesmo código, como imagem SVG. Vem quando pix vem. |
expires_at | string (ISO 8601) | null | Até quando o Pix pode ser pago. |
paid_at | string (ISO 8601) | null | Quando o pagamento foi confirmado. |
paid_late | boolean | true quando o pagamento chegou depois de expires_at. |
failure_code | string | null | Só quando status é failed: por que a cobrança falhou. Veja os motivos. |
external_id | string | null | O id do pedido que você enviou. |
description | string | null | A descrição do Pix. |
customer | object | null | Quem paga. |
customer.name | string | Nome de quem paga. |
customer.document | string | Documento de quem paga, mascarado (para exibir). |
payer | object | null | Todos os dados de quem paga. Só a sua conta recebe. |
payer.name | string | Nome de quem paga. |
payer.email | string | null | E-mail de quem paga, quando existir. |
payer.document | string | CPF ou CNPJ completo de quem paga, só dígitos. Proteja esse dado (LGPD): não grave em logs. |
payer.document_type | string | cpf ou cnpj. |
metadata | object | Os pares que você enviou. |
payment_url | string | Página pronta de pagamento. |
created_at | string (ISO 8601) | Quando o pagamento foi criado. |
Erros
| HTTP | Código | Quando acontece | O que fazer |
|---|---|---|---|
| 404 | not_found | Não existe pagamento com este id na sua conta. | Confira o id guardado no pedido. |
| 429 | too_many_attempts | Muitas requisições com esta chave. | Espere e consulte com menos frequência. |