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

# GHS Disbursement Query

<div class="flex flex-col gap-4">
  <div class="api-section-heading flex flex-col gap-y-4 w-full">
    <div class="flex items-baseline border-b pb-2.5 border-gray-100 dark:border-gray-800 w-full">
      <h4 class="api-section-heading-title flex-1 mb-0">Secret Key & Private Key (Generate Signature)</h4>
    </div>

    <div />
  </div>

  <input id="secret-key" placeholder="Secret Key" class="px-3 py-2 border rounded-md" />

  <input id="private-key" placeholder="Private Key" class="px-3 py-2 border rounded-md" />
</div>

## Related Topics

* [Ghana Payment API](/docs/en/api/version2/Ghana)
* [HaiPay API Reference Overview](/docs/en/api-reference/overview)
* [HaiPay Configuration and Signature Guide](/docs/en/guide/config_settings_and_signature_rules_guide)


## OpenAPI

````yaml docs/en/api-reference/ghs/ghs.openapi.json POST /ghs/pay/query
openapi: 3.0.1
info:
  title: Ghanaian Cedi API
  description: ''
  version: 1.0.0
servers:
  - url: https://uat-interface.haipay.asia
    description: Test environment
security: []
paths:
  /ghs/pay/query:
    post:
      summary: GHS Disbursement Query
      requestBody:
        $ref: '#/components/requestBodies/QueryRequest'
      responses:
        '200':
          $ref: '#/components/responses/PayQueryResponse'
components:
  requestBodies:
    QueryRequest:
      required: true
      content:
        application/json:
          schema:
            type: object
            properties:
              appId:
                type: integer
                format: int64
                description: Business ID
              orderId:
                type: string
                description: Merchant order ID
              orderNo:
                type: string
                description: Platform order ID (optional)
              sign:
                type: string
                description: Signature
            required:
              - appId
              - orderId
              - sign
            additionalProperties: false
          example:
            appId: 1054
            orderId: GHSORDER001
            orderNo: '6023071013539074'
            sign: signature
  responses:
    PayQueryResponse:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PayQueryEnvelope'
  schemas:
    PayQueryEnvelope:
      allOf:
        - $ref: '#/components/schemas/EnvelopeBase'
        - type: object
          properties:
            data:
              $ref: '#/components/schemas/PayQueryData'
    EnvelopeBase:
      type: object
      properties:
        status:
          type: string
          description: 'API status: 1 normal, 0 exception'
        error:
          type: string
          description: Error code
        msg:
          type: string
          description: Message
    PayQueryData:
      type: object
      properties:
        orderId:
          type: string
        orderNo:
          type: string
        amount:
          type: string
        fee:
          type: string
        status:
          type: integer
          description: >-
            0 Not Started, 1 Disbursing, 2 Disbursement Successful (final), 3
            Disbursement Failed (final), -1 Exception Pending Confirmation
        payTime:
          type: string
          description: 'Success time in Ghana local time, format: yyyy-MM-dd HH:mm:ss'
        errorMsg:
          type: string
        certificateId:
          type: string
        sign:
          type: string

````