Withdrawals
Create a withdrawal
Create a PIX withdrawal to transfer BRL funds from your YuvexPay balance. Requires an idempotency key.
The PIX key type (CPF, CNPJ, e-mail, phone, or random key) is detected automatically from destination.pixKey — you do not need to declare it. Invalid keys are rejected with INVALID_PIX_KEY.
The creditor document on the network is always derived server-side from your verified company tax id (CNPJ for business accounts, owner CPF for individual accounts).
Withdrawals may be blocked outside business hours or if your account has restrictions.
post/v1/withdrawals
Headers
X-Idempotency-Keystring required
A unique string to ensure the request is processed only once. Must be unique per request. Valid for 24 hours.
Request body
Response
Withdrawal created.