Skip to main content
GET
List Collection Accounts

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

entity_id
string

ID of the entity whose collection accounts are being listed (starts with ent_, 24 characters). When supplied, the entity's accounts are returned instead of the account's own.

ending_before
string

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

limit
integer<int32>

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

starting_after
string

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

country
string

Filter by country.

currencies
string[]

Filter by currencies (ISO format).

status
enum<string>

Filter by collection account status.

Available options:
disabled,
enabled
type
enum<string>

Filter by collection account type.

Available options:
virtual_account,
wallet,
tazapay_account
query
string

Free-text search across the collection accounts. 1-100 characters.

created_gte
integer<int64>

Return accounts created at or after this time (Unix timestamp).

created_lte
integer<int64>

Return accounts created at or before this time (Unix timestamp).

Response

200 - application/json

List of collection accounts.

status
string
message
string
data
object