v1
latestOpenAPI 3.1.02026-07-2478315484.9 KBGet Balances
The Get Balances endpoint retrieves a list of balances associated with a specific bank account that has been linked by a user via LinkSDK, identified by both the entity_id and the account_id.The account_id can be found by making a call to the /accounts endpoint.Each balance object contains fields such as balance type (e.g., CLOSING_AVAILABLE, INTERIM_BOOKED, etc.), amount, currency, credit/debit indicator, and optional credit_line details that indicate available or agreed credit facilities tied to the account.Balance types can vary based on the bank and the nature of the account, and multiple types of balances may be available for the same account at the same time.Requires an active entity with the balances permission to use. A step by step guide here.
Path parameters
The account_id used to fetch requested data
Query parameters
When true the API will return a results_id which can be fetched from the /data/v2/results endpoint when ready. Note: it's recommended to use the sync flow (async=false) for all requests by adapting the data workflow for connected entities.
The page you're requesting - returns page 0 of a response if not specified.
The number of objects you want to return as a page size.
The entity_id you're querying for, which is created by LinkSDK .connect() function.
Additional data you would like to store against the request. Example: {"foo": "val"}
Response
OK
Example response
{
"data": {
"balances": [
{
"amount": {
"currency": "AED"
},
"credit_line": [
{
"amount": {
"currency": "AED"
}
}
]
}
]
}
}