v1

latestOpenAPI 3.1.0Apache 2.02026-07-2498321298.8 KB

Accounts

List balances

Returns a list of account balances. For further details on Pagination, see general section above.

get/financial-data/v2/accounts/{id}/balances

Path parameters

idstring required

Include only balances associated with the account identified by id. If value - is specified, balances across all accounts will be queried.

Query parameters

type'BOOKED' | 'BOOKED_ADJUSTED' | 'AVAILABLE'

Example:BOOKED

Include only balances of specified balance type (BOOKED or AVAILABLE).

mostRecentboolean

Include only the most recent balance.

limitinteger

Limit the number of items in resulting query response.

tokenstring

If a query response contains a non-empty nextToken, use that value as token query parameter to continue pagination.

Response

List of balances.

nextTokenstring required

Pagination token for next page. The value will be a non-empty string if there are more resources to be fetched. The value will be an empty string if there are no more resources to be fetched.

tokenstring required

The pagination token that was used for this request. The value will be an empty string if no token query parameter was provided with the request.

limitinteger required

The page limit that was used for this request.

Example response

{
  "items": [
    {
      "id": "6eeb63bb-99cc-44e2-9558-202572bfe403",
      "accountId": "31d593d7-fff9-4783-aa1d-92acb7b21a19",
      "organizationId": "52dce1f7-7a38-4875-9058-f586a82d43e9",
      "type": "BOOKED",
      "reportedType": "CLOSE",
      "amount": {
        "currency": "EUR",
        "value": 12345,
        "stringValue": "123.45"
      },
      "timestamp": "2022-05-04T18:31:12.889104898Z",
      "created": "2022-05-05T02:00:00.000000000Z",
      "localDate": "2022-05-04",
      "version": 1
    }
  ],
  "nextToken": "eyIxIjogIlRoaXMgaXMgYSBkdW1teSBwYWdpbmF0aW9uIHRva2VuLiJ9",
  "token": "eyIwIjogIlRoaXMgaXMgYSBkdW1teSBwYWdpbmF0aW9uIHRva2VuLiJ9",
  "limit": 100
}