VOvopay
Transaction Management Endpoints

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.

post/account/transaction/hold

Request

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

Amountnumber required

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

Currencystring

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

ClientAccountIDstring

The ID of the client account to associate with this hold

Notesstring

Optional notes to attach to the hold transaction

ClientReferenceNumberstring

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

IdempotencyKeystring

A unique key to prevent duplicate transactions. If a transaction with the same idempotency key already exists on the account, the request fails with a duplicate error. Only letters, numbers, underscores and hyphens are allowed

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

TransactionIDinteger required

The unique ID for the hold transaction

Example response

{
  "Success": true
}

Changes

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