VOvopay
Blocked Accounts

Block account(s)

Blocks one or all sub-accounts under the authenticated secured account. Optionally transfers any available funds out of the blocked account(s). Requires the ManageBlockedAccounts permission.

post/account/blocked-account/block

Request

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

VopayAccountIDstring

The VoPay sub-account ID to block. If omitted, all sub-accounts under the authenticated account will be blocked.

TransferAvailableFundsboolean

If true, any available funds in the blocked account(s) will be transferred out before blocking. Defaults to false.

Response

Successboolean

True if the request was successful, false if it failed

ErrorMessagestring

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.