Balance & Statement: Balance APIs
Retrieve balance information for accounts.
Endpoints
GET
/v1/balances
List balances for a group of accounts.
Parameters
accountKeys
array
List of account keys (branch/account format)
initialDate
string
Initial date for balance query (YYYY-MM-DD)
finalDate
string
Final date for balance query (YYYY-MM-DD)
Response
{
"balances": [
{
"branch": 1,
"account": 100,
"balances": [
{
"date": "2024-01-01",
"balances": {
"AVAILABLE": {
"value": 1000,
"currency": "USD"
},
"HELD": {
"value": 0,
"currency": "USD"
}
}
}
]
}
]
}
GET
/v1/accounts/{branch}/{account}/balances
Get balance information for a specific account.
Parameters
branch
string
Branch number
account
string
Account number
Response
{
"balances": [
{
"date": "2022-07-06",
"balances": {
"AVAILABLE": {
"value": 3000,
"currency": "USD"
},
"HELD": {
"value": 2000,
"currency": "USD"
},
"BLOCKED": {
"value": 500,
"currency": "USD"
},
"BOOK": {
"value": 200,
"currency": "USD"
}
}
}
]
}
GET
/v1/accounts/{branch}/{account}/limits
Get account limits information.
Parameters
branch
string
Branch number
account
string
Account number
Response
{
"limits": [
{
"type": "DAILY_LIMIT",
"value": 10000,
"currency": "USD",
"effectiveDate": "2024-01-01"
}
]
}
GET
/v1/cubes/balances
Get aggregated balance information from data cubes using MDX queries.
Parameters
mdxQuery
string
MDX query for cube data retrieval
Response
{
"data": [
{
"dimension": "BALANCE_TYPE",
"measure": "AMOUNT",
"value": 15000,
"currency": "USD"
}
],
"metadata": {
"query": "MDX query string",
"executionTime": "150ms"
}
}