GET Bank To Customer Account Report

The GET Bank To Customer Account Report endpoint provides a comprehensive, structured intraday data of account activity for reconciliation, cash management, and financial reporting.

The endpoint supports cursor-based pagination.

Cursor-based pagination

Request

The endpoint supports the following parameters:

Parameter	Description	Possible Values	Default	Remark
`Limit`	Max number of records to be returned on each request.	1 - 5000	5000 (if Cursor not set)	Only allowed on initial request (when not using Cursor).
`Order`	In what order the records will be returned. The columns that are ordered by may vary between endpoints.	`'ASC'`, `'DESC'`	'DESC' (if Cursor not set)	Only allowed on initial request (when not using Cursor).
`Cursor`	A cursor used to fetch the next/previous set of records.	Next or Previous cursor from an earlier request	NULL	When using a cursor, you can't change the parameters from the initial request. If that is needed, you have to create a new initial request.
`Direction`	Whether you want to fetch records after the cursor (next) or before the cursor (prev).	`'NEXT'`, `'PREV'`	NULL	Only allowed when using Cursor.

📘
It is not possible to adjust query parameters when using a cursor. If the limit is set to 5, all succeeding cursor-based requests will use the same limit etc. The only allowed parameter to use with Cursor is Direction.

Response

🚧
Cursor-based pagination is not supported for CSV.

CAMT.052.001.08

The pagination response is returned in HTTP headers:

X-Record-Count: 2
X-Has-More: true
X-Next-Cursor: some-cursor-to-get-next
X-Previous-Cursor: some-cursor-to-get-previous

JSON

The pagination response will have the form:

{
  "pageInfo": {
    "recordCount": 2,
    "hasMore": true,
    "nextCursor": "some-cursor-to-get-next",
    "previousCursor": "some-cursor-to-get-previous"
  },
  "context": {
    "header": {},
    "accounts": []
  },
  "records": [
    {
      //...
    },
    {
      //...
    }
  ],

}

Property	Description	Usage
`Records`	The actual records requested	Transactions are not returned by default. `Records` will be empty if transactions are not included (use includeTransactions=true).
`PageInfo.RecordCount`	The number of records in the `Records` list
`PageInfo.HasMore`	Indicates if there are currently more records to be fetched on the next/previous page. The value is based on the direction of the former request.	If hasMore is false you have reached the current end of the list. Depending on sort order and direction of traversal, there may come more records eventually. Practically it means that when hasMore becomes false, the 'next' cursor can be saved and this can be used to check if new records have appeared instead of starting all over.
`PageInfo.NextCursor`	Cursor to be used to fetch next records.	Use this with Direction 'NEXT' to get next records.
`PageInfo.PreviousCursor`	Cursor to be used to fetch previous records.	Use this with Direction 'PREV' to get previous records.