Place a hold

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


Use of this route requires approval from Q2 and your bank partner.

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 savings accounts
61405Cannot place hold on an account that already has an Account Hold pending.
Click Try It! to start a request and see the response here!