API Reference

account/transaction/hold

post
https://earthnode-dev.vopay.com/api/v2/account/transaction/hold

This endpoint creates a hold on funds in your account. The held amount is reserved and will not be available for other transactions until the hold is released or the hold transaction is cancelled.

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

number
required

The amount to place on hold. Must be greater than 0

string

The currency of the hold amount. Defaults to the account's default currency if not provided

string

The ID of the client account to associate with this hold

string

Optional notes to attach to the hold transaction

string

An optional reference number from the client to associate with the hold transaction

Response

Updated 3 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 3 months ago

Did this page help you?