GET/smart-transfers/preauthorizations/{id}/balance

Retrieve source account balance

Reads the source account balance in real time from the institution. Requires a preauthorization created with `linkedJourney` whose `dataConsent` is `AUTHORISED`. Every call counts toward the institution's monthly Open Finance quota for that account; see [Operational Rate Limits](https://docs.pluggy.ai/docs/open-finance/rate-limits).

Parameters

Path Parameters

Name	Type	Description
`id`required	string (uuid)	Preauthorization primary identifier

Responses

200Source account balance

object

balancerequirednumber

Source account balance in BRL.

overdraftrequiredobject

Overdraft limit of the source account. Null when the institution does not share it.

One of:

option 1object

option 2null | null

Example response

json

{
  "balance": 5.48,
  "overdraft": {
    "contracted": 1000,
    "used": 0,
    "available": 1000
  }
}

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

Resposta de exemplo

{
  "balance": 5.48,
  "overdraft": {
    "contracted": 1000,
    "used": 0,
    "available": 1000
  }
}