Saldo da subconta

GET

/api/subaccounts/{{subaccount_id}}/balance

Operação delegada (white-label)

Saldo atual da subconta {{subaccount_id}}. Autenticada pela API Key do master.

Escopo: subaccounts:read

Resposta `200 OK`

{ balance: { available, pending, reserved, updatedAt } }. Todos os valores em CENTAVOS.

Campo	Tipo	Notas
`available`	int	Disponível para saque (CENTAVOS).
`pending`	int	A liquidar (CENTAVOS).
`reserved`	int	Retido por MEDs ativas (CENTAVOS).
`updatedAt`	string\|null	ISO8601 da última atualização.

Se a subconta ainda não tem registro de saldo, retorna { available: 0, pending: 0, reserved: 0, updatedAt: null }.

Sigilo (crítico): o saldo não traz decomposição de taxa. Comissão/base do master NUNCA aparecem aqui.

Códigos de erro

HTTP	Quando
`401`	API Key ausente/inválida.
`404`	Master sem white-label, ou subconta inexistente/não-sua.

Exemplo cURL

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

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

Parâmetros Header

Respostas

🟢200

application/json

Bodyapplication/json

🟠404

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff '/api/subaccounts/{{subaccount_id}}/balance' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Sucesso (200)

{
  "balance": {
    "available": 152340,
    "pending": 4990,
    "reserved": 0,
    "updatedAt": "2026-05-07T14:35:12.000Z"
  }
}

Modificado em 2026-07-02 06:57:27

Página anterior

Detalhe de cobrança da subconta

Próxima página

Extrato (transações) da subconta

Saldo da subconta

Operação delegada (white-label)#

Resposta 200 OK#