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
CPF of the human performing the operation. Required on cashout routes when the credential enforces a transaction PIN. On a company P2P profile contact, this CPF is the holder who signs; it is not taken from the body.
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 user-agent of the end user’s browser or app, for integrator credentials calling on their behalf. Feeds risk analysis only: an invalid or oversized value is dropped and the payment still proceeds. Ignored for delegated credentials.
Optional device fingerprint or identifier from the integrator’s own system. Risk analysis only; never required and never a reason to reject the payment. Ignored for delegated credentials.
Optional session id of the end user in the integrator’s system. Risk analysis only; never required and never a reason to reject the payment. Ignored for delegated credentials.
Optional latitude,longitude in decimal degrees. Out of range or malformed values are dropped. Risk analysis only. Ignored for delegated credentials.
Optional client-generated idempotency token (recommended for safe retries).
Unix seconds. Required on the signed host; tolerance is 300s either way (403 request_timestamp_skew).
Lowercase hex SHA-256 of the body. An empty body hashes the empty string, so the header is always present. Mismatch returns 400 body_hash_mismatch.
Detached JWS (<protected>..<signature>, ES256 or PS256) over METHOD\nPATH?QUERY\nTIMESTAMP\nIDEMPOTENCY_KEY_OR_EMPTY\nX_CONTENT_SHA256.
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).