Dispatch a Boleto Charge batch

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

Atomically reserves quota for every item and moves a non-empty DRAFT batch to QUEUED. Processing is asynchronous.

Dispatch starts only when all items fit both the tenant and account remaining quota. Otherwise it returns 429 boleto_charge_monthly_limit_exceeded, reserves nothing, starts no issuance, and leaves the batch DRAFT. Once admitted, every slot is consumed permanently, including items that later fail at the settlement bank.

Subscribe to boleto.charge.batch.completed for the terminal batch state. Continue to use individual boleto events for registration and payment lifecycle.

Atomically reserves quota for every item and moves a non-empty `DRAFT` batch to `QUEUED`. Processing is asynchronous. Dispatch starts only when **all** items fit both the tenant and account remaining quota. Otherwise it returns `429 boleto_charge_monthly_limit_exceeded`, reserves nothing, starts no issuance, and leaves the batch `DRAFT`. Once admitted, every slot is consumed permanently, including items that later fail at the settlement bank. Subscribe to `boleto.charge.batch.completed` for the terminal batch state. Continue to use individual boleto events for registration and payment lifecycle.

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.

Response

Idempotent repeat; the batch had already been dispatched

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

409

Conflict Error

422

Unprocessable Entity Error

429

Too Many Requests Error

502

Bad Gateway Error

503

Service Unavailable Error

Authentication

Path parameters

Headers

Response

Errors