GET/accounts/{id}/balance

Obtenha saldo em tempo real

Fetches the real-time balance for the account directly from the financial institution connector, without requiring a full item sync. Requires the API key (`X-API-KEY`): a Connect Token `accessToken` is rejected with 403 `FORBIDDEN_INSUFFICIENT_PERMISSIONS`.

Parameters

Path Parameters

Name	Type	Description
`id`required	string	Identificador primário da conta

Responses

200Saldo da conta em tempo real

object

balancerequirednumber

The available balance of the account, same as balance in the account resource.

blockedBalancenumber

Amount currently blocked or held on the account. Only present when the institution reports it.

automaticallyInvestedBalancenumber

Amount held in the account's automatic investment facility. Only present when the institution reports it.

closingBalancenumber

Accounting balance of the account: `balance` plus `blockedBalance`. Same value as `bankData.closingBalance` in the account resource, which is updated with it. Only present when the institution reports it.

currencyCoderequiredstring

The currency code of the balance amounts

updateDateTimerequiredstring

The date and time when the balance was last updated

Example response

json

{
  "balance": 1500.5,
  "blockedBalance": 0,
  "automaticallyInvestedBalance": 200,
  "closingBalance": 1500.5,
  "currencyCode": "BRL",
  "updateDateTime": "2024-01-15T10:30:00Z"
}

curl -X GET \
  'https://api.pluggy.ai/accounts/{id}/balance' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY'

Resposta de exemplo

{
  "balance": 1500.5,
  "blockedBalance": 0,
  "automaticallyInvestedBalance": 200,
  "closingBalance": 1500.5,
  "currencyCode": "BRL",
  "updateDateTime": "2024-01-15T10:30:00Z"
}