Criar saque
POST
/v1/withdraw/createEnvia um PIX de saída a partir do seu saldo LYNX. No modo de testes o saque é simulado; em produção passa por todas as validações de saldo e limites da sua conta.
Permissão necessária: WITHDRAW:CREATE
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
amountCentsobrig. | integer | Valor em centavos. Mínimo 200 (R$ 2,00). |
pixKeyobrig. | string | Chave PIX de destino. |
pixKeyType | string | CPF, CNPJ, EMAIL, PHONE ou EVP. |
recipientDocument | string | Opcional. CPF/CNPJ do titular da chave (somente dígitos). Se informado, o saque é recusado caso o documento não pertença ao dono da chave, proteção extra contra envio para a chave errada. |
passFee | boolean | Se true, o destino recebe o valor cheio e a taxa é somada por cima (debitada do seu saldo). |
beneficiaryName | string | Nome do beneficiário. |
description | string | Descrição do saque. |
Boas práticas
- Saques são irreversíveis após COMPLETE, confira valor e chave antes de enviar.
- Mostre o nome do beneficiário para o seu usuário confirmar antes de disparar o PIX.
- Acompanhe pelo webhook (withdraw.done / withdraw.failed) em vez de polling.
- Pagou via Copia e Cola e o recebedor devolveu? Use a verificação de estorno (verify-refund).
Requisição
bash
curl -X POST https://lynxpix.cc/api/v1/withdraw/create \
-H "Authorization: Bearer lynx_test_sua_chave" \
-H "Content-Type: application/json" \
-d '{"amountCents":5000,"pixKey":"joao@exemplo.com","pixKeyType":"EMAIL","beneficiaryName":"João Silva"}'Resposta
json
{
"data": {
"id": "wd_1a2b3c",
"kind": "withdraw",
"status": "PAID",
"amount": 5000,
"devMode": true
},
"error": null
}