Skip to main content
GET
Query wealth service status

Overview

This page documents the GET /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, status indicates the wealth service state: SIGN enabled, CANCEL disabled.
  • If the sub-account has never enabled wealth management, status is CANCEL and enabled and updated are omitted.
  • For shared signing rules, see /api-reference/version/100/en/common/securityAndSignature.

Headers

X-GatePay-Certificate-ClientId
string
required

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

Example:

"4186d0c6-6a35-55a9-8dc6-5312769dbff8"

X-GatePay-Timestamp
string
required

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

Example:

"1672905655498"

X-GatePay-Nonce
string
required

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

Example:

"9578"

X-GatePay-Signature
string
required

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

X-GatePay-On-Behalf-Of
string
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.

Response

200 - application/json

Success

status
string
Example:

"SUCCESS"

code
string
Example:

"000000"

errorMessage
string
data
object