Cobranças

Listar cobranças

GET/v1/chargescharges:readNOVO

Cobranças da conta com filtros por estado, external_id e período.

Cabeçalhos

Authorizationstringobrigatório

Bearer seguido da sua chave: gw_test_ em teste, gw_live_ em produção.

Parâmetros de consulta

limitinteger · 1–100opcional

cursorstring · 1–512opcional

Cursor opaco devolvido pela página anterior.

statusstringopcional

CREATINGPENDINGPAIDFAILEDCANCELEDEXPIREDUNDER_REVIEWREVERSED

external_idstring · 1–128opcional

created_fromdatetimeopcional

Criados a partir deste instante (inclusive).

created_todatetimeopcional

Criados antes deste instante.

Resposta 200

Página, mais novos primeiro

dataobject[]

21 campos

iduuid

external_idstring

method

PIX ou CARD (checkout no cartão).

PIXCARD

statusstring

CREATINGPENDINGPAIDFAILEDCANCELEDEXPIREDUNDER_REVIEWREVERSED

amount_centsinteger

Valor inteiro em centavos.

fee_centsinteger

Valor inteiro em centavos.

net_amount_centsinteger

Valor inteiro em centavos.

pixPixArtifact | null

3 campos

copy_pastestring

qr_code_urlurl | null

qr_code_base64string | null

cardobject | nullNOVO

Só em cobranças CARD. O link do checkout aparece enquanto a cobrança está PENDING. O valor pago fica a liberar até a liberação da venda no cartão.

2 campos

checkout_urlurl | null

checkout_expires_atdatetime | null

expires_atdatetime | null

paid_atdatetime | null

created_atdatetime

updated_atdatetime

settlementobject

3 campos

modestring | null

D0D1

sourcestring | null

GLOBALMERCHANTLEGACY

withdrawable_atdatetime | null

descriptionstring | nullNOVO

metadataobject · até 20 chavesNOVO

Pares chave-valor seus, até 20 chaves e 2 KB. Gravados uma vez na criação e devolvidos em toda consulta e webhook. Não guarde dados pessoais aqui.

product_iduuid | nullNOVO

Produto do catálogo que esta cobrança vendeu, quando criada a partir de um.

payerobject | nullNOVO

Quem você informou que pagaria, com o documento mascarado.

2 campos

namestring | null

document_maskedstring | null

Ex.: ***.456.789-**

paid_byobject | nullNOVO

Quem pagou, segundo o banco. Pode ser diferente de payer. null até o pagamento.

3 campos

namestring | null

document_maskedstring | null

Ex.: ***.456.789-**

bankstring | null

end_to_end_idstring | nullNOVO

ID fim a fim do Pix no Banco Central. null até o pagamento.

reversed_atdatetime | nullNOVO

next_cursorstring | null

Códigos de resposta

HTTP	Quando acontece
200	Página, mais novos primeiro
400	Requisição ou cursor inválido
401	Chave ausente, inválida ou sem o escopo exigido
429	Limite de requisições excedido

Cada código de erro está explicado em Erros.

Requisição

curl -X GET "https://api.mainumpay.com/v1/charges?status=PAID&limit=20" \
  -H "Authorization: Bearer $MAINUM_API_KEY"

Resposta

{
  "data": [
    {
      "id": "0192a7c4-5b1e-7d3a-9f10-6c2e8b4d1a77",
      "external_id": "pedido-48213",
      "method": "PIX",
      "status": "PAID",
      "amount_cents": 4990,
      "fee_cents": 149,
      "net_amount_cents": 4841,
      "description": "Plano Pro mensal",
      "metadata": {
        "pedido": "48213",
        "canal": "loja"
      },
      "payer": {
        "name": "Ana Souza",
        "document_masked": "***.982.247-**"
      },
      "paid_by": {
        "name": "ANA P SOUZA",
        "document_masked": "***.982.247-**",
        "bank": "Nu Pagamentos S.A."
      },
      "end_to_end_id": "E18236120202609241535s04b9c2e7d1f",
      "expires_at": "2026-09-24T15:02:11.000Z",
      "paid_at": "2026-09-24T14:35:48.000Z",
      "reversed_at": null,
      "created_at": "2026-09-24T14:32:11.000Z",
      "updated_at": "2026-09-24T14:35:49.000Z",
      "settlement": {
        "mode": "D0",
        "source": "MERCHANT",
        "withdrawable_at": "2026-09-24T14:35:48.000Z"
      },
      "pix": null,
      "card": null,
      "product_id": null
    }
  ],
  "next_cursor": null,
  "request_id": "req_0192a7c4-5b20-7c11-8e4f-2b9d0c6a3e58"
}

Página, mais novos primeiro