v1

latestOpenAPI 3.1.02026-07-241653251.3 MB

Customer Accounts (MTA)

Update customer account

Updates prefunded and tier values for an existing customer account.

patch/accounts/{zrn}

Path parameters

zrnstring required

The ZRN of the customer account to add advisor to. 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

prefundedboolean required

Indicates whether the participant is using a prefunded model, or using the plaform float funding model to fund buy trades.

If true, the participant is prefunding their account and will be responsible for ensuring they have sufficient balance in their account to cover trades.
If false, the platform will fund trades from their float balance at zerohash, on behalf of the participant and settle at the end of the day.

tier'lite' | 'pro' | 'bronze' | 'silver' | 'gold' required

The account tier associated with the account with regards to the commission structure defined by the platform. The specific tier values available depend on the platform configuration.

Example request

{
  "tier": "pro"
}

Response

Customer account updated successfully. Updating an existing customer account is an asynchronous process that does several operations in the background after the response is returned. Customers are advised to listen to the customer_account_status_changed webhook event to be notified when the account is active and ready to use.

Example response

{
  "message": {
    "zrn": "zrn:zh:us:accounts:customer:c761fc96-5c44-40d4-8eb2-3fcd5d06754b",
    "participant_code": "PAR001",
    "platform_code": "PLAT01",
    "account_label": "custom-account-label",
    "account_group": "XYZ456",
    "type": "individual",
    "tier": "pro",
    "status": "open",
    "tenants": [
      "PAR002"
    ],
    "financial_advisors": [
      "PAR003"
    ]
  }
}