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).
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.