v1
latestOpenAPI 3.1.02026-08-04103211436.0 KBList balances
Returns the end-of-day balances of a company's bank products (accounts), one entry per product per day. Results are paginated: use limit to control page size and pass the returned nextPageToken to fetch the next page. startDate/endDate filter by balance date; startDate is inclusive and endDate is exclusive, and when only one bound is given the range is capped at 90 days. If neither is given, all available balances are returned, paginated. Balances whose linked bank product no longer exists are excluded from the results.
Path parameters
Query parameters
Filter balances of a single bank product (account) by its Embat product ID.
Filter balances of a single bank product (account) by its Embat product ID.
Only return balances dated on or after this date (inclusive). The range cannot exceed 90 days: if endDate is also given, the span between the two cannot exceed 90 days; if endDate is omitted, startDate cannot be more than 90 days in the past.
Only return balances dated on or after this date (inclusive). The range cannot exceed 90 days: if endDate is also given, the span between the two cannot exceed 90 days; if endDate is omitted, startDate cannot be more than 90 days in the past.
Only return balances dated before this date (exclusive). Combined with startDate, the range cannot exceed 90 days. If used without startDate, results start 90 days before this date.
Only return balances dated before this date (exclusive). Combined with startDate, the range cannot exceed 90 days. If used without startDate, results start 90 days before this date.
Maximum number of objects to return in the response. Default 500, maximum 5000.
Maximum number of objects to return in the response. Default 500, maximum 5000.
Token to fetch the next page of results, taken from the nextPageToken returned by the previous request with the same filters. Omit it to fetch the first page.
Token to fetch the next page of results, taken from the nextPageToken returned by the previous request with the same filters. Omit it to fetch the first page.
Response
Successful Response
Example response
{
"data": [
{
"id": "65a1f9c2e4b0a1b2c3d4e5f6",
"balance": 125430.75,
"product": {
"id": "prod_8f3a1c",
"product": "Cuenta Corriente",
"bankFullName": "Banco Bilbao Vizcaya Argentaria",
"alias": "Main checking account"
},
"accountingBalance": 128500.2,
"exchangeRate": 1.0245
}
]
}