Get account balance

Retrieve the current balance of an account.

What this endpoint does

Use this endpoint to fetch the latest available balance for a given account. This is typically used before initiating transfers, reconciling statements, or showing balances in your UI.

Accounts overview: /docs/accounts-management
Get account statement: GET /accounts/statement
Name enquiry: GET /accounts/name-enquiry

Authorization

X-API-Key<token>

In: header

Query Parameters

accountNumberstring

10-digit account number

Match^[0-9]{10}$

Header Parameters

X-API-Keystring

API key for the application

X-App-Idstring

UUID of the application

Formatuuid

Response Body

curl -X GET "https://virtual-accounts-api.vantacrest.com/company/v1/accounts/balance?accountNumber=string" \
  -H "X-API-Key: string" \
  -H "X-App-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08"

curl -X GET "https://virtual-accounts-api.vantacrest.com/company/v1/accounts/balance?accountNumber=string" \  -H "X-API-Key: string" \  -H "X-App-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08"

{
  "data": 0
}

{
  "success": true,
  "message": "string",
  "data": {},
  "timestamp": "2019-08-24T14:15:22Z"
}

{
  "success": true,
  "message": "string",
  "data": {},
  "timestamp": "2019-08-24T14:15:22Z"
}

{
  "success": true,
  "message": "string",
  "data": {},
  "timestamp": "2019-08-24T14:15:22Z"
}