Skip to main content
GET
List Virtual Account Applications

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_number
integer
required

Page to return. The first page is 1.

Required range: x >= 1
Example:

1

page_size
integer
required

Maximum number of applications to return, from 1 to 100.

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

50

status
enum<string>

Return only applications with this overall status. Surrounding whitespace is trimmed and lowercase input is accepted.

Available options:
SUBMITTED,
PARTIALLY_COMPLETED,
COMPLETED,
FAILED,
CLOSED
Example:

"SUBMITTED"

country
string

Return only applications for this ISO 3166-1 alpha-2 country code. Surrounding whitespace is trimmed and lowercase input is accepted.

Example:

"SG"

currency
string

Return only applications for this ISO 4217 currency code. Surrounding whitespace is trimmed and lowercase input is accepted.

Example:

"USD"

Response

OK - Virtual Account applications returned successfully.

total_pages
integer<int64>
required

Number of available pages for the selected filters. 0 when no applications match.

Required range: x >= 0
Example:

1

total_items
integer<int64>
required

Total number of applications that match the selected filters, across all pages.

Required range: x >= 0
Example:

2

data
object[]
required

Applications on this page, ordered from newest to oldest. The array is empty when no applications match or the requested page is beyond the available range.