Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Transferência e liquidação automatizada de saldo para chaves PIX externas.
POST /v1/withdrawals • escopo withdrawals:write
| Campo | Tipo | Obrigatório | Descrição / Tipos Aceitos |
|---|---|---|---|
amount | string | Sim | Valor do saque em Reais como string decimal com duas casas (ex: "100.00"). Veja Formato de Valores. |
pix_key | string | Sim | Chave PIX de destino (criptografada em AES-256 no banco). |
pix_key_type | string | Sim | Tipo da chave: CPF, CNPJ, EMAIL, TELEFONE, EVP. |
description | string | Opcional | Identificador ou motivo do saque. |
curl -X POST https://api.kavropay.online/v1/withdrawals \
-H "Authorization: Bearer sk_live_SUA_CHAVE_AQUI" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: wit_req_88192" \
-d '{
"amount": "100.00",
"pix_key": "12345678909",
"pix_key_type": "CPF",
"description": "Retirada de comissão de vendas"
}'
{
"id": "WIT7A28F1B3E4C9D01",
"amount": 100.00,
"fee": 2.50,
"net": 97.50,
"status": "processing",
"pix_key": "***.456.789-**",
"pix_key_type": "CPF",
"created_at": "2026-08-26T12:10:00.000Z"
}
{
"statusCode": 402,
"message": "Saldo disponível insuficiente para realizar esta transferência.",
"error": "Request Error",
"timestamp": "2026-08-26T12:10:00.000Z",
"path": "/v1/withdrawals"
}
GET /v1/withdrawals/{id} • escopo withdrawals:read
Busca os dados detalhados de um saque específico. O parâmetro {id} é o ID retornado na criação (WIT...).
curl https://api.kavropay.online/v1/withdrawals/WIT7A28F1B3E4C9D01 \
-H "Authorization: Bearer sk_live_SUA_CHAVE_AQUI"
{
"id": "WIT7A28F1B3E4C9D01",
"amount": 100.00,
"fee": 2.50,
"net": 97.50,
"status": "completed",
"pix_key": "***.456.789-**",
"pix_key_type": "CPF",
"description": "Retirada de comissão de vendas",
"created_at": "2026-08-26T12:10:00.000Z",
"completed_at": "2026-08-26T12:10:45.000Z"
}
GET /v1/withdrawals • escopo withdrawals:read
Query Params: status (pending/processing/completed/failed), limit (1 a 100), offset (0, 20…)
curl "https://api.kavropay.online/v1/withdrawals?status=completed&limit=50&offset=0" \
-H "Authorization: Bearer sk_live_SUA_CHAVE_AQUI"