Create A Pix Withdrawal
Initiates a BRL withdrawal via PIX for the authenticated user.
The gateway_data.pix_key field must be a valid PIX key (CPF, CNPJ, email, phone, or random key).
Whitelisted contacts only: The destination PIX key must be a previously whitelisted contact of the user. Use POST /contacts/ to create and whitelist a banking contact before calling this endpoint.
Own account exception: If the destination PIX key is registered as one of the authenticated user’s own PIX keys, whitelisting is not required.
Country restriction: Only available for accounts with country = BR.
Authorization
- Requires a valid API key.
Headers
The API key as a string.
See the Generating Signature section for more details.
A timestamp in milliseconds. See the Timestamp Security section for more details.
An additional, non-required parameter, that you can send to specify the number of milliseconds after the timestamp for the request to be valid. See the Timestamp Security section for more details.
Body
Withdrawal amount as a decimal string. Must be ≥ 0.01, with up to 2 decimal places.
"150.00"
Currency to withdraw. Only BRL is accepted.
"BRL"
Gateway-specific data for the PIX withdrawal.
Optional field to indicate funds come from wallet or ripio trade (default is wallet)
"trade"
Response
PIX withdrawal transaction created successfully.
null
null
Transaction object returned by the transactions list, detail and creation endpoints (GET /transactions/, GET /transactions/{id}/, and the 201 responses of every /transactions/{rail}/{action}/ endpoint). All three surfaces share this exact shape.