Virtual Account Endpoints

virtual-account

Create a new virtual account. Canadian virtual accounts are provisioned by VoPay, so this call returns an error for them.

post/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

Request body application/x-www-form-urlencoded

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

Currencystring required

Currency abbreviation for the virtual account (e.g., USD, CAD, EUR, GBP)

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

VirtualAccountIDstring required

The ID of the newly created virtual account

Example response

{
  "Success": true,
  "VirtualAccountID": "450"
}

Changes

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