Contact Us
API Reference

Lock an external account

post
https://sandbox-api.helix.q2.com/externalAccount/lock

Lock an external account by the Helix-assigned externalAccountId.

🚧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
62501Invalid external account id '0'.
62509External account is already locked.
62510Unable to lock an external account that is not in a Verified status.
62618requestingCustomerId '{request.requestingCustomerId}' does not have permission to manage external accounts for customerId '{request.customerId}'
Body Params
int32
required
≥ 1
int32
required
≥ 1
string
length ≤ 255
int32
≥ 1

The Helix-assigned unique ID for the individual customer requesting to lock the external account. Only used when an individual is locking an external account on behalf of a business.

Responses

Updated 2 days ago

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

Updated 2 days ago