Virtual Accounts

Get virtual account details

Changed on

Retrieve detailed information about a specific virtual account.

get/v1/virtual-accounts/{virtual_account_id}

Request

  • Base URL
    https://api.hit-pay.com
  • URL
    https://api.hit-pay.com/v1/virtual-accounts/{virtual_account_id}
  • Auth
    none declared. Required headers: X-BUSINESS-API-KEY

Path parameters

virtual_account_idstring uuid required

The virtual account ID

Headers

X-BUSINESS-API-KEYstring required
Example:b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d

Response

Successful operation

idstring uuid

Virtual account ID

namestring

Display name of the virtual account

referencestring

Virtual account reference issued by the bank. For DBS Singapore this is the 7-digit VA number that forms the tail of account_number.

statusstring nullable

Provisioning status of the virtual account: pending, success, or rejected. pending means the bank has acknowledged the request but has not activated the account yet.

countrystring

Two-letter lowercase ISO 3166-1 country code of the business the virtual account belongs to

supported_currenciesstring[] nullable

Uppercase currency codes that can be received into this virtual account

holder_namestring

Account holder name, i.e. the registered name of the business

account_numberstring

Full account number to transfer funds to. For DBS Singapore this is the VA prefix and corporate code prepended to reference.

bank_namestring nullable

Name of the bank holding the virtual account

bank_swift_codestring nullable

SWIFT/BIC code of the bank. null for providers that settle without one, such as Philippine accounts on InstaPay and PESONet.

bank_countrystring

Two-letter lowercase ISO 3166-1 country code of the country the bank account is held in. Can differ from country, e.g. a Singapore business can hold an account in gb.

transfer_typesstring[]

Transfer rails the virtual account can receive funds over

created_atstring date-time

ISO 8601 timestamp of when the virtual account was created

updated_atstring date-time

ISO 8601 timestamp of when the virtual account was last updated

Example response

{
  "id": "9b3f1a2c-1d4e-4f6a-8b2c-7e9d0a1b2c3d",
  "name": "Acme Pte Ltd",
  "reference": "1234567",
  "status": "success",
  "country": "sg",
  "supported_currencies": [
    "SGD",
    "USD"
  ],
  "holder_name": "Acme Pte Ltd",
  "account_number": "8854911234567",
  "bank_name": "DBS Bank",
  "bank_swift_code": "DBSSSGSG",
  "bank_country": "sg",
  "bank_attributes": {
    "type": "local",
    "account_number": "8854911234567",
    "bank_name": "DBS Bank",
    "swift_code": "DBSSSGSG",
    "transfer_types": [
      "FAST",
      "SWIFT"
    ]
  },
  "transfer_types": [
    "FAST",
    "SWIFT"
  ],
  "created_at": "2026-06-08T15:30:10+08:00",
  "updated_at": "2026-06-08T15:30:10+08:00"
}

Changes

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status