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.

CampoTipoDescrição
idstringId do pagamento.
statusstringStatus atual. Veja os status.
amount_centsintegerValor cobrado, em centavos.
fee_centsintegerTaxa da plataforma, em centavos.
net_centsintegerValor que entra no seu saldo.
pixobject | nullDados do Pix. null quando o pagamento não pode mais ser pago.
pix.copy_pastestringCódigo Pix copia e cola.
pix.qr_svgstringQR Code do mesmo código, como imagem SVG. Vem quando pix vem.
expires_atstring (ISO 8601) | nullAté quando o Pix pode ser pago.
paid_atstring (ISO 8601) | nullQuando o pagamento foi confirmado.
paid_latebooleantrue quando o pagamento chegou depois de expires_at.
external_idstring | nullO id do pedido que você enviou.
descriptionstring | nullA descrição do Pix.
customerobject | nullQuem paga.
customer.namestringNome de quem paga.
customer.documentstringDocumento de quem paga, mascarado.
metadataobjectOs pares que você enviou.
payment_urlstringPágina pronta de pagamento.
created_atstring (ISO 8601)Quando o pagamento foi criado.

Erros

HTTPCódigoQuando aconteceO que fazer
404not_foundNão existe pagamento com este id na sua conta.Confira o id guardado no pedido.
429too_many_attemptsMuitas requisições com esta chave.Espere e consulte com menos frequência.