Guides

Virtual Account Create / Update

Published when a virtual account is create or update.

Event metadata

  • name: VIRTUAL
  • types:
    • virtual.account.create
    • virtual.account.update

Request body

FieldsData TypeDescription
event_idstringA unique ID for the event.
event_namestringEvent name.
event_typestringEvent type.
source_idstringAccount bank ID.
versionstringAPI Version number.
dataobjectObject containing virtual account details associated with the event.

Notification example

{
    "version": "V1.5.2",
    "event_name": "VIRTUAL",
    "event_type": "virtual.account.update",
    "event_id": "e1a50e75-166f-4dd7-9d0b-69f1b050bc7f",
    "source_id": "c50577b7-299f-4756-8df1-e5c3e7173262",
    "data": {
      "direct_id": "77b74756-552e-3010-b14b-349cf612c956",
      "account_id": "6f790194-f9cd-4b7d-810e-092460804988",
      "account_bank_id": "c50577b7-299f-4756-8df1-e5c3e7173262",
      "account_holder": "John Doe",
      "account_number": "GB29NWBK60161331926819",
      "country_code": "GB",
      "currency": "GBP",
      "bank_name": "HSBC BANK PLC",
      "bank_address": "8 Canada Square, London E14 5HQ, United Kingdom",
      "status": "Active",
      "clearing_system": {
        "type": "bic_swift",
        "value": "HSBCGB2L"
      },
      "capability": {
        "payment_method": "SWIFT"
      },
      "close_reason": ""
    }
}