Consultar saldo
Retorna o saldo disponível da conta vinculada à sua API Key (em centavos).
Overview
Use antes de operações de cash-out para validar saldo. Requer API Key com escopo accounts:read.
Endpoint
GETGET /accounts/balance
Base URL:
https://api.onnixpay.com/api/v1/sdkHeaders
| Header | Obrigatório | Descrição |
|---|---|---|
| X-API-Key | Sim | Sua API Key. |
Exemplo cURL
cURL
curl -X GET "https://api.onnixpay.com/api/v1/sdk/accounts/balance" \
-H "X-API-Key: ox_sua_chave_aqui"Response — Sucesso (200)
JSON
{
"available": 150000,
"currency": "BRL",
"updatedAt": "2025-02-09T12:00:00.000Z"
}Campos da resposta
| Campo | Tipo | Descrição |
|---|---|---|
| available | number | Saldo disponível em centavos (para saque/pagamento). |
| currency | string | Moeda (ex.: BRL). |
| updatedAt | string | Data/hora da última atualização do saldo (ISO 8601). |
Status codes e erros comuns
| Status | Código | Mensagem |
|---|---|---|
| 401 | INVALID_API_KEY | Chave de API inválida ou ausente. |
| 403 | INSUFFICIENT_PERMISSIONS | Sem permissão para consultar saldo. |
Exemplo de resposta de erro
JSON
{
"code": "INSUFFICIENT_PERMISSIONS",
"message": "Sem permissão para este recurso."
}