O saque sai da carteira da conta XXXPay e segue para a chave PIX informada. O status inicial mais comum é PROCESSING, com confirmação posterior via callback.
O valor mínimo para saque na XXXPay é R$ 10,00. A validação acontece antes da requisição seguir para o canal financeiro.
| Campo | Obrigatorio | Descricao |
|---|---|---|
| amount | Sim | Valor do saque. Exemplo: 100.00. |
| external_id | Sim | Identificador unico do saque no sistema do seller. |
| pix_key | Sim | Chave PIX de destino. |
| key_type | Sim | EMAIL, CPF, CNPJ, PHONE ou EVP. |
| clientCallbackUrl | Sim | URL HTTPS para receber atualizacoes do saque. |
| description | Nao | Descricao operacional do saque. |
curl --request POST 'https://api.xxxpay.online/api/withdrawals/withdraw' \
--header 'Authorization: Bearer SEU_TOKEN' \
--header 'Content-Type: application/json' \
--data '{
"amount": 10.00,
"external_id": "withdraw-1001",
"pix_key": "financeiro@seller.com",
"key_type": "EMAIL",
"description": "Repasse seller 1001",
"clientCallbackUrl": "https://seller.exemplo.com/webhooks/xxxpay/withdrawal"
}'
{
"message": "Saque processado com sucesso.",
"transactionId": "wdr-0a1b2c3d4e",
"withdrawal": {
"transaction_id": "wdr-0a1b2c3d4e",
"external_id": "withdraw-1001",
"status": "PROCESSING",
"amount": 10,
"fee": 0.5,
"total": 10.5,
"type": "Withdrawal"
}
}