v2

latestOpenAPI 3.1.0MIT2026-08-0512106137.3 KB

Update wealth service status

Enable or disable wealth management for a sub-account. X-GatePay-On-Behalf-Of identifies the delegated institution account ID.

post/merchant/open/institution/v1/wealth/action

Headers

X-GatePay-Certificate-ClientIdstring required
Example:4186d0c6-6a35-55a9-8dc6-5312769dbff8

The clientId assigned when the merchant registers an application in the Gate merchant console.

X-GatePay-Timestampstring required
Example:1672905655498

Millisecond timestamp; the difference from server time must not exceed 30 seconds.

X-GatePay-Noncestring required
Example:9578

Random string. Must comply with HTTP header rules; recommended length is within 32 characters, composed of digits and letters.

X-GatePay-Signaturestring required

Request signature. GatePay uses this signature to verify whether the request is valid.

X-GatePay-On-Behalf-Ofstring required

Required delegated subject header. Provide the initiating account ID for this transaction. It can be an institution account ID or a sub-account ID.

Request body

action'CANCEL' | 'SIGN' required

Action type: CANCEL to disable; SIGN to enable

Example request

{
  "action": "SIGN"
}

Response

Success

statusstring
codestring
errorMessagestring

Example response

{
  "status": "SUCCESS",
  "code": "000000"
}