Skip to main content
POST
Create a withdrawal

Authorizations

Authorization
string
header
required

YuvexPay API key. Include as Authorization: Bearer ypk_<env>_<kid>_<secret> where <env> is test (sandbox) or live (production). Create and manage keys in the dashboard under Settings > API Keys.

Headers

X-Idempotency-Key
string
required

A unique string to ensure the request is processed only once. Must be unique per request. Valid for 24 hours.

Maximum string length: 100

Body

application/json
amount
number
required

Withdrawal amount (minimum R$10.00).

Required range: 10 <= x <= 1000000Must be a multiple of 0.01
destination
PIX destination · object
required

Where to send the funds.

method
enum<string>
default:PIX

Public withdrawals currently support PIX only.

Available options:
PIX
currency
enum<string>
default:BRL
Available options:
BRL
description
string

Internal description for this withdrawal.

Maximum string length: 500

Response

Withdrawal created.

withdrawal
object