Query Wealth Service Status
Query the wealth management status of a sub-account. X-GatePay-On-Behalf-Of identifies the delegated institution account ID.
Overview
This page documents theGET /merchant/open/institution/v1/wealth/query endpoint. The full schema, parameters, and examples are rendered from the linked OpenAPI definition above.
Notes
- Authentication uses the standard GatePay signed headers.
- This dedicated institution endpoint requires
X-GatePay-On-Behalf-Of, which identifies the delegated institution account ID. - In the response,
statusindicates the wealth service state:SIGNenabled,CANCELdisabled. - If the sub-account has never enabled wealth management,
statusisCANCELandenabledandupdatedare omitted. - For shared signing rules, see /api-reference/version/100/en/common/securityAndSignature.
Headers
The clientId assigned when the merchant registers an application in the Gate merchant console.
"4186d0c6-6a35-55a9-8dc6-5312769dbff8"
Millisecond timestamp; the difference from server time must not exceed 30 seconds.
"1672905655498"
Random string. Must comply with HTTP header rules; recommended length is within 32 characters, composed of digits and letters.
"9578"
Request signature. GatePay uses this signature to verify whether the request is valid.
Required delegated subject header. Provide the initiating account ID for this transaction. It can be an institution account ID or a sub-account ID.

