List Boleto Charge batches

GET

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

GET

/v1/accounts/:accountId/boleto/charge/batches

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

{
  "items": [
    {
      "batchId": "bcb_01J8Y7C8D9E0F1G2H3J4",
      "name": "Cobranças de setembro",
      "status": "PARTIAL_FAILED",
      "totalItems": 3,
      "quotaReserved": 3,
      "statistics": {
        "generation": {
          "total": 3,
          "pending": 0,
          "processing": 0,
          "issued": 2,
          "failed": 1,
          "progressPercentage": 100
        },
        "payment": {
          "issued": 2,
          "paid": 1,
          "unpaid": 1,
          "overdue": 0,
          "paidAmount": 150.75,
          "conversionRate": 50
        }
      },
      "createdAt": "2026-09-24T14:08:12Z",
      "updatedAt": "2026-09-24T14:12:40Z",
      "dispatchedAt": "2026-09-24T14:10:00Z",
      "completedAt": "2026-09-24T14:12:40Z"
    }
  ],
  "page": 1,
  "pageSize": 50,
  "totalItems": 1,
  "totalPages": 1,
  "hasNext": false
}

Lists this account's batches from the local mirror, newest first. Summary statistics reflect the current issuance and payment state.

Authentication

AuthorizationBearer

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

Path parameters

accountIdstringRequired

Account identifier.

Query parameters

pageintegerOptional>=1Defaults to 1

Page number, starting at 1.

pageSizeintegerOptional1-200Defaults to 50

Number of batches per page.

Response

Page of batch summaries

itemslist of objects

Batches in this page.

pageinteger

Current page.

pageSizeinteger

Requested page size.

totalItemsinteger

Total matching batches.

totalPagesinteger

Number of pages.

hasNextboolean

Whether another page exists.

Errors

403

Forbidden Error

Authentication

Path parameters

Headers

Query parameters

Response

Errors