v1

latestOpenAPI 3.1.02026-07-241653251.3 MB
Customer Accounts (MTA)

Withdraw lock customer account

Locks withdrawals for an existing customer account

post/accounts/{zrn}/withdraw_lock

Path parameters

zrnstring required

The ZRN of the customer account to withdraw lock. The ZRN must be in the format: zrn:zh:eu:account:customer:<uuid>

Headers

X-SCX-SIGNEDstring required

HMAC-SHA256 signature of the request, base64-encoded. See the Authentication guide for the exact signing formula.

X-SCX-TIMESTAMPstring required
Example:1678901234

Current Unix timestamp in seconds. Must be within 60 seconds of server time or the request is rejected.

Request body

WithdrawLockCustomerAccountBody required

Request body for withdraw-locking a customer account. Withdraw-locking an account prevents any new withdrawal requests from being created on the account, but does not impact the ability to create trades or deposits. This is typically used as a precautionary measure when suspicious activity is detected on an account, in order to prevent potential funds outflows while an investigation is conducted.

Response

Request to withdraw-lock the customer account accepted. The withdraw lock is applied asynchronously; clients should listen for the customer_account_status_changed webhook event to observe the new state.

object required

Empty JSON object.