Dispatch a Boleto Charge batch
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
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
Headers
Optional client-generated idempotency token (recommended for safe retries).
Response
Idempotent repeat; the batch had already been dispatched
Optional operator-facing name; empty when omitted.
Batch lifecycle. Only DRAFT is editable. COMPLETED,
PARTIAL_FAILED, and FAILED are terminal for issuance attempts;
individual boleto registration and payment continue afterwards.
Last persisted batch/statistics update, in UTC.