v1

latestOpenAPI 3.0.02026-07-2640301.0 MB

Virtual Account Endpoints

virtual-account

Retrieve information about virtual accounts associated with your account.

get/virtual-account

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)

Response

Successboolean

True if the request was successful, false if it failed

ErrorMessagestring

Contains a description of the error if the request failed

Example response

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