List issued boletos (Boleto Charge)

GET

https://tenant.api.corpx.com/v1/accounts/:accountId/boleto/charge

GET

/v1/accounts/:accountId/boleto/charge

curl https://tenant.api.corpx.com/v1/accounts/accountId/boleto/charge \
     -H "X-Tenant-Id: X-Tenant-Id" \
     -H "Authorization: Bearer <token>"

{
  "items": [
    {
      "chargeId": "8c1f6a2e-4d3b-4b9a-9f0e-1a2b3c4d5e6f",
      "identifier": "order-12345",
      "status": "OPEN",
      "updatedAt": "2026-09-24T14:08:12Z",
      "barcode": "23793381286000782713695000063305975520000015075",
      "digitableLine": "23793381286000782713695000063305975520000015075",
      "ourNumber": "string",
      "registrationCondition": "REGISTERED",
      "dueDate": "2026-02-20",
      "amount": {
        "nominal": 150.75,
        "updatedAmount": 150.75,
        "currency": "BRL"
      },
      "statusReason": "Pagamento pedido #12345",
      "paymentLimitDate": "2026-02-20",
      "payment": {
        "amount": 150.75,
        "settledAt": "2026-02-20T08:33:39Z"
      },
      "payer": {
        "name": "MARIA DA SILVA",
        "taxNumber": "12345678000190",
        "personType": "person"
      }
    }
  ],
  "page": 1,
  "pageSize": 50,
  "totalItems": 150,
  "totalPages": 3,
  "hasNext": true
}

Paginated local mirror for this account. Every item includes updatedAt, the instant of the last successful synchronization with the settlement bank. This endpoint does not call the bank.

There is no historical backfill. The mirror contains charges issued after v2.85.0 and older charges hydrated by a successful detail lookup. Use GET .../charge/{chargeId} when you need the current authoritative result. Filters: barcode, payer, dueDate, status, page, pageSize (max 200). Requires boleto_charge.

Paginated local mirror for this account. Every item includes `updatedAt`, the instant of the last successful synchronization with the settlement bank. This endpoint does not call the bank. There is no historical backfill. The mirror contains charges issued after v2.85.0 and older charges hydrated by a successful detail lookup. Use `GET .../charge/{chargeId}` when you need the current authoritative result. Filters: `barcode`, `payer`, `dueDate`, `status`, `page`, `pageSize` (max 200). Requires `boleto_charge`.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

accountIdstringRequired

Account identifier.

Query parameters

statusstringOptional

Canonical status filter (OPEN, SETTLED, OVERDUE, WRITTEN_OFF, CANCELLED, EXPIRED).

dueDatedateOptional

Due date, YYYY-MM-DD.

payerstringOptional

Payer name or tax number.

barcodestringOptional

Barcode of the slip.

pageintegerOptional

Page number, starting at 1.

pageSizeintegerOptional<=200

Page size, up to 200.

Response

Page of boletos

itemslist of objectsOptional

pageintegerOptional

pageSizeintegerOptional

totalItemsintegerOptional

totalPagesintegerOptional

hasNextbooleanOptional

Errors

403

Forbidden Error

Authentication

Path parameters

Headers

Query parameters

Response

Errors