VOvopay
Virtual Account Endpoints

virtual-account/close

Close (deactivate) a virtual account. The virtual account balance must be zero (both the available balance and any pending balance) before it can be closed. Canadian virtual accounts are provisioned by VoPay, so this call returns an error for them.

post/virtual-account/close

Request

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

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 virtual account that was closed

Example response

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

Changes

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