> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gate.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 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 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](/api-reference/version/100/en/common/securityAndSignature).


## OpenAPI

````yaml api-reference/version/100/en/openapi/institutional-openapi.json GET /merchant/open/institution/v1/wealth/query
openapi: 3.1.0
info:
  title: GatePay Institutional API
  description: >-
    Gate Pay Institution API documentation. Create and manage sub-accounts,
    finance, orders, payout, transfer, and more.
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://openplatform.gateapi.io
security: []
paths:
  /merchant/open/institution/v1/wealth/query:
    get:
      summary: Query wealth service status
      description: >-
        Query the wealth management status of a sub-account.
        `X-GatePay-On-Behalf-Of` identifies the delegated institution account
        ID.
      parameters:
        - $ref: '#/components/parameters/X-GatePay-Certificate-ClientId'
        - $ref: '#/components/parameters/X-GatePay-Timestamp'
        - $ref: '#/components/parameters/X-GatePay-Nonce'
        - $ref: '#/components/parameters/X-GatePay-Signature'
        - $ref: '#/components/parameters/X-GatePay-On-Behalf-Of'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WealthQueryResponseWrapper'
              examples:
                success:
                  summary: Success response
                  value:
                    status: SUCCESS
                    code: '000000'
                    errorMessage: ''
                    data:
                      status: SIGN
                      enabled: 1772516898675
                      updated: 1772519811822
                      account_id: '2124766106'
components:
  parameters:
    X-GatePay-Certificate-ClientId:
      name: X-GatePay-Certificate-ClientId
      in: header
      required: true
      description: >-
        The clientId assigned when the merchant registers an application in the
        Gate merchant console.
      schema:
        type: string
        example: 4186d0c6-6a35-55a9-8dc6-5312769dbff8
    X-GatePay-Timestamp:
      name: X-GatePay-Timestamp
      in: header
      required: true
      description: >-
        Millisecond timestamp; the difference from server time must not exceed
        30 seconds.
      schema:
        type: string
        example: '1672905655498'
    X-GatePay-Nonce:
      name: X-GatePay-Nonce
      in: header
      required: true
      description: >-
        Random string. Must comply with HTTP header rules; recommended length is
        within 32 characters, composed of digits and letters.
      schema:
        type: string
        example: '9578'
    X-GatePay-Signature:
      name: X-GatePay-Signature
      in: header
      required: true
      description: >-
        Request signature. GatePay uses this signature to verify whether the
        request is valid.
      schema:
        type: string
    X-GatePay-On-Behalf-Of:
      name: X-GatePay-On-Behalf-Of
      in: header
      required: true
      schema:
        type: string
      description: >-
        Required delegated subject header. Provide the initiating account ID for
        this transaction. It can be an institution account ID or a sub-account
        ID.
  schemas:
    WealthQueryResponseWrapper:
      type: object
      properties:
        status:
          type: string
          example: SUCCESS
        code:
          type: string
          example: '000000'
        errorMessage:
          type: string
        data:
          $ref: '#/components/schemas/WealthQueryResponse'
    WealthQueryResponse:
      type: object
      properties:
        account_id:
          type: string
          description: Sub-account ID
        status:
          type: string
          description: 'Wealth status: CANCEL disabled; SIGN enabled'
          enum:
            - CANCEL
            - SIGN
        enabled:
          type: integer
          format: int64
          description: Enable time (milliseconds)
        updated:
          type: integer
          format: int64
          description: Last update time (milliseconds)

````