Dispatch a reviewed PIX batch
Queues a REVIEWED batch with no invalid items. The body must carry
acknowledged: true — the caller’s statement that the review summary
(amounts, balance and limits) was read. The available balance is
re-checked at dispatch time (422 pix_batch_insufficient_balance
starts nothing).
Processing is asynchronous: each item becomes its own PIX out
(identifier = item identifier, idempotency {batchId}_{itemId})
and goes through the same limits, policies and pix.out.* webhooks
as a single transfer. Batch status becomes COMPLETED,
PARTIAL_FAILED or FAILED and pix.batch.completed is delivered.
A repeated dispatch of an already dispatched batch is idempotent
(200).
This is a cashout route: account cashout locks and the transaction
PIN / acting-document headers apply exactly as in POST /pix/out.
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
PIX batch identifier (pxb_…) returned by the create endpoint.
Headers
Transaction PIN of the operator in X-Acting-Document. Required on cashout routes when the credential enforces a PIN (428 pin_required).
Real IP of the end user, for integrator credentials calling on their behalf. This is the IP evaluated against cashoutSourceIps — without it the check would see your server's IP. Ignored for delegated credentials, where the connection IP is already the right one.
Optional client-generated idempotency token (recommended for safe retries).
Request
Must be true; confirms the review summary was read.
Response
Idempotent repeat; the batch had already been dispatched
Batch identifier (pxb_…).
Optional operator-facing name; empty when omitted.
Batch lifecycle. DRAFT and REVIEWED are editable (editing a
REVIEWED batch returns it to DRAFT). REVIEWING is the asynchronous
pre-flight. Dispatch requires REVIEWED. COMPLETED, PARTIAL_FAILED
and FAILED are terminal and the only states with receipts.
Amount in BRL as a decimal string with two places (1234.56).
Summary written when the review finishes (or aborts).