Consultar saldo

Consulta a posição financeira consolidada de uma empresa, separada por moeda.

Endpoint

Esta operação usa autenticação por x-api-key e retorna JSON.

Método	Endpoint
`GET`	`/api/v2/companies/{companyId}/balance`

Parâmetros

Parâmetros aceitos por esta operação.

Parâmetro	Local	Descrição
`companyId`	`path`	`Identificador da empresa`
`currency`	`query`	`Filtro opcional: BRL, MXN, EUR, COP ou ARS`

Exemplo de requisição

Use uma chave de idempotência única em operações POST.

curl --request GET \
+  --url 'https://api.leonapay.com.br/api/v2/companies/{companyId}/balance' \
+  --header 'Accept: application/json' \
+  --header 'x-api-key: {your_api_key}'

Resposta

Uma operação aceita retorna o envelope padrão da API LeonaPay.

{"success":true,"data":{"companyId":"com_01J...","balances":[{"currency":"BRL","available":120000.00,"releasing":0,"blocked":0,"total":120000.00},{"currency":"MXN","available":54000.00,"releasing":0,"blocked":0,"total":54000.00},{"currency":"ARS","available":18000.00,"releasing":0,"blocked":0,"total":18000.00},{"currency":"COP","available":15340.90,"releasing":0,"blocked":6120.60,"total":21461.50}],"wallets":[{"method":"PIX","currency":"BRL","available":120000.00,"releasing":0,"blocked":0,"total":120000.00},{"method":"SPEI","currency":"MXN","available":54000.00,"releasing":0,"blocked":0,"total":54000.00},{"method":"BANK_TRANSFER","currency":"ARS","available":18000.00,"releasing":0,"blocked":0,"total":18000.00},{"method":"BANK_TRANSFER","currency":"COP","available":15340.90,"releasing":0,"blocked":6120.60,"total":21461.50}],"updatedAt":"2026-08-20T14:32:11Z"}}