Schedule Pix outbound transfer (async queue)
Schedules a PIX transfer to be processed asynchronously and returns immediately with 202.
This endpoint is recommended for high-throughput cashout scenarios. Final success/failure is communicated by webhook and can be checked via payment lookup endpoints.
Queue model: requests are enqueued in FIFO SQS and processed with controlled throughput.
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
Headers
Client-generated idempotency token.
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.
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
Source account identifier (UUID).
Recipient’s PIX key type:
CPF- CPF (11 digits, numbers only)CNPJ- CNPJ (14 digits, numbers only)EMAIL- Email addressPHONE- Phone with country code (+5511999999999)EVP- Random key (UUID v4)
Recipient’s PIX key value.
Format depends on the provided keyType.
Transfer amount in BRL. Max 2 decimal places (e.g., 150.75 for R$150,75).
Currency code (only BRL supported).
Transfer description (visible to recipient).
Integrator-provided identifier for tracking and reconciliation. Appears in the statement when the payment is reconciled.
Additional metadata (not sent to recipient).