---
title: "Query Order"
method: GET
path: "/v1/pay/address/query"
---

# Query Order

`GET /v1/pay/address/query`

Check the details of the new address payment order, the specified parameters must correspond to the address payment order, otherwise an error message will be returned.

## Query parameters

- `prepayId` string
- `merchantTradeNo` string

## Headers

- `X-GatePay-Certificate-ClientId` string, required
- `X-GatePay-Signature` string, required
- `X-GatePay-Timestamp` string, required
- `X-GatePay-Nonce` string, required

## Response `200`

SUCCESS

- object
  - `status` string — Payment status
  - `code` string — Error code
  - `errorMessage` string — Error message
  - `data` AddressQueryOrderData — Address payment order details in the response body field `data`
    - `prepayId` string — Payment order ID
    - `merchantId` integer — Gate UID used to apply for a merchant account
    - `merchantTradeNo` string — Merchant system transaction number
    - `transactionId` string — Transaction ID
    - `goodsName` string — Product name provided by the merchant when creating the order
    - `currency` string — Currency of the order
    - `orderAmount` string — Amount of the order
    - `surchargeAmount` string — Amount of the surcharge
    - `toleranceAmount` string — Tolerance Amount：If the remaining unpaid amount is less than or equal to the configured tolerance amount, the order will be automatically marked as Paid, with no further payment required.
    - `underpaidAmount` string — After payment is completed, the remaining payment amount
    - `fiatCurrency` string — Fiat order currency.
    - `fiatAmount` string — Fiat order amount.
    - `fiatRate` string — Fiat rate.
    - `payCurrency` string — Currency that the user actually paid, which is the same as the order currency in non-flash payment orders
    - `payAmount` string — Payment amount field; interpret it together with the order mode and related amount fields
    - `rate` string — Exchange rate between the order currency and the user's payment currency, for example, 1 BTC for 20,000 USDT
    - `status` string — Order status, PENDING for processing, PROCESS for payment enough but not yet confirmed on the blockchain within the order validity period, PAID for payment success, EXPIRED for order expired
    - `createTime` integer — Order creation time
    - `expireTime` integer — Order expiration time
    - `transactTime` integer — Time when the order was traded within Gate
    - `order_name` string — Order name
    - `totalFeeAmount` string — Cumulative fees charged. May be empty or `0` when payment flows are not settled, unpaid, or in centralized-payment-only scenarios, etc.
    - `totalInstitutionFeeAmount` string — Cumulative institution revenue share.
    - `totalSettleAmount` string — Cumulative settled amount. May be empty when payment flows are not settled, etc.
    - `payDetails` OrderQueryPayDetail[] — Payment information
      - `transactionId` string — Payment flow / transaction ID.
      - `payType` string — Payment type: `GatePay` for Gate Pay, `Web3Pay` for Web3 payment.
      - `payTime` string — Payment time.
      - `payAmount` string — Payment amount.
      - `payCurrency` string — Payment currency
      - `feeAmount` string — Fee amount.
      - `institutionFeeAmount` string — Institution revenue share.
      - `settleAmount` string — Settled amount.
      - `settlementStatus` string — Settlement status: `pending` not settled, `done` settled.
      - `txId` string — On-chain transaction ID
    - `transaction_info` ChainTransactionInfo
      - `done_amount` string — Total confirmed on-chain payment amount within the validity period
      - `done_amount_total` string — Total confirmed on-chain payment amount within and outside the validity period
      - `confirming_list` ConfirmItem[] — List of payments pending on-chain confirmation within the validity period
        - `amount` string — Payment amount in the payment record
        - `confirm` integer — Number of confirmations
      - `done_tx_item_list` TxItemQuery[] — List of confirmed payments within and outside the validity period
        - `chain` string — Name of the blockchain.
        - `address` string — The address.
        - `FromAddress` string — from address
        - `fullCurrType` string — The name of the chain including network information.
        - `amount` string — The payment amount.
        - `txId` string — The transaction ID on the blockchain.
        - `utcCreateTime` string — The UTC timestamp when the payment record was detected on the blockchain, for example, 2023-01-07 14:04:02.
        - `utcUpdateTime` string — The UTC timestamp when the payment record status was updated on the blockchain, for example, 2023-01-07 14:04:02.
        - `utcConfirmingTime` string — UTC timestamp when on-chain transaction sync started, for example, 2023-01-07 14:04:02.
        - `complianceStatus` string — Compliance verification status: `ACCEPTED` approved, `PEND` pending, `REJECTED` rejected.
        - `utcDoneTime` string — UTC timestamp when the on-chain transaction was confirmed, for example, 2023-01-07 14:04:02.
      - `confirming_tx_item_list` TxItemQuery[] — List of payments pending confirmation within and outside the validity period
        - `chain` string — Name of the blockchain.
        - `address` string — The address.
        - `FromAddress` string — from address
        - `fullCurrType` string — The name of the chain including network information.
        - `amount` string — The payment amount.
        - `txId` string — The transaction ID on the blockchain.
        - `utcCreateTime` string — The UTC timestamp when the payment record was detected on the blockchain, for example, 2023-01-07 14:04:02.
        - `utcUpdateTime` string — The UTC timestamp when the payment record status was updated on the blockchain, for example, 2023-01-07 14:04:02.
        - `utcConfirmingTime` string — UTC timestamp when on-chain transaction sync started, for example, 2023-01-07 14:04:02.
        - `complianceStatus` string — Compliance verification status: `ACCEPTED` approved, `PEND` pending, `REJECTED` rejected.
        - `utcDoneTime` string — UTC timestamp when the on-chain transaction was confirmed, for example, 2023-01-07 14:04:02.
    - `channelId` string — Client Name
    - `chain` string — Network name
    - `address` string — Address
    - `fromAddress` string — Payer address

## Changes

- **2026-08-12** `e66c448f796e` — 1 info
  - added the optional property `allOf[subschema #2]/data/payDetails/items/txId` to the response with the `200` status

[Change history](https://skmtc.dev/gate/apis/gatepay-address-payment-api/changes/v1/pay/address/query/get.md)

---

[API](https://skmtc.dev/gate/apis/gatepay-address-payment-api.md) · [All operations](https://skmtc.dev/gate/apis/gatepay-address-payment-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/gate/gatepay-address-payment-api/revisions/e66c448f796e/schema)