List Account
Use this endpoint to retrieve information about your sub accounts. You can filter by email, creation date, type, name, or status. The results are paginated and ordered by creation date
Header Request
Authorization
String
M
Represents Basic Authentication.
e.g. Basic dW5kZWZpbmVkOnBhc3N3b3Jk
accept
String
M
Mandatory header to specify the response format. Must be set to application/json so the server returns the response in JSON format.
Body Request
1
array of string
O
5
255 (each item)
Filter by account email list. If not provided, all emails will be returned.
2
status
array of string
O
1
25 (each item)
Filter by account status.
Valid values: INVITED, REGISTERED, AWAITING_DOCS, LIVE, SUSPENDED
3
public_profile.business_name
String
O
1
512
Filter by business name (public profile) used during account creation.
4
type
String
O
5
15
Filter by account type.
Valid values: MANAGED, OWNED
5
created[gte]
string (date-time)
O
24
24
Start time filter based on the account creation date.
6
created[lte]
string (date-time)
O
24
24
End time filter based on the account creation date.
7
updated[gte]
string (date-time)
O
24
24
Start time filter based on the account last updated date.
8
updated[lte]
string (date-time)
O
24
24
End time filter based on the account last updated date.
9
limit
number
O
1
50
Maximum number of records per request. Min: 1 • Max: 50 • Default: 10
10
before_id
String
O
1
36
Next item ID for pagination.
11
after_id
String
O
1
36
Previous item ID for pagination.
Sample Request
Body Response
1
data
array of object
M
List of returned accounts
2
data[].id
String
M
36
Unique account identifier
3
data[].created
String (date-time)
M
24
Account creation date and time (ISO 8601)
4
data[].updated
String (date-time)
M
240
Account last updated date and time
5
data[].type
String
M
15
Account type
Valid values: MANAGED, OWNED
6
data[].email
String
M
255
Account email address
7
data[].public_profile
Object
M
512
Public profile information of the account
8
data[].public_profile.business_name
String
M
1
255
Business name / public profile name
9
data[].public_profile.description
String
O
1
500
Short business description
10
data[].country
String
M
2
2
Country code (ISO 3166-1 alpha-2)
11
data[].status
String
M
Account status
Valid values: INVITED, REGISTERED, AWAITING_DOCS, LIVE, SUSPENDED
12
has_more
boolean
M
Indicates whether more data is available (pagination)
13
links
array of object
M
Pagination link information
14
links[].href
String
M
Pagination URL
15
links[].rel
String
M
20
Pagination link relation (example: next, prev)
16
links[].method
String
M
10
HTTP method for pagination
Sample Response
Sample Response (Negative)
List Account HTTP Status Code
1
200
Success with Response Body Message
2
400
[ API_VALIDATION_ERROR, INVALID_CONFIGURATION, INVALID_JSON_FORMAT, TYPE_AND_CONFIGURATION_CONFLICT, INVALID_SOURCE_OR_DESTINATION_ERROR, INSUFFICIENT_BALANCE, INVALID_FEE_AMOUNT, DUPLICATE_ERROR, INVALID_AMOUNT, INSUFFICIENT_ACCOUNT_HOLDER_DATA, MISMATCH_PAYLOAD_FOR_REFERENCE, INVALID_URL_FORMAT ]
3
404
[ DESTINATION_ACCOUNT_NOT_FOUND, DATA_NOT_FOUND, CALLBACK_AUTHENTICATION_TOKEN_NOT_FOUND_ERROR ]
Last updated