> ## 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 Payment Order List

> Query payment (collection) orders by time range with pagination. Supports filtering by order type, status, payment method, and other criteria.

## Overview

This page documents the **Query Payment Order List** endpoint. The full schema, parameters, and examples are rendered from the linked OpenAPI definition above.

## Notes

* Authentication uses the standard GatePay signed headers.
* Commonly used for end-of-day reconciliation and reporting sync. Pair with payment callbacks; list queries serve as a fallback data source.
* For signing rules, see [Security and Signature](/api-reference/version/100/en/common/securityAndSignature). For integration steps, see [Reconciliation](/essentials/version/100/en/common/reconciliation).


## OpenAPI

````yaml /api-reference/version/100/en/openapi/reconciliation-openapi.json GET /payment/open/v1/pay/order/list
openapi: 3.1.0
info:
  title: GatePay Reconciliation API
  version: 1.0.0
  description: OpenAPI specification for GatePay reconciliation order list APIs.
servers:
  - url: https://openplatform.gateapi.io
    description: Production
security: []
paths:
  /payment/open/v1/pay/order/list:
    get:
      tags:
        - reconciliation
      summary: Query payment order list
      description: >-
        Query payment (collection) orders by time range with pagination.
        Supports filtering by order type, status, payment method, and other
        criteria.
      operationId: listReconciliationPayOrders
      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'
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PayOrderListRequest'
      responses:
        '200':
          description: Payment order list
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReconciliationPayOrderListResponse'
              examples:
                success:
                  summary: Successful response
                  value:
                    status: SUCCESS
                    code: '000000'
                    label: ''
                    errorMessage: ''
                    data:
                      Total: 1
                      orderList:
                        - refund_info:
                            canRefund: false
                            refundSuccessAmount: '0'
                            refundProcessAmount: '0'
                            refundSuccessTimes: 0
                            refundFailTimes: 0
                            refundCurrency: USDT
                            canNotRefundReason: ''
                            totalRequestAmount: '0'
                            totalRequestCurrency: USDT
                            existRefund: false
                          create_time: 1766470410668
                          pay_type: ''
                          is_refund: false
                          refund_amount: 0
                          refund_currency: ''
                          settleMerchantId: 10002
                          orderType: ''
                          merchantTradeNo: M202405290001
                          orderId: '63546113486749696'
                          goodsName: ''
                          orderCurrency: USDT
                          orderAmount: 100
                          payCurrency: USDT
                          payAmount: 100
                          surchargeAmount: 0
                          payableAmount: 100
                          receiveCurrency: USDT
                          receiveAmount: 100
                          addressPayAmount:
                            currency: USDT
                            inTerm: 0
                            outTerm: 0
                          generalizedStatus: PAY_SUCCESS
                          payChannel: gate
                          billType: 0
                          chain: ''
                          orderTime: 1766474310668
                          clientId: ''
                          channelId: '123456'
                          fromAddress: ''
                          settleCurrency: USDT
                          platFeeAmount: 0
                          merchantSettleAmount: 100
                          fiatCurrency: ''
                          fiatAmount: ''
                          fiatRate: ''
                          refundTime: 0
                          failReason: ''
                          buyer: ''
                          uid: ''
                          fundStatus: ''
                          newPayType: gate
                          address: ''
                          status: ''
                          institutionFeeAmount: 0
                          hashes: ''
                          originalOrderId: ''
                          originMerchantTradeNo: ''
components:
  parameters:
    X-GatePay-Certificate-ClientId:
      name: X-GatePay-Certificate-ClientId
      in: header
      required: true
      description: Application ClientId.
      schema:
        type: string
    X-GatePay-Signature:
      name: X-GatePay-Signature
      in: header
      required: true
      description: Request signature (HMAC-SHA512).
      schema:
        type: string
    X-GatePay-Timestamp:
      name: X-GatePay-Timestamp
      in: header
      required: true
      description: Request timestamp in UTC milliseconds.
      schema:
        type: string
    X-GatePay-Nonce:
      name: X-GatePay-Nonce
      in: header
      required: true
      description: Random nonce for replay protection.
      schema:
        type: string
  schemas:
    PayOrderListRequest:
      type: object
      description: Payment order list query filters (multipart form fields).
      properties:
        startTime:
          type: string
          description: Range start time in milliseconds.
        endTime:
          type: string
          description: Range end time in milliseconds.
        status:
          type: string
          description: |-
            Order status filter. Allowed values:

            - `PENDING` — Pending payment
            - `PAID` — Payment succeeded
            - `ERROR` — Payment failed
            - `PROCESS` — Payment in progress
            - `EXPIRED` — Expired
            - `CANCELLED` — Cancelled
            - `BLOCK` — Abnormal payment
          enum:
            - PENDING
            - PAID
            - ERROR
            - PROCESS
            - EXPIRED
            - CANCELLED
            - BLOCK
        payChannel:
          type: string
          description: |-
            Payment method filter. Allowed values:

            - `GatePay` — Gate Pay
            - `Web3Pay` — Web3 Pay
            - `FiatPay` — Fiat Pay
          enum:
            - GatePay
            - Web3Pay
            - FiatPay
        payType:
          type: string
          description: |-
            Transaction type filter. Allowed values:

            - `checkout_pt` — Checkout payment
            - `address_pt` — Address payment
            - `call_pt` — App invoke payment
            - `qrcode_pt` — QR code payment
            - `web_pt` — Web payment
            - `mini_pt` — GateLife payment
            - `payee_pt` — Static payee QR code
            - `agent_address_pt` — AI payment
            - `qrcode_ch` — Channel QR code payment
            - `bank_ch` — Bank transfer payment
            - `subscription_address_pt` — Subscription payment
            - `invoicing_pt` — Invoicing payment
          enum:
            - checkout_pt
            - address_pt
            - call_pt
            - qrcode_pt
            - web_pt
            - mini_pt
            - payee_pt
            - agent_address_pt
            - qrcode_ch
            - bank_ch
            - subscription_address_pt
            - invoicing_pt
        page:
          type: string
          description: Page number, starting from 1.
        count:
          type: string
          description: Number of records per page. Maximum 500.
      required:
        - startTime
        - endTime
    ReconciliationPayOrderListResponse:
      type: object
      properties:
        status:
          type: string
          description: API status. `SUCCESS` indicates success.
        code:
          type: string
          description: Business response code. `000000` indicates success.
        label:
          type: string
          description: Response label.
        errorMessage:
          type: string
          description: Error message when the request fails.
        data:
          $ref: '#/components/schemas/ReconciliationPayOrderListData'
    ReconciliationPayOrderListData:
      type: object
      properties:
        Total:
          type: integer
          format: int64
          description: Total number of matching orders.
        orderList:
          type: array
          description: Payment order list for the current page.
          items:
            $ref: '#/components/schemas/ReconciliationPayOrderItem'
    ReconciliationPayOrderItem:
      type: object
      description: Payment order list item.
      properties:
        refund_info:
          $ref: '#/components/schemas/ReconciliationPayOrderRefundInfo'
        create_time:
          type: integer
          format: int64
          description: Order creation time in milliseconds.
        pay_type:
          type: string
          description: Transaction type.
        is_refund:
          type: boolean
          description: Whether the order has a refund.
        refund_amount:
          type: number
          description: Refunded amount.
        refund_currency:
          type: string
          description: Refund currency.
        settleMerchantId:
          type: integer
          format: int64
          description: Settlement merchant ID.
        orderType:
          type: string
          description: Order type.
        merchantTradeNo:
          type: string
          description: Merchant order number.
        orderId:
          type: string
          description: GatePay order ID.
        goodsName:
          type: string
          description: Product name.
        orderCurrency:
          type: string
          description: Order currency.
        orderAmount:
          type: number
          description: Order amount.
        payCurrency:
          type: string
          description: Payment currency.
        payAmount:
          type: number
          description: Paid amount.
        surchargeAmount:
          type: number
          description: Surcharge / fee amount.
        payableAmount:
          type: number
          description: Payable amount.
        receiveCurrency:
          type: string
          description: Settlement receive currency.
        receiveAmount:
          type: number
          description: Settlement receive amount.
        addressPayAmount:
          $ref: '#/components/schemas/ReconciliationPayOrderAddressPayAmount'
        generalizedStatus:
          type: string
          description: Order status exposed to merchants.
        payChannel:
          type: string
          description: Payment method.
        billType:
          type: integer
          description: Bill type code.
        chain:
          type: string
          description: Blockchain network for address payments.
        orderTime:
          type: integer
          format: int64
          description: Last payment time in milliseconds.
        clientId:
          type: string
          description: Client ID.
        channelId:
          type: string
          description: Merchant channel ID.
        fromAddress:
          type: string
          description: Payer on-chain address.
        settleCurrency:
          type: string
          description: Settlement currency.
        platFeeAmount:
          type: number
          description: Platform fee amount.
        merchantSettleAmount:
          type: number
          description: Amount settled to the merchant.
        fiatCurrency:
          type: string
          description: Fiat currency for display conversion.
        fiatAmount:
          type: string
          description: Fiat amount for display conversion.
        fiatRate:
          type: string
          description: Fiat conversion rate.
        refundTime:
          type: integer
          format: int64
          description: Last refund time in milliseconds.
        failReason:
          type: string
          description: Failure reason for unsuccessful orders.
        buyer:
          type: string
          description: Buyer Gate UID or payer address.
        uid:
          type: string
          description: Buyer UID.
        fundStatus:
          type: string
          description: Fund status.
        newPayType:
          type: string
          description: 'Payment category: for example `web3`, `gate`, or `unknown`.'
        address:
          type: string
          description: Payment address.
        status:
          type: string
          description: Internal order status.
        institutionFeeAmount:
          type: number
          description: Institution fee amount.
        hashes:
          type: string
          description: On-chain transaction hashes for Web3 payments.
        originalOrderId:
          type: string
          description: Original linked order ID.
        originMerchantTradeNo:
          type: string
          description: Original merchant trade number.
    ReconciliationPayOrderRefundInfo:
      type: object
      description: Aggregated refund information for an order.
      properties:
        canRefund:
          type: boolean
          description: Whether the order can be refunded.
        refundSuccessAmount:
          type: string
          description: Total successfully refunded amount.
        refundProcessAmount:
          type: string
          description: Refund amount currently in process.
        refundSuccessTimes:
          type: integer
          description: Number of successful refunds.
        refundFailTimes:
          type: integer
          description: Number of failed refund attempts.
        refundCurrency:
          type: string
          description: Refund currency.
        canNotRefundReason:
          type: string
          description: Reason refund is not allowed, when applicable.
        totalRequestAmount:
          type: string
          description: Total requested refund amount.
        totalRequestCurrency:
          type: string
          description: Currency of total requested refund amount.
        existRefund:
          type: boolean
          description: Whether any refund exists for this order.
    ReconciliationPayOrderAddressPayAmount:
      type: object
      description: On-chain payment amount breakdown for address payments.
      properties:
        currency:
          type: string
          description: Currency.
        inTerm:
          type: number
          description: Amount paid within the validity window.
        outTerm:
          type: number
          description: Amount paid outside the validity window.

````