Banking APIs support retrieving and filtering entity data using the List APIs. These APIs allow you to fetch multiple records using filters, sorting options, and pagination controls.

Unlike traditional REST APIs that use GET with query parameters, Banking APIs use HTTP POST for list operations. This ensures secure transmission of sensitive information such as customer data and account information.

Each list request allows you to define filtering conditions, sorting options, and pagination controls to retrieve the required dataset.

List API Structure

All list APIs follow a common request structure that includes filters, sorting options, and pagination controls.

Parameter	Type	Description
`criteria`	Object	Mandatory container for all filtering conditions.
`filter`	Object	Defines a condition applied to a field to retrieve a specific record set. Multiple filters can be used.
`sortOptions`	Object	Optional container for sorting configuration.
`sortBy`	String	Field name used to sort the response data.
`sortOrder`	String	Defines the sorting order (`ASC` or `DESC`).
`getTotalCount`	Boolean	Returns the total number of records that match the applied filters.

Filtering Records

Filters allow you to retrieve only the records that match specific conditions.

Multiple filters can be passed in the request to narrow down results based on supported entity attributes.

Example use cases

Retrieve customers created after a certain date
Retrieve accounts belonging to a specific customer
Retrieve transactions with a particular status

The response returns only the records that satisfy the defined filter criteria.

Sorting Records

Sorting allows you to control the order in which records are returned.

Parameter	Type	Description
`sortBy`	String	Field used to sort the records.
`sortOrder`	String	Sort order of the results (`ASC` or `DESC`).

If no sorting criteria is provided, the system sorts records by lastUpdatedOn in descending order by default.

List API Response

The response contains a list of entity records that match the defined filter criteria along with additional pagination metadata.

Typical response metadata includes:

totalCount – Total number of records matching the filters
returnedCount – Number of records returned in the current response
offset – Reference value used for retrieving subsequent records

Only essential attributes of the entity are returned in the list response. To retrieve the complete entity details, a separate GET request must be made using the entity ID.

Note: List APIs may have a data lag of up to 30 minutes.