Sign in

v1

latestOpenAPI 3.1.02026-07-266133267.6 KB

List Collection Accounts

Returns a paginated list of collection accounts.

get/v3/collection_account

Query parameters

ending_beforestring

A cursor for pagination. Returns objects before this object ID.

limitinteger

Number of objects to return. Default is 10, range 1-100.

starting_afterstring

A cursor for pagination. Returns objects after this object ID.

payment_method_typestring

Filter by payment method type.

countrystring

Filter by country.

currenciesstring[]

Filter by currencies (ISO format).

on_behalf_ofstring

Filter by the entity ID that the account is configured on behalf of.

status'disabled' | 'enabled'

Filter by collection account status.

type'virtual_account' | 'wallet'

Filter by type (virtual_account or wallet).

gtinteger

Greater than (Unix timestamp).

gteinteger

Greater than or equal to (Unix timestamp).

ltinteger

Less than (Unix timestamp).

lteinteger

Less than or equal to (Unix timestamp).

Filter by creation time. Pass an object with any of gt, gte, lt, lte (Unix timestamps).

Response

List of collection accounts.

objectstring

Always "list".

has_moreboolean

Whether there are more results beyond this page.