Place a hold

Place an indefinite hold on funds in a customer's account. Can be reversed by calling /account/releaseHold.

🚧Warning

Use of this endpoint requires approval from Q2 and your bank of record.

Error Codes

Click to expand
CodeMessage (en-US)Notes
1-60000Any "Common Error Code" may occur.See Common Error Codes
61400Program is not authorized to use this endpoint. Please contact your relationship manager for details
61401Missing required parameter 0
61402HoldAmount must be greater than 0.
61403Invalid AccountId 0.
61404Invalid type 0. Please refer to API documentation for valid typesCan only place a hold on checking, savings, business checking, and business savings accounts
61405Cannot place hold on an account that already has an Account Hold pending.
195131expirationDate must be future dated.
195149Incorrect Date Time format. Please refer to API Documentation
Body Params
int32
required
≥ 1
int32
required
≥ 1
number
required

The dollar amount of funds to place on hold

string
required
length ≤ 255

Free-form description for why the hold is being placed

date-time

The hold will expire shortly afer midnight (in the Bank of Record's timezone) on the date provided. Note: The time provided must be midnight (00:00:00.000)

Responses

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json