---
title: "Create Hold"
method: POST
path: "/createHold"
tags: ["Transactions"]
---

# Create Hold

`POST /createHold`

Use the Create Hold endpoint to create a hold (reserve) on an amount of funds for a specified payment, or to create a hold on an account in general. This endpoint supports remote deposit capture (RDC).

To create a hold on a specific payment you must pass `amount` and `pmtId`. The default hold limit is 1 000 000. You can override this limit with the MXHLD program parameter.

To create a hold on an account, your program parameters (THOLD) must specify that an account hold is valid for the `holdType` parameter.

This endpoint does not create authorization holds on an account for card-association transactions &mdash; such holds are created automatically when an authorization request is approved.

## Response `default`

- object
  - `status_code` integer, nullable, required — The response status code. May return a string for some statuses.
  - `status` string, nullable, required — The condition of a process or response
  - `processing_time` number, float, nullable, required — The time elapsed in processing the transaction
  - `echo` object, nullable, required — A structure that contains transaction ID information
    - `transaction_id` string, nullable, required — An ID that represents an API transaction
    - `provider_timestamp` string, date-time, nullable, required — Store a related timestamp for reporting and troubleshooting purposes
    - `provider_transaction_id` string, nullable, required — Secondary transaction identifier (generated by a provider)
  - `system_timestamp` string, date-time, nullable, required — A system generated timestamp
  - `rtoken` string, nullable, required — A system-generated ID used for tracking
  - `errors` string[] — A list of errors generated while the request was processed
  - `response_data` object, nullable, required — A structure for the response data. It can be empty but usually will contain information.
    - `new_balance` number, required — The balance on the account after the transaction
    - `hold_id` integer, required — The ID associated with the hold

---

[API](https://skmtc.net/galileo-ft/apis/program-api.md) · [All operations](https://skmtc.net/galileo-ft/apis/program-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/galileo-ft/program-api/versions/bcd728f97a18/schema)
