OPEN BANKING DOCSGet account balance (Open Banking v2)
Retrieve real-time balance from Keystone for the specified account. Charges a per-call fee from the debit account to the settlement account. Idempotent per minute using idempotencyKey.
X-API-Key<token>
In: header
Header Parameters
X-API-Keystring
API key for the application
X-App-Idstring
UUID of the application
Format
uuidappIdstring
Application ID
Format
uuidreadAccountNumberstring
Keystone account number to query balance for
Match
^[0-9]{10}$debitAccountNumberstring
Account number to debit fee from (must belong to appId)
Match
^[0-9]{10}$currencystring
Currency code
Value in
"NGN" | "USD" | "EUR" | "GBP"idempotencyKey?string | null
Optional idempotency key for duplicate prevention
Response Body
curl -X POST "https://virtual-accounts-api.vantacrest.com/company/v1/open-banking/v2/balance" \ -H "X-API-Key: string" \ -H "X-App-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "Content-Type: application/json" \ -d '{ "appId": "28c365d5-df94-4a54-8217-3ce51d068868", "readAccountNumber": "string", "debitAccountNumber": "string", "currency": "NGN" }'{
"data": {
"accountNumber": "string",
"currency": "string",
"availableBalance": 0,
"ledgerBalance": 0,
"asOf": "2019-08-24T14:15:22Z",
"feeApplied": true,
"feeAmount": 0,
"feeCurrency": "string",
"feeTransactionId": "string",
"settlementStatus": "PENDING",
"correlationId": "string"
}
}{
"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"
}