Sign in

v1

latestOpenAPI 3.1.02026-07-241653251.3 MB
CLOB

Update CLOB account

Updates prefunded and/or account_tier attributes of an account on the CLOB.

patch/clob/accounts

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

OR

Example request

{
  "account_label": "general",
  "prefunded": true,
  "account_tier": "silver",
  "participant_code": "CUST01"
}

Response

CLOB account update accepted. Returns the updated attributes of the account.

account_labelstring

The platform-dictated account label for the account.

prefundedboolean

Indicates whether the participant has prefunded their account or not.

account_tier'lite' | 'pro' | 'bronze' | 'silver' | 'gold'

The commission tier associated with the account, defined by the platform.

Example response

{
  "account_label": "general",
  "prefunded": true,
  "account_tier": "silver"
}