Skip to main content

​
Resumo

  • Método: GET
  • Rota: /organization/balance
  • Autenticação: Authorization: Bearer <seu_api_token>

​
Headers

NomeObrigatório
AuthorizationSim
X-Correlation-IDRecomendado

​
Exemplo (curl)

curl -X GET https://api.clearpago.com.br/organization/balance \
  -H "Authorization: Bearer <seu_api_token>" \
  -H "X-Correlation-ID: req-balance-001"

​
Resposta 200

[
    {
        "id": "fdaf5148-3de5-4cb3-a670-1bf2d3998939",
        "amount": 1.27,
        "code": "BRL",
        "name": "Brazillian real",
        "symbol": "R$",
        "icon": null
    }
]
A resposta é um array de objetos, um por moeda configurada na organização.
CampoTipoDescrição
idstring (UUID)Identificador interno da conta na moeda.
amountnumberSaldo disponível em BRL (unidade monetária, não centavos).
codestringCódigo ISO 4217 da moeda (ex.: BRL).
namestringNome da moeda.
symbolstringSímbolo da moeda (ex.: R$).
iconstring | nullURL do ícone da moeda, quando disponível.
O campo amount é retornado em BRL (float), diferente da maioria dos campos monetários das transações, que usam *_cents (inteiro em centavos).

​
HTTP

  • 200 Saldo retornado com sucesso.
  • 401 Token inválido ou ausente.
  • 500 Erro interno.

​
Relacionado