VOvopay
Virtual Account Endpoints

virtual-account

Retrieve information about virtual accounts associated with your account. Canadian (CAD) virtual accounts are provisioned by VoPay with the bank; their FinancialInstitutionNumber and BranchTransitNumber are populated, and an account can have one virtual account per client account.

get/virtual-account

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/virtual-account
  • Auth
    none declared

Query parameters

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

Status'Active' | 'Pending' | 'Inactive'

The status of the virtual account

Currencystring

Currency abbreviation (e.g., USD, CAD, EUR)

ClientAccountIDstring

Only return the virtual accounts mapped to this client account. Must be a valid ClientAccountID of your account.

Response

Successboolean required

True if the request was successful, false if it failed

ErrorMessagestring required

Contains a description of the error if the request failed

Example response

{
  "Success": true,
  "VirtualAccounts": {
    "0": {
      "VirtualAccountID": "370",
      "VirtualAccountNumber": "001-12345-123456789",
      "Status": "Active",
      "Currency": "GBP",
      "AccountHolderName": "John Doe",
      "FinancialInstitutionNumber": "001",
      "BranchTransitNumber": "12345",
      "AccountNumber": "123456789",
      "IBAN": "GB82WEST12345698765432",
      "ABARoutingNumber": "021000021",
      "BicSwift": "DEUTDEFF",
      "ClientAccountID": "client_account_1"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.