Solicita um novo saque. O body varia de acordo com o tipo (PIXPIX ou TED).
/v1/withdrawalsbasicAuth Autenticação via chave de API. Use publicKey:secretKey codificado em Base64 no header Authorization: Basic {credentials}.
In: header
Chave de idempotência fornecida pelo cliente. Garante que retentativas da mesma requisição (timeout, proxy instável, reenvio) não criem operações duplicadas: a primeira requisição é processada e as repetições com a mesma chave retornam o mesmo resultado. Use um valor único por operação (ex.: um UUID). Se omitida, a API deriva uma chave a partir do contexto de negócio.
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
application/json
curl -X POST "https://example.com/v1/withdrawals" \ -H "Content-Type: application/json" \ -d '{ "type": "pix", "wallet_id": "d9a8fbfc-848f-43a2-9168-911ed3a04a48", "amount": 1, "idempotency_key": "string", "pix_key": "string", "pix_key_type": "cpf" }'{
"success": true,
"message": "string",
"data": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"merchant_id": "500924a8-3f5e-4c00-beb8-2efcde988aea",
"submerchant_id": "0534fe1e-3158-45a7-83b1-35fcc9d94bc5",
"wallet_id": "d9a8fbfc-848f-43a2-9168-911ed3a04a48",
"acquirer_name": "string",
"external_id": "string",
"amount": 0,
"fee": 0,
"netAmount": 0,
"status": "pending",
"recipient_id": "string",
"recipient_snapshot": {},
"failure_reason": "string",
"processed_at": "2019-08-24T14:15:22Z",
"completed_at": "2019-08-24T14:15:22Z",
"failed_at": "2019-08-24T14:15:22Z",
"metadata": {},
"idempotency_key": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}{
"success": false,
"message": "string",
"error": "string"
}{
"success": false,
"message": "string",
"error": "string"
}ID da carteira
Valor em centavos
Chave de idempotência
ID do submerchant (opcional, para saques em nome de um submerchant)
Chave PIX
Tipo da chave PIX
PIN de transação (4 dígitos). Obrigatório quando o merchant tem PIN habilitado
Tipo do documento do titular da chave PIX. Obrigatório via API quando a chave PIX é do tipo email, phone ou random
Número do documento do titular (CPF ou CNPJ, apenas dígitos). Obrigatório via API quando a chave PIX é do tipo email, phone ou random