OpenApi SpecContact Us
API Reference

Lock an account

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

Lock an account. Most locks can be reversed by calling /account/unlock. Please check the /account/unlock documentation to see which lock scenarios can be subsequently unlocked.

Will apply a lockTypeCode of CST or SYS on success and the account will be locked, meaning no funds transfers can take place.

Body Params
int32
required
≥ 1
int32
required
≥ 1
string
enum
required
  • CST: Customer Locked
  • SYS: System Locked
Allowed:
string
enum
required
  • UNK: Unknown
  • FRD: Fraud investigation
  • ADM: Administrative
  • TMP: Temporary
  • FRZ: Freeze
  • SUS: Suspected fraud
  • CO: Credits only
  • RTN: Return risk
  • REC: Recovery
  • DED: Deceased
  • DOR: Dormant
Responses

Updated 5 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 5 days ago