Create Hold

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 — such holds are created automatically when an authorization request is approved.

Status codes

See Global Response Statuses for status codes that are common across endpoints.

The table below lists status codes that apply to this specific endpoint.

Status codeDescription
539-01Holds are not enabled for this product/program. Please contact client support for more information.
539-02Provided XID does not map to a valid balance in our system
539-03Provided expiration date needs to be in the correct format (YYYY-MM-DD HH:MM:SS) and needs to be in the future
539-04Provided payment id is invalid
539-05No payment id was provided and the provided account hold type is missing or invalid
539-06Amount must be equal to or less than the payment minus any other holds that have already been placed
539-07An unknown error occurred while creating the hold. Please contact client support if this error persists.
539-08Amount must be equal to or less than the account balance. Set PRVNB to enable this status.
Click Try It! to start a request and see the response here!