Skip to main content
POST
/
v1
/
virtual
/
accounts
Create Virtual Account
curl --request POST \
  --url https://api-sandbox.uqpaytech.com/api/v1/virtual/accounts \
  --header 'Content-Type: application/json' \
  --header 'x-auth-token: <api-key>' \
  --header 'x-idempotency-key: <x-idempotency-key>' \
  --data '
{
  "currency": "USD,SGD",
  "payment_method": "LOCAL"
}
'
{
  "message": "SUCCESS"
}

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.

​
x-idempotency-key
string<uuid>
required

A unique identifier (UUID) used to maintain operation idempotency, ensuring that repeated executions of the same operation do not result in unintended effects or duplication. It helps preserve data consistency in the face of network errors, retries, or failures.

​
x-request-id
string

A custom identifier for the request, up to 64 characters. If provided, this value is returned in the associated webhook event as request_id.

Maximum string length: 64

Body

application/json
​
currency
string
required

Multiple currencies are joined using commas. Currency code ISO_4217.

Example:

"USD,SGD"

​
payment_method
enum<string>

The payment method needs to be specified to ensure that accurate banking details are captured and validated for the specified payment method.

Available options:
LOCAL,
SWIFT
Example:

"LOCAL"

Response

VA Account creation successfully.

​
message
string
Example:

"SUCCESS"