Visualizar saldo de uma empresa

GET

/balance/{companyId}

Visualiza o saldo de créditos de uma empresa e se ela está bloqueada. Requer autenticação via Bearer JWT ou header x-api-key.

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros de Caminho

Parâmetros Header

🟢200

application/json

Harvested 200

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

Request Example

Shell

JavaScript

Java

Swift

curl --location '/balance/COMPANY_ID' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Sucesso

{
    "companyId": "string",
    "balance": 0,
    "blocked": false
}

Modificado em 2026-10-13 09:47:06