GET/pix-biometric/enrollments/{id}/balance

Retrieve account balance

Reads the linked account balance in real time from the institution. Requires an AUTHORIZED enrollment created from a payment request 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)	Enrollment primary identifier

Responses

200Account balance

object

balancerequirednumber

Account balance in BRL.

overdraftrequiredobject

Overdraft limit of the 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/pix-biometric/enrollments/{id}/balance' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY'

Sample response

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