Cash-out
Send PIX from your balance to any key, protected against duplicate sending.
POST /api/v1/gateway/pix-payment debits the amount and fee from your balance and sends a PIX to the given key. The response is immediate (status: "processing"); the result arrives at callbackUrl.
Before the first payout, turn on API payouts under Developers in the dashboard. Unless WeetPay enables it, the destination must be the account holder's own CPF/CNPJ key. See Limits and rules.
Key types
typeKey | key | document |
|---|---|---|
CPF | 11 digits | the same CPF as the key |
CNPJ | 14 digits | the same CNPJ as the key |
EMAIL | key holder's CPF/CNPJ | |
PHONE | mobile with area code (e.g. 11999998888 or +5511999998888) | key holder's CPF/CNPJ |
EVP | random key (UUID) | key holder's CPF/CNPJ |
Flow
- Generate and store an
Idempotency-Keyfor the payment (Idempotency). - Call Send PIX. On network errors or
5xx, retry with the same key. - The payout stays
PROCESSING(operations review, when applicable, and bank submission). callbackUrlreceivesstatus: "sucess"with theendToEnd, orstatus: "not paid"with the reason inmessage— in which case amount and fee return to the balance.
Payout status
processingStatus (lookup) | Callback status | Meaning |
|---|---|---|
PROCESSING | — | under review or sent to the bank |
PAID_OUT | sucess | paid |
NOT_PAID | not paid | rejected or failed; refunded |