v1

latestOpenAPI 3.1.0Apache 2.02026-07-2473175248.0 KB

2. Accounts

Get a list of Accounts created on this Platform.

get/accounts

paginateboolean

Whether to paginate the results or not. Defaults to false.

prevCursorstring

The cursor to use for the previous page of results. This will be ignored if paginate is false.

nextCursorstring

The cursor to use for the next page of results. This will be ignored if paginate is false.

maxResultsinteger

The maximum number of results to return. The default is 10, and the maximum is 200. This will be ignored if paginate is false.

accountNumberstring

Specify the account number to be queried.

displayNamestring

Specify the account display name to be queried.

status'ACTIVE' | 'INACTIVE' | 'DISABLED' | 'FROZEN' | 'DELETED'

Specify the status to be queried.

contactEmailstring email

Specify the contact email address to be queried.

currencyCodestring[]

Specify the currency code(s) to be queried.

minBalancenumber

Specify the minimum currentBalance to be queried.

maxBalancenumber

Specify the maximum currentBalance to be queried.

minDateCreatedAtstring date-time

Specify the earliest createdAt date to be queried.

maxDateCreatedAtstring date-time

Specify the latest createdAt date to be queried.

fundingNotificationEmailstring[]

Specify the funding notification email(s) to be queried.