v1

latestOpenAPI 3.0.32026-07-23215362.6 KB
Accounts

Get Accounts

Retrieve a list of accounts with optional filtering and pagination.

get/v1/accounts

Query parameters

accountStatus'ACTIVE' | 'INACTIVE' | 'CREATING'

Filter accunts by status

accountType'CREDIT' | 'CASH'

Filter account by type

createDateStartstring date-time

Filter account by creation date lower bound, exclusive

createDateEndstring date-time

Filter accounts by creation date upper bound, inclusive

recentCreditHistory'YES'
customerIdstring uuid

Filter accounts by customer ID

afterstring

When provided, specifies the last item returned in previous page, used to fetch the next page. Fetches the first page when omitted.

limitstring integer

When provided, specifies the number of items to return in the page. Uses default page size of 10 when omitted.

sortField'accountStatus' | 'accountType' | 'createdDate'

Will sort the returned data using the specified field.

sortDirection'ASC' | 'DESC'

Specifies the sort direction for the sortField.

Response

OK

afterstring nullable

The token of the last item in the response

totalCountinteger

The total number of items in the entire filtered data set