Consultar saldo
GET
{{base_url}}/api/balance
Autenticação
Bearer pela sua API Key real (vk_live_* produção, vk_test_* sandbox). Crie a chave em https://app.dotfy.com.br/dashboard/chaves-api. Sem o header → 401. Com chave inválida/revogada → 401. Com chave sem o escopo necessário → 403 insufficient_scope.balance:read.reservedDetails lista as MEDs ativas que estão segurando valor.Requisição
Parâmetros de Consulta
Parâmetros Header
Respostas
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --globoff '{{base_url}}/api/balance?page=1&limit=20' \
--header 'Authorization: Bearer {{api_key}}'Response Response Example
{
"balance": {
"available": 1532450,
"pending": 12000,
"reserved": 30000,
"total": 1544450
},
"reservedDetails": [
{
"disputeId": "clxxx0001",
"medId": "MED-A1B2C3D4",
"amount": 30000,
"reason": "Compra não reconhecida pelo cliente",
"status": "OPENED",
"createdAt": "2026-05-04T10:00:00.000Z"
}
],
"transactions": [
{
"id": "cltrx0001",
"type": "CREDIT",
"amount": 2990,
"description": "Cobrança paga - dotfy-1714000000000-abc12345",
"referenceType": "CHARGE",
"referenceId": "dotfy-1714000000000-abc12345",
"balanceAfter": 1532450,
"createdAt": "2026-05-07T14:35:12.000Z"
}
],
"pagination": { "page": 1, "limit": 20, "total": 1843, "pages": 93 }
}Modificado em 2026-05-07 16:12:35