VOvopay
Account Endpoints

account/funding-options

Changed on

This endpoint returns the ways this account can fund transactions: the VoPay balance, the default operational bank account (when FundMyAccountEnabled) with its settlement time, and credit card (when FundMyAccountCreditCardEnabled) with T+1 settlement.

get/account/funding-options

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/account/funding-options
  • 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

Currency to report the balance in (e.g. CAD, USD). Defaults to the account currency

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,
  "FundingOptions": {
    "0": {
      "Source": "bank",
      "Name": "Bank Account",
      "Currency": "CAD",
      "SettlementTime": "t3",
      "FeePerTransaction": "0.50",
      "FeePercent": "3",
      "AccountBalance": "1250.00",
      "AvailableFunds": "1100.00",
      "AccountHolderName": "John Smith",
      "InstitutionName": "CIBC",
      "AccountNumber": "****567",
      "Token": "ACBDF-GAFSHD-AHBS-123456",
      "CreditCardHolderName": "Natalie Merchant",
      "CreditCardNumber": "**** **** **** 1234",
      "CreditCardBrand": "visa",
      "CreditCardToken": "ACBDF-GAFSHD-AHBS-123456"
    }
  }
}

Changes