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

Consultar saldo da conta

Lê o saldo da conta vinculada em tempo real da instituição. Requer um vínculo AUTHORIZED criado a partir de uma solicitação de pagamento com `linkedJourney`, cujo `dataConsent` é `AUTHORISED`. Cada chamada conta para o limite mensal de Open Finance da instituição para essa conta; veja [Limites Operacionais de Taxa](https://docs.pluggy.ai/docs/open-finance/rate-limits).

Parameters

Path Parameters

Name	Type	Description
`id`required	string (uuid)	Identificador primário do vínculo

Responses

200Saldo da conta

object

balancerequirednumber

Saldo da conta em BRL.

overdraftrequiredobject

Limite de cheque especial da conta. Nulo quando a instituição não o compartilha.

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'

Resposta de exemplo

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