Virtual Account Endpoints

virtual-account/simulate-credit

Simulate a credit to a virtual account. This endpoint is used for testing purposes to add funds to a virtual account.

post/virtual-account/simulate-credit

Request

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

VirtualAccountIDstring required

The ID of the virtual account to credit

Amountstring required

The amount to credit to the virtual account

TransactionType'funding' | 'wire'

Canadian virtual accounts only: books a Virtual Account Funding or Virtual Account Wire transaction. Ignored for other providers.

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
}

Changes

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