Solicitar saque PIX

Solicita um saque do saldo disponível para uma chave PIX brasileira.

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 pelo único endereço IP cadastrado para a empresa. Requisições originadas de qualquer outro IP recebem 403 Forbidden.Cadastrar IP permitido

A alteração do IP permitido tem efeito imediato e invalida o endereço anterior.

Corpo da requisição

Envie os campos abaixo com Content-Type: application/json.

Tipos aceitos: CPF, CNPJ, EMAIL, PHONE e EVP. A empresa deve possuir saldo disponível e saque habilitado.

{"companyId":"com_01J...","amount":5000.00,"currency":"BRL","pixKey":"financeiro@empresa.com","pixKeyType":"EMAIL","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 '{"companyId":"com_01J...","amount":5000.00,"currency":"BRL","pixKey":"financeiro@empresa.com","pixKeyType":"EMAIL","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"}}