---
title: "account/transaction/hold"
method: POST
path: "/account/transaction/hold"
tags: ["Transaction Management Endpoints"]
---

# account/transaction/hold

`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

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.

## Request body `application/x-www-form-urlencoded`

- object
  - `AccountID` string, required: Your account ID
  - `Key` string, required: API key for the account
  - `Signature` string, required: Hashed signature for the request
  - `Amount` number, required: The amount to place on hold. Must be greater than 0
  - `Currency` string: The currency of the hold amount. Defaults to the account's default currency if not provided
  - `ClientAccountID` string: The ID of the client account to associate with this hold
  - `Notes` string: Optional notes to attach to the hold transaction
  - `ClientReferenceNumber` string: An optional reference number from the client to associate with the hold transaction
  - `IdempotencyKey` string: 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 `200`

- object
  - `Success` boolean, required: True if the request was successful, false if it failed
  - `ErrorMessage` string, required: Contains a description of the error if the request failed
  - `TransactionID` integer, required: The unique ID for the hold transaction

---

[API](https://skmtc.dev/vopay/apis/transaction-management.md) - [All operations](https://skmtc.dev/vopay/apis/transaction-management/llms.txt) - [OpenAPI document](https://skmtc.dev/vopay/apis/transaction-management/revisions/915d994897b5?raw)