Pagamentos
Listar pagamentos e paginação
Lista os pagamentos da sua conta, do mais novo para o mais antigo, com filtros e paginação por cursor.
GET
/v1/payments Requer o escopo PAYMENT:READ
Use a lista para conciliar pedidos ou encontrar um pagamento pelo external_id.
Parâmetros
| Parâmetro | Descrição |
|---|---|
status | Filtra por status: pending, paid, expired, failed, canceled ou refunded. |
external_id | Filtra pelo id do pedido no seu sistema. |
q | Busca pelo início do id do pagamento, por parte do external_id ou do nome do cliente (até 60 caracteres). |
period | Só os pagamentos criados no período: today, 30d, 90d, month, year ou custom. Sem ele, a lista não tem limite de data. |
from | Com period=custom: primeiro dia, no formato AAAA-MM-DD. |
to | Com period=custom: último dia (incluído), no formato AAAA-MM-DD. |
limit | Quantos itens por página, de 1 a 100. Padrão: 20. |
cursor | O next_cursor da página anterior. |
Qualquer outro parâmetro é recusado com 400 e o código invalid_request.
Paginação
- Chame sem
cursorpara receber a primeira página. - Se a resposta tiver
next_cursor, chame de novo comcursorigual a esse valor. - Quando a resposta vier sem
next_cursor, você chegou ao fim.
O cursor é estável: pagamentos novos não fazem itens se repetirem ou sumirem entre as páginas.
Resposta
| Campo | Tipo | Descrição |
|---|---|---|
data | array | Os pagamentos desta página, no mesmo formato de Buscar um pagamento, sem pix.qr_svg. |
next_cursor | string | Cursor da próxima página. Não vem na última página. |
Erros
| HTTP | Código | Quando acontece | O que fazer |
|---|---|---|---|
| 400 | invalid_request | Parâmetro desconhecido, status, período ou cursor inválido. | Confira os parâmetros desta página. |
| 429 | too_many_attempts | Muitas requisições com esta chave. | Espere e tente de novo. |