Virtual Account Create / Update

Published when a virtual account is created, updated, or closed.

WEBHOOK virtualAccountCreateUpdate

JSON

created

{
  "version": "V1.6.0",
  "event_name": "VIRTUAL",
  "event_type": "virtual.account.create",
  "event_id": "831ec4d0-7dfa-4f6c-a565-ba8e1550de26",
  "source_id": "a3b4932d-8b6e-4cc4-bc0b-b1e9049135ee",
  "data": {
    "account_bank_id": "",
    "account_holder": "UQPAY PTE LTD",
    "account_id": "b1b89684-c2c4-4d54-b8a8-3572727fd120",
    "account_number": "",
    "bank_address": "",
    "bank_name": "",
    "capability": {
      "payment_method": ""
    },
    "clearing_system": {
      "type": "",
      "value": ""
    },
    "close_reason": "",
    "country_code": "",
    "currency": "GBP",
    "direct_id": "0",
    "request_id": "",
    "status": "Processing"
  }
}

The synchronous response from Create Virtual Account is acknowledgement only — it always returns SUCCESS, regardless of whether the virtual account is actually provisioned. The final state is delivered through this webhook:

• virtual.account.create — UQPAY has accepted the application for the requested currency.
• virtual.account.update with status = Active — the VA is now usable.

No webhook is sent if the application fails. If you do not receive a virtual.account.update within the expected window, contact UQPAY support.

Event Types

Event Type	Description
virtual.account.create	A new virtual account was created.
virtual.account.update	An existing virtual account was updated.
virtual.account.closed	A virtual account was closed.

Body

application/json

event_id · string<uuid> · required

A unique identifier for this event.

event_name · enum<string> · required

Top-level event category.

Available options: VIRTUAL

event_type · enum<string> · required

The specific event type that occurred.

Available options: virtual.account.create, virtual.account.update, virtual.account.closed

source_id · string · required

Account bank ID.

version · string · required

API version number.

Example:

"V1.6.0"

data · object

Virtual account details associated with the event.

Show child attributes

Response

200

Return 200 to acknowledge receipt.