v1
latestOpenAPI 3.0.22026-07-26123510445.2 KBVirtual Accounts
List Virtual Accounts
Get list of virtual accounts.
get/v1/virtual/accounts
Query parameters
page_sizeinteger required
Example:10
The maximum number of items to return per page. This number can be between 1 - 100
page_numberinteger required
Example:1
The page number to retrieve the next set of items. The number has to be greater than 1.
currencystring
Example:USD,SGD
Specifies the currency or currencies for the Virtual Account (VA), determining which funds it can receive. Multiple currencies should be separated by commas. Currency codes follow the ISO 4217 standard.
Headers
x-on-behalf-ofstring
Specifies the sub-account on whose behalf the request is made. This should be set to the account_id, which can be retrieved via the List Connected Accounts API. If omitted or empty, the request is executed using the master account. More information at Connected Accounts.
Response
OK - List virtual accounts returned successfully.
Example response
{
"total_pages": 10,
"total_items": 105,
"data": [
{
"account_holder": "John Doe",
"account_number": "12345678",
"capability": {
"payment_method": "SWIFT"
},
"country_code": "SG",
"currency": "SGD",
"account_bank_id": "72970a7c-7921-431c-b95f-3438724ba16f",
"bank_name": "ABC Bank",
"bank_address": "810 Seventh Avenue, New York, NY 10019, US",
"clearing_system": {
"type": "bic_swift",
"value": "TCCLGB3L"
},
"status": "ACTIVE"
}
]
}