Get a Boleto Charge batch and paginated items

GET

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

GET

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

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

{
  "batchId": "bcb_01J8Y7C8D9E0F1G2H3J4",
  "name": "Cobranças de setembro",
  "status": "PARTIAL_FAILED",
  "totalItems": 2,
  "quotaReserved": 2,
  "statistics": {
    "generation": {
      "total": 2,
      "pending": 0,
      "processing": 0,
      "issued": 1,
      "failed": 1,
      "progressPercentage": 100
    },
    "payment": {
      "issued": 1,
      "paid": 0,
      "unpaid": 1,
      "overdue": 0,
      "paidAmount": 0,
      "conversionRate": 0
    }
  },
  "createdAt": "2026-09-24T14:08:12Z",
  "updatedAt": "2026-09-24T14:12:40Z",
  "items": [
    {
      "itemId": "bci_01J8Y8H9J0K1L2M3N4P5",
      "position": 1,
      "identifier": "pedido-1001",
      "status": "ISSUED",
      "request": {
        "identifier": "pedido-1001",
        "dueDate": "2026-10-23",
        "amount": {
          "nominal": 150.75,
          "currency": "BRL"
        },
        "payer": {
          "name": "Maria da Silva",
          "personType": "person",
          "taxNumber": "52998224725"
        }
      },
      "createdAt": "2026-09-24T14:09:00Z",
      "updatedAt": "2026-09-24T14:11:00Z",
      "charge": {
        "chargeId": "8c1f6a2e-4d3b-4b9a-9f0e-1a2b3c4d5e6f",
        "identifier": "pedido-1001",
        "status": "OPEN",
        "registrationCondition": "PENDING",
        "barcode": "23793381286000782713695000063305975520000015075",
        "digitableLine": "23793381286000782713695000063305975520000015075",
        "ourNumber": "123456789",
        "amount": {
          "nominal": 150.75,
          "updatedAmount": 150.75,
          "currency": "BRL"
        },
        "updatedAt": "2026-09-24T14:11:00Z"
      }
    }
  ],
  "page": 1,
  "pageSize": 50,
  "totalPages": 1,
  "hasNext": false,
  "dispatchedAt": "2026-09-24T14:10:00Z",
  "completedAt": "2026-09-24T14:12:40Z"
}

Returns one batch, its current generation/payment statistics, and one page of item results. Batch completion means every issuance attempt finished; registration, payment, overdue and expiry continue on each individual boleto and update the payment statistics afterwards.

Authentication

AuthorizationBearer

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

Path parameters

accountIdstringRequired

Account identifier.

batchIdstringRequired

Boleto Charge batch identifier returned by the create endpoint.

Query parameters

pageintegerOptional>=1Defaults to 1

Item page number, starting at 1.

pageSizeintegerOptional1-200Defaults to 50

Number of batch items per page.

Response

Batch and paginated item results

batchIdstring

Batch identifier.

namestring

Optional operator-facing name; empty when omitted.

statusenum

Batch lifecycle. Only DRAFT is editable. COMPLETED, PARTIAL_FAILED, and FAILED are terminal for issuance attempts; individual boleto registration and payment continue afterwards.

totalItemsinteger0-5000

Number of staged items.

quotaReservedinteger0-5000

Slots permanently reserved when dispatch was admitted.

statisticsobject

Current generation progress and payment conversion.

createdAtdatetime

Draft creation instant, in UTC.

updatedAtdatetime

Last persisted batch/statistics update, in UTC.

itemslist of objects

Current page of staged items and issuance results.

pageinteger

Current item page.

pageSizeinteger

Requested item page size.

totalPagesinteger

Number of item pages.

hasNextboolean

Whether another item page exists.

dispatchedAtdatetime or nullOptional

Instant quota was reserved and the batch was queued.

completedAtdatetime or nullOptional

Instant every issuance attempt reached an outcome.

Errors

403

Forbidden Error

404

Not Found Error

Authentication

Path parameters

Headers

Query parameters

Response

Errors