Solicitar saque PIX
Solicita um saque do saldo disponível para uma chave PIX brasileira ou para um código PIX copia e cola.
Endpoint
Esta operação usa autenticação por
x-api-key e retorna JSON.| Método | Endpoint |
|---|---|
POST | /api/v2/withdrawals/pix |
IP permitido obrigatório
Saques por API só podem ser solicitados por um dos até três endereços IP cadastrados para a empresa. Requisições originadas de qualquer outro IP recebem
403 Forbidden.Gerenciar IPs permitidos A lista aceita IPv4 e IPv6, vale em produção e sandbox e entra em vigor imediatamente.
Ciclo, prazo e conciliação
Empresas Em conformidade seguem para
PROCESSING. Empresas Em risco recebem COMPLIANCE_REVIEW até a decisão da LeonaPay. Uma operação em processamento é consultada por até três horas. Confirmação da liquidante produz COMPLETED; falha conclusiva produz FAILED e devolve a reserva. Se a liquidante estiver indisponível ou responder de forma ambígua, a operação aparece como OUTCOME_UNKNOWN (Em conciliação) e o valor permanece bloqueado para evitar crédito duplicado.Reutilize a mesma idempotency-key em qualquer retentativa. Não crie um segundo saque enquanto a primeira operação estiver Em conciliação.
Corpo da requisição
Envie os campos abaixo com
Content-Type: application/json.Para chave, use destination.pixKey e destination.pixKeyType (CPF, CNPJ, EMAIL, PHONE ou EVP). Para QR, use type PIX_QR_CODE e qrCode; o código é validado e pré-visualizado antes da reserva. Uma empresa Em conformidade entra em PROCESSING; uma empresa Em risco entra em COMPLIANCE_REVIEW e aguarda aprovação manual da LeonaPay.
{"amount":5000.00,"currency":"BRL","destination":{"type":"PIX_QR_CODE","qrCode":"000201..."},"reference":"saque-2026-08-20"}Exemplo de requisição
Use uma chave de idempotência única em operações POST.
curl --request POST \
--url 'https://api.leonapay.com.br/api/v2/withdrawals/pix' \
--header 'Accept: application/json' \
--header 'x-api-key: {your_api_key}' \
--header 'Content-Type: application/json' \
--header 'idempotency-key: {uuid}' \
--data '{"amount":5000.00,"currency":"BRL","destination":{"type":"PIX_QR_CODE","qrCode":"000201..."},"reference":"saque-2026-08-20"}'Resposta
Uma operação aceita retorna o envelope padrão da API LeonaPay.
{"success":true,"data":{"id":"wd_01J...","rail":"PIX","status":"PROCESSING","amount":5000.00,"currency":"BRL","pixKeyType":"EMAIL","createdAt":"2026-08-20T14:00:00Z"}}