v10

latestOpenAPI 3.1.1raw.githubusercontent.com2026-06-261653109.3 KB
Saldo

Consultar saldo

Retorna o saldo atual e volumes de transacoes da sua organizacao.

get/v1/balance

Response

Dados do saldo

messagestring nullable

Example response

{
  "data": {
    "currency": "BRL",
    "balance": {
      "available": 150000,
      "pending": 25000,
      "total": 175000
    },
    "totals": {
      "lifetimeVolume": 5000000,
      "lifetimePayouts": 4800000,
      "lifetimeRefunds": 50000
    },
    "period": {
      "volumeToday": 100000,
      "volumeThisWeek": 500000,
      "volumeThisMonth": 2000000
    },
    "updatedAt": "2025-01-15T15:00:00Z"
  },
  "error": {
    "message": "Token invalido ou expirado.",
    "code": "unauthorized"
  }
}