Stater Platform

Listar cobranças Pix

GET /accounts/:accountId/charges — paginação por cursor com filtros por status e variant.

Listar cobranças Pix

Lista as cobranças da conta em ordem decrescente de criação. Suporta paginação por cursor e filtros por status e/ou variant, aceitando valor único ou lista separada por vírgula em cada filtro.

GET/accounts/:accountId/charges

Paginação é por cursor (não por page) — repasse nextCursor pra próxima chamada e pare quando voltar null. O cursor corresponde ao id do último item da página anterior, então a próxima chamada retorna os itens criados antes dele. Os filtros status e variant aceitam lista separada por vírgula no mesmo parâmetro (codifique como %2C na URL) — combine ambos pra views como "cobranças cobv ou debtor que foram pagas ou expiraram". Itens da listagem não trazem imageBase64 nem todos os campos do GET singular (debtor*, fine*, payer*Document/Institution, refundedAmountCents) — chame GET /charges/:chargeId pra detalhes completos. Ordenação é decrescente por createdAt.

Path params

  • accountIdObrigatório
    string (UUID)
    ID da conta recebedora das cobranças.

Query string

  • limit
    number
    Quantidade máxima de itens por página.
  • cursor
    string
    Cursor de paginação. Passe o nextCursor retornado na resposta anterior pra pegar a próxima página.
  • status
    "PENDING" | "PAID" | "EXPIRED" | "REFUNDED"
    Filtra por status. Aceita valor único (ex.: status=PAID) ou lista separada por vírgula (ex.: status=EXPIRED,PAID — codifique a vírgula como %2C na URL).
  • variant
    "simple" | "debtor" | "cobv"
    Filtra por variante. Aceita valor único (ex.: variant=cobv) ou lista separada por vírgula (ex.: variant=cobv,debtor).

Headers

  • AcceptObrigatório
    string
    application/json
  • AuthorizationObrigatório
    string
    Bearer <token> — JWT de /authenticate.
  • X-Tenant-IdObrigatório
    string (UUID)
    Identificador do tenant.

Exemplo de requisição

curl -X GET "https://baas.staterpay.io/accounts/00000000-0000-0000-0000-000000000010/charges?limit=20" \  -H "Accept: application/json" \  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.<payload>.<signature>" \  -H "X-Tenant-Id: 00000000-0000-0000-0000-000000000000"

Resposta

  • charges
    array
    Cobranças da página atual.
  • charges[].id
    string (cuid)
    ID da cobrança.
  • charges[].pixAccountId
    string (cuid)
    ID interno da conta Pix subjacente.
  • charges[].variant
    "simple" | "debtor" | "cobv"
    Tipo da cobrança.
  • charges[].status
    "PENDING" | "PAID" | "EXPIRED" | "REFUNDED"
    Estado atual.
  • charges[].amountCents
    string
    Valor em centavos.
  • charges[].txid
    string
    Identificador BCB embutido no brCode (32 hex).
  • charges[].providerQrId
    string
    ID da cobrança no provider Pix subjacente.
  • charges[].brCode
    string
    Payload Pix Copia e Cola.
  • charges[].imageUrl
    string
    URL pública do PNG do QR Code (imageBase64 não vem aqui — busque por GET /charges/:chargeId se precisar).
  • charges[].expiresAt
    string (ISO 8601)
    Quando a cobrança expira/expirou.
  • charges[].dueDate
    string (ISO 8601) | null
    Data de vencimento. null fora de variant=cobv.
  • charges[].tag
    string | null
    Identificador livre enviado na criação.
  • charges[].endToEndId
    string | null
    EndToEndId da liquidação. Preenchido após status=PAID.
  • charges[].paidAt
    string (ISO 8601) | null
    Quando a cobrança foi paga.
  • charges[].payerName
    string | null
    Nome do pagador real. Preenchido após status=PAID.
  • charges[].refundEndToEndId
    string | null
    EndToEndId do estorno. Preenchido após status=REFUNDED.
  • charges[].refundedAt
    string (ISO 8601) | null
    Quando o estorno foi liquidado.
  • charges[].failureReason
    string | null
    Motivo de falha, quando aplicável.
  • charges[].createdAt
    string (ISO 8601)
    Quando a cobrança foi criada.
  • nextCursor
    string | null
    Cursor da próxima página. null indica fim da listagem.
json
{  "charges": [    {      "id": "cmoxample0004qkxyzcharge",      "pixAccountId": "cmoxample0050qkxyzpixacct",      "variant": "cobv",      "status": "PENDING",      "amountCents": "1000",      "txid": "00000000000000000000000000000000",      "providerQrId": "00000000",      "brCode": "00020101021226930014br.gov.bcb.pix2571qrcode.staterpay.com.br/v2/qr/cobv/00000000-0000-0000-0000-0000000000005204000053039865802BR5912FULANO DE TAL6009SAO PAULO61080408000062070503***6304XXXX",      "imageUrl": "https://api.staterpay.com.br/v2/finance/image/qrcode/00000000000000000000000000000000.png",      "expiresAt": "2026-05-19T12:00:00.000-03:00",      "dueDate": "2026-05-18T12:00:00.000-03:00",      "tag": "Pedido 123",      "endToEndId": null,      "paidAt": null,      "payerName": null,      "refundEndToEndId": null,      "refundedAt": null,      "failureReason": null,      "createdAt": "2026-05-14T08:04:52.901-03:00"    },    {      "id": "cmoxample0005qkxyzcharge",      "pixAccountId": "cmoxample0050qkxyzpixacct",      "variant": "debtor",      "status": "EXPIRED",      "amountCents": "1000",      "txid": "00000000000000000000000000000001",      "providerQrId": "00000001",      "brCode": "00020101021226920014br.gov.bcb.pix2570qrcode.staterpay.com.br/v2/qr/cob/00000000-0000-0000-0000-0000000000015204000053039865802BR5912FULANO DE TAL6009SAO PAULO62070503***6304XXXX",      "imageUrl": "https://api.staterpay.com.br/v2/finance/image/qrcode/00000000000000000000000000000001.png",      "expiresAt": "2026-05-14T08:18:13.885-03:00",      "dueDate": null,      "tag": "Pedido 123",      "endToEndId": null,      "paidAt": null,      "payerName": null,      "refundEndToEndId": null,      "refundedAt": null,      "failureReason": null,      "createdAt": "2026-05-14T08:03:14.735-03:00"    },    {      "id": "cmoxample0006qkxyzcharge",      "pixAccountId": "cmoxample0050qkxyzpixacct",      "variant": "simple",      "status": "PAID",      "amountCents": "100",      "txid": "00000000000000000000000000000002",      "providerQrId": "00000002",      "brCode": "00020101021226920014br.gov.bcb.pix2570qrcode.staterpay.com.br/v2/qr/cob/00000000-0000-0000-0000-0000000000025204000053039865802BR5912FULANO DE TAL6009SAO PAULO62070503***6304XXXX",      "imageUrl": "https://api.staterpay.com.br/v2/finance/image/qrcode/00000000000000000000000000000002.png",      "expiresAt": "2026-05-14T08:16:28.467-03:00",      "dueDate": null,      "tag": "Pedido 123",      "endToEndId": "E12345678202605141113s0723e380ed",      "paidAt": "2026-05-14T08:13:47.795-03:00",      "payerName": "Fulano de Tal",      "refundEndToEndId": null,      "refundedAt": null,      "failureReason": null,      "createdAt": "2026-05-14T08:01:29.297-03:00"    }  ],  "nextCursor": null}
URL base:https://baas.staterpay.io

Consultar cobrança Pix

GET /accounts/:accountId/charges/:chargeId — estado atualizado e dados do pagador após liquidação.

Alterar senha

PUT /passwords/change-password — troca a senha da entidade autenticada.

On this page

Path paramsQuery stringHeadersExemplo de requisiçãoResposta