Skip to main content
GET
/
v1
/
virtual
/
accounts
List Virtual Accounts
curl --request GET \
  --url https://api-sandbox.uqpaytech.com/api/v1/virtual/accounts \
  --header 'x-auth-token: <api-key>'
{
  "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",
      "close_reason": ""
    }
  ]
}

Authorizations

​
x-auth-token
string
header
required

The API token for login provided by UQPay.

Headers

​
x-on-behalf-of
string

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. If omitted or empty, the request is executed using the master account. More information at Connected Accounts.

Query Parameters

​
page_size
integer
required

The maximum number of items to return per page. Must be between 10 and 100, inclusive.

Required range: 1 <= x <= 100
Example:

10

​
page_number
integer
required

The page number to retrieve a specific set of items. Must be 1 or greater.

Required range: x >= 1
Example:

1

​
currency
string

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.

Example:

"USD,SGD"

Response

OK - List virtual accounts returned successfully.

​
total_pages
integer

The total number of pages of available items.

Example:

10

​
total_items
integer

The total counts of available items.

Example:

105

​
data
object[]