Saldo e extrato

Método	Endpoint	Descrição
GET	/api/balance	Saldo atual, com os recortes balance, blocked, reserve e processing
GET	/api/export/charges	Enfileira a exportação de cobranças em CSV
GET	/api/export/withdrawals	Enfileira a exportação de saques em CSV

Consultar saldo

GET /api/balance

GET /api/balance

curl --request GET \
  --url https://api.avexus.app/api/balance \
  --header 'x-api-key: <API_KEY>' \
  --header 'x-token: <TOKEN>' \
  --header 'x-timezone: America/Sao_Paulo'

200 — Balance returned

{
  "code": 200,
  "content": {
    "currency": "BRL",
    "balance": 1250.75,
    "blocked": 120.0,
    "reserve": 80.0,
    "processing": 45.5
  },
  "message": "Balance returned",
  "timestamp": "2026-07-24T18:38:26.703Z"
}

O que cada recorte significa

Campo	Descrição
balance	Disponível para usar — é daqui que sai um saque
blocked	Bloqueado (ex.: disputa em andamento)
reserve	Retido em reserva
processing	Em processamento, ainda não liquidado

Saldo é derivado, nunca escrito

O saldo não é um contador que alguém incrementa: ele é derivado do ledger (contabilidade de partidas dobradas). Toda movimentação vira lançamento, e o saldo é a soma deles. É por isso que os quatro recortes sempre fecham entre si.

Filtros

GET /api/balance — por moeda

curl --request GET \
  --url 'https://api.avexus.app/api/balance?currency=BRL' \
  --header 'x-api-key: <API_KEY>' \
  --header 'x-token: <TOKEN>'

GET /api/balance — por tipo

curl --request GET \
  --url 'https://api.avexus.app/api/balance?type=FIAT' \
  --header 'x-api-key: <API_KEY>' \
  --header 'x-token: <TOKEN>'

Dica

Antes de pedir um saque, confira se o valor mais a fee cabe em balance. O que está em blocked, reserve ou processing não pode ser sacado.

Extrato

O extrato lançamento a lançamento (cada crédito, débito, taxa, split e estorno, com a referência da cobrança que os originou) está no painel, em Financeiro → Extrato.

TODO(contrato)

A API pública ainda não expõe o extrato: hoje ele é servido só para a sessão do painel. Falta a frente F0 — Contrato decidir se o ledger vira um endpoint do lojista (algo como GET /api/ledger, paginado por cursor) ou se a exportação em CSV abaixo continua sendo o caminho oficial para reconciliação programática.

Os campos que o painel já recebe por lançamento — account, direction, type, description, amount, currency, reference, created_at — são a base natural desse contrato.

Exportações em CSV

As exportações são assíncronas: a chamada enfileira o trabalho e responde 202 com um job_id. O arquivo fica disponível para download no painel quando o processamento termina.

Períodos (date_range)

Valor	Período
today	Hoje
yesterday	Ontem
current_month	Mês atual
last_seven_days	Últimos 7 dias
last_four_weeks	Últimas 4 semanas
last_month	Mês passado
all	Todo o histórico

Dica

Combine com x-timezone para que os recortes de data respeitem o seu fuso — “hoje” em America/Sao_Paulo não é “hoje” em UTC.

Exportar cobranças

GET /api/export/charges

Mês atual

GET /api/export/charges — mês atual

curl --request GET \
  --url 'https://api.avexus.app/api/export/charges?date_range=current_month' \
  --header 'x-api-key: <API_KEY>' \
  --header 'x-token: <TOKEN>' \
  --header 'x-timezone: America/Sao_Paulo'

Últimos 7 dias

GET /api/export/charges — últimos 7 dias

curl --request GET \
  --url 'https://api.avexus.app/api/export/charges?date_range=last_seven_days' \
  --header 'x-api-key: <API_KEY>' \
  --header 'x-token: <TOKEN>' \
  --header 'x-timezone: America/Sao_Paulo'

Todo o histórico

GET /api/export/charges — todo o histórico

curl --request GET \
  --url 'https://api.avexus.app/api/export/charges?date_range=all' \
  --header 'x-api-key: <API_KEY>' \
  --header 'x-token: <TOKEN>' \
  --header 'x-timezone: America/Sao_Paulo'

202 — Charges export queued

{
  "code": 202,
  "content": {
    "job_id": "exp_7Kd1p0Ct6QL3",
    "date_range": "current_month",
    "kind": "charges"
  },
  "message": "Charges export queued",
  "timestamp": "2026-07-24T18:38:26.703Z"
}

Exportar saques

GET /api/export/withdrawals

GET /api/export/withdrawals — mês atual

curl --request GET \
  --url 'https://api.avexus.app/api/export/withdrawals?date_range=current_month' \
  --header 'x-api-key: <API_KEY>' \
  --header 'x-token: <TOKEN>' \
  --header 'x-timezone: America/Sao_Paulo'

202 — Withdrawals export queued

{
  "code": 202,
  "content": {
    "job_id": "exp_9Wlp2kGy4t9",
    "date_range": "current_month",
    "kind": "withdrawals"
  },
  "message": "Withdrawals export queued",
  "timestamp": "2026-07-24T18:38:26.703Z"
}

TODO(contrato)

O acompanhamento do job (status, row_count, file_size_bytes, file_name, expires_at) e o download do arquivo hoje só existem na área autenticada do painel. Expor GET /api/exports/{job_id} e o download na API do lojista depende da F0.

Veja também

• Saques — como transformar balance em dinheiro na conta.
• Split de pagamento — como os lançamentos de split aparecem no extrato.
• Códigos de erro — o que fazer com um 422 Insufficient available balance.