GET
/
accounts

Returns a list of Accounts.

Query Parameters

holder_id
string

The ID of the Entity whose Accounts to retrieve.

status
enum

Status of the Account.

type
enum

The type of Account.

liability.mch_id
string

The ID of the Merchant to which a liability Account is linked.

liability.type
enum

The type of the liability Account to retrieve. See Account Liability Types.

liability.ownership
enum

The holder's ownership type relative to the Account. One of primary, authorized, joint or unknown

from_date
string

ISO 8601 formatted date (YYYY-MM-DD) to filter for Accounts created on and after the date provided.

to_date
string

ISO 8601 formatted date (YYYY-MM-DD) to filter for Accounts created on and before the date provided.

page
string

The number of the page to return.

page_cursor
string

The ID of a resource from which a page should start or end. Mutually exclusive with page.

page_limit
string

The number of Accounts to return per page.

expand
enum[]

Attributes that can be expanded into an object to provide additional information.

Returns

Returns a list of Accounts.