Review a PIX batch before dispatch
Starts the asynchronous pre-flight and moves the batch to REVIEWING.
Per item: amount, identifier not already used by a live payment on
the account (identifier_conflict), per-transaction cashout limit
(limit_exceeded_transaction) and, for key payments, a DICT lookup
that resolves the receiver (key_not_found, key_inactive,
invalid_pix_key, dict_lookup_failed). Bank-account payments are
kept as sent. DICT lookups made here count toward the account’s DICT
windows.
When done the batch is REVIEWED and review carries the summary:
counts, totalAmount/validAmount, available balance and the
daily/nightly/monthly limits with sufficient flags and
warnings[]. Items flagged INVALID block dispatch; export them with
GET .../items/export?status=invalid, fix or delete, and review again.
Calling review on a REVIEWING batch returns 202 with the current
state.
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
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.
Response
Review started (or already running)
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).