API Reference

Block account(s)

post
https://earthnode-dev.vopay.com/api/v2/account/blocked-account/block

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Form Data
string
required

Your account ID

string
required

API key for the account

string
required

Hashed signature for the request

string

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

boolean

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

Response

Updated 4 months ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?