VOvopay
Account Endpoints

account/operational-accounts

Changed on

This endpoint returns the account's default operational payment methods in one call: the default operational bank account(s) (the same data as the operational portion of /bank-account/default-bank-account) and the default operational credit card (the same data as the operational portion of /credit-card/default-credit-card).

get/account/operational-accounts

Request

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

Query parameters

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

Currencystring

Optional currency filter (e.g. CAD, USD). Applies to the default operational bank account (one default per currency); the credit card is not currency-scoped

Timezonestring

Optional timezone for the bank account date fields

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,
  "DefaultOperationalBankAccount": {
    "0": {
      "AccountHolderName": "John Smith",
      "InstitutionName": "CIBC",
      "FinancialInstitutionNumber": "010",
      "BranchTransitNumber": "00390",
      "AccountNumber": "*****1234",
      "Currency": "CAD",
      "Token": "ACBDF-GAFSHD-AHBS-123456",
      "DateAdded": "2026-01-15 10:30:00"
    }
  },
  "DefaultOperationalCreditCard": {
    "CreditCardToken": "ACBDF-GAFSHD-AHBS-123456",
    "CreditCardHolderName": "Natalie Merchant",
    "CreditCardNumber": "**** **** **** 1234",
    "CreditCardBrand": "visa",
    "CreditCardExpiryMonth": "03",
    "CreditCardExpiryYear": "2028"
  }
}

Changes