Get Virtual Account Balance

Get Virtual Account Balance

get

https://api.aurixpay.wshttps://sandbox.api.aurixpay.ws

/banking/v1/virtual-accounts/{virtual_account_id}/balances

This endpoint retrieves the current balance of a virtual account, showing the available amount and currency.

scope: virtual-accounts.read

Path parameters

virtual_account_idstring · uuidRequiredExample: 01977a5b-274d-705f-a889-2b03137cb838

Header parameters

AcceptstringOptionalExample: application/json

X-API-KeystringRequiredExample: {{API_KEY}}

Responses

200

Success

application/json

403

Forbidden

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

get

/banking/v1/virtual-accounts/{virtual_account_id}/balances

HTTPcURLJavaScriptPython

GET /banking/v1/virtual-accounts/{virtual_account_id}/balances HTTP/1.1
Host: api.aurixpay.ws
X-API-Key: text
Accept: */*

{
  "data": {
    "available_balance": {
      "amount": 74219,
      "currency": "BRL"
    }
  }
}