> ## 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 Balance

> Retrieve the payment account balance for the merchant.

## Overview

This page documents the `GET /v1/pay/balance/query` query balance endpoint. The full schema, parameters, and examples are rendered from the linked OpenAPI definition above.

## Notes

* Authentication uses the standard GatePay signed headers.
* This page documents the standard merchant endpoint.
* 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/common-openapi.json GET /v1/pay/balance/query
openapi: 3.1.0
info:
  title: GatePay Common API
  description: GatePay Common APIs - Balance and Fee queries
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://openplatform.gateapi.io
security: []
paths:
  /v1/pay/balance/query:
    get:
      summary: Check account balance
      description: Retrieve the payment account balance for the merchant.
      operationId: balanceQuery
      parameters:
        - $ref: '#/components/parameters/X-GatePay-Certificate-ClientId'
        - $ref: '#/components/parameters/X-GatePay-Signature'
        - $ref: '#/components/parameters/X-GatePay-Timestamp'
        - $ref: '#/components/parameters/X-GatePay-Nonce'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BalanceQueryResponse'
              examples:
                successResponse:
                  summary: Success Response
                  value:
                    status: SUCCESS
                    code: '000000'
                    errorMessage: ''
                    data:
                      balance_list:
                        - currency: DOGE
                          available: '1843.32095'
                        - currency: FORG
                          available: '3.02'
components:
  parameters:
    X-GatePay-Certificate-ClientId:
      name: X-GatePay-Certificate-ClientId
      in: header
      required: true
      description: Merchant client ID
      schema:
        type: string
        example: 4186d0c6-6a35-55a9-8dc6-5312769dbff8
    X-GatePay-Signature:
      name: X-GatePay-Signature
      in: header
      required: true
      description: Signature
      schema:
        type: string
        example: 672d5650dcc9bb22ebf25fa16c28d03c0e159d742a9176d4340a5da326d75dc8
    X-GatePay-Timestamp:
      name: X-GatePay-Timestamp
      in: header
      required: true
      description: Timestamp (milliseconds)
      schema:
        type: string
        example: '1672905655498'
    X-GatePay-Nonce:
      name: X-GatePay-Nonce
      in: header
      required: true
      description: Nonce
      schema:
        type: string
        example: '9578'
  schemas:
    BalanceQueryResponse:
      type: object
      properties:
        status:
          type: string
          description: SUCCESS or FAIL
          enum:
            - SUCCESS
            - FAIL
        code:
          type: string
          description: Error code
        errorMessage:
          type: string
          description: Error message
        data:
          type: object
          properties:
            balance_list:
              type: array
              items:
                $ref: '#/components/schemas/BalanceItem'
              description: List of balances per currency
    BalanceItem:
      type: object
      properties:
        currency:
          type: string
          description: Currency
        available:
          type: string
          description: >-
            Balance of the currency in the merchant's spot account, truncated to
            6 decimal places

````