Listar cobranças
GET/v1/chargesAs cobranças do ambiente da chave, da mais recente para a mais antiga. Escopo da chave: charges em read.
Parâmetros de busca
ParâmetroDescrição
limitnúmeroopcionalDe 1 a 100. Padrão: 20.cursortextoopcionalO nextCursor da página anterior. Opaco: use como veio.statustextoopcionalSó as cobranças neste status: PENDING, PROCESSING, PAID, FAILED, EXPIRED, CANCELED, DISPUTED, REFUNDED ou PARTIALLY_REFUNDED (UNDERPAID, OVERPAID e LATE_PAYMENT são de USDT, em breve).externalIdtextoopcionalA cobrança com este externalId (é único por empresa e ambiente: no máximo uma).paymentLinkIdtextoopcionalSó as cobranças geradas por este link de pagamento (plk_…).
Resposta
data.items traz as cobranças, cada uma no formato de Consultar cobrança. data.nextCursor é o cursor da próxima página, ou null quando acabou.
- Para percorrer tudo, repita a chamada com o mesmo filtro e o cursor novo até nextCursor vir null.
- Cobranças criadas durante a leitura entram no começo da lista, não no meio: o cursor continua de onde parou.
- Para acompanhar uma cobrança específica, use os webhooks ou a consulta pelo id; a lista é para conciliar e exibir.
Erros
| Código | HTTP | Quando acontece |
|---|---|---|
VALIDATION_ERROR | 422 | Parâmetro fora do permitido (limit acima de 100, status desconhecido) ou cursor inválido. |
API_KEY_SCOPE | 403 | A chave não tem read em charges. |