Consultar Saque PIX
GET /v1/withdraw-status/:id e GET /v1/withdraw-status
Visão geral
Endpoints de leitura para consultar saques PIX. Use GET /v1/withdraw-status/:id para detalhe de um saque específico ou GET /v1/withdraw-status para listar com filtros e paginação.
Autenticação
Requer chave de API com scope read. Headers Authorization, X-DF-Secret e X-DF-Passphrase são obrigatórios. Não requer X-DF-Idempotency-Key (são operações de leitura).
Headers
| Header | Exemplo | Obrigatório |
|---|---|---|
| Authorization | Bearer dfk_live_... | Sim |
| X-DF-Secret | sk_... | Sim |
| X-DF-Passphrase | ... | Sim |
Buscar por ID
GET /v1/withdraw-status/:id
- Scope:
read - Rate limit: 60 req/min, burst 10/5s
Retorna detalhes de um saque específico.
Exemplo de requisição
bash
curl https://api.deflow.exchange/v1/withdraw-status/67234abc \
-H "Authorization: Bearer dfk_live_..." \
-H "X-DF-Secret: sk_..." \
-H "X-DF-Passphrase: minha-passphrase"Exemplo de resposta da requisição
json
{
"data": {
"id": "67234abc...",
"status": "sent",
"pixKey": "12345678909",
"pixKeyType": "cpf",
"payoutAmountCents": 5000,
"feeCents": 100,
"depositAmountCents": 5100,
"createdAt": "2026-05-15T12:00:00.000Z",
"sentAt": "2026-05-15T12:01:30.000Z"
},
"meta": {
"timestamp": "2026-05-15T12:02:00.000Z"
}
}Listar saques
GET /v1/withdraw-status
- Scope:
read - Rate limit: 30 req/min, burst 5/5s
Lista saques da conta. Suporta filtros.
Exemplo de requisição
bash
curl "https://api.deflow.exchange/v1/withdraw-status?page=1&limit=20&status=sent&from=2026-05-01T00:00:00Z&to=2026-05-15T23:59:59Z" \
-H "Authorization: Bearer dfk_live_..." \
-H "X-DF-Secret: sk_..." \
-H "X-DF-Passphrase: minha-passphrase"Exemplo de resposta da requisição
json
{
"data": {
"items": [
{
"id": "67234abc...",
"status": "sent",
"pixKey": "12345678909",
"pixKeyType": "cpf",
"payoutAmountCents": 5000,
"feeCents": 100,
"createdAt": "2026-05-15T12:00:00.000Z"
}
],
"page": 1,
"limit": 20,
"total": 1
},
"meta": {
"timestamp": "2026-05-15T12:02:00.000Z"
}
}Paginação
page (mínimo 1) e limit (1-100). Resposta inclui pagination.
Status
unsent— aguardando funding em DePixsending— envio em andamentosent— PIX enviado com sucessoerror— falha irreversívelcancelled— cancelado manualmenterefunded— estornado
Webhook vs polling
Webhook é primário e mais eficiente. Polling a cada 5-10s é fallback aceitável quando webhook não é viável.
