API Reference
Listar cobranças
GET /v1/charges com paginação por cursor.
Lista cobranças
Paginação por cursor (cuid da última cobrança). Mais recentes primeiro. Use os filtros para restringir por status, variante ou janela de criação.
GET/v1/charges
A listagem retorna campos resumidos (sem imageBase64 e sem depositSnapshot). Para detalhes completos da cobrança, use GET /v1/charges/:id.
Query string
- status"PENDING" | "PAID" | "EXPIRED" | "REFUNDED"Filtra por estado.
- variant"simple" | "debtor" | "cobv"Filtra por variante.
- fromstring (YYYY-MM-DD)Início do intervalo de criação.
- tostring (YYYY-MM-DD)Fim do intervalo.
- cursorstringCursor para próxima página (use o nextCursor da resposta anterior).
- limitnumberPadrão 20, máximo 100.
Headers
- AuthorizationObrigatóriostringBearer SUA_API_KEY
Exemplo de requisição
curl https://api.staterpay.io/v1/charges \ -H "Authorization: Bearer SUA_API_KEY"Resposta
- chargesarrayLista de cobranças nessa página.
- nextCursorstring | nullCursor para a próxima página. null quando não há mais resultados.
json
{ "charges": [ { "id": "cmoxample0001qkxyzcharge", "pixAccountId": "cmoxample0001qkxyzaccount", "variant": "cobv", "status": "PENDING", "amountCents": "10000", "txid": "837efc90cc554a42ab779c15f0f40092", "providerQrId": "0000000000", "brCode": "00020101021226920014br.gov.bcb.pix2570qrcode.staterpay.com.br/v2/qr/cob/837efc90-cc55-4a42-ab77-9c15f0f400925204000053039865802BR5921NOME EMPRESA LTDA6009SAO PAULO62070503***630459A8", "imageUrl": "https://api.staterpay.com.br/v2/finance/image/qrcode/837efc90cc554a42ab779c15f0f40092.png", "expiresAt": "2026-05-09T21:00:00.000-03:00", "dueDate": null, "tag": "Mensalidade Maio/2026", "endToEndId": null, "paidAt": null, "payerName": null, "payerDocument": null, "payerInstitution": null, "payerInstitutionIspb": null, "refundEndToEndId": null, "refundedAt": null, "failureReason": null, "createdAt": "2026-05-07T18:35:37.165-03:00" } ], "nextCursor": "cmoxample0001qkxyzcharge"}URL base:
https://api.staterpay.io