---
title: "Checkout Order Details"
method: GET
path: "/v2/pay/order/query"
---

# Checkout Order Details

`GET /v2/pay/order/query`

Query checkout order details by prepay ID or merchant trade number. Either prepayId or merchantTradeNo is required.

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

Order details retrieved successfully

- object
  - `status` string — Payment status
  - `code` string — Error code
  - `errorMessage` string — Error message
  - `data` OrderQueryBizData
    - `prepayId` string — Pre-order ID
    - `merchantId` integer — Merchant ID
    - `merchantTradeNo` string — Merchant order number
    - `transactionId` string — Transaction ID
    - `goodsName` string — Goods name
    - `currency` string — Order currency
    - `orderAmount` string — Order amount
    - `surchargeAmount` string — Surcharge amount
    - `toleranceAmount` string — Tolerance amount
    - `underpaidAmount` string — Underpaid amount
    - `fiatCurrency` string — Fiat currency
    - `fiatAmount` string — Fiat amount
    - `fiatRate` string — Fiat exchange rate
    - `fiatPayType` 'card' | 'google_pay' | 'apple_pay' | 'link' — Payment method used for fiat payment
    - `status` 'PENDING' | 'PROCESS' | 'PAID' | 'EXPIRED' | 'CANCELLED' | 'ERROR' | 'BLOCK' | 'AUDITING' | 'REJECTED' | 'AUDIT_ERROR' — Order status
    - `createTime` integer — Create time in milliseconds
    - `expireTime` integer — Expiration time in milliseconds
    - `transactTime` integer — Transaction time in milliseconds
    - `order_name` string — Order name
    - `pay_currency` string — Payment currency
    - `pay_amount` string — Payment amount; for centralized payment orders, this field represents the amount that should be paid and should be interpreted together with orderAmount
    - `expectCurrency` string — Expected currency
    - `actualCurrency` string — Actual currency
    - `actualAmount` string — Actual amount
    - `rate` string — Exchange rate
    - `channelId` string — Channel ID
    - `address` string — Deposit address
    - `appLogo` string — App logo URL
    - `appName` string — App name
    - `chain` string — Chain name
    - `channel_type` string — Channel type
    - `fromAddress` string — Payer address
    - `fullCurrType` string — Full currency type
    - `inUsdt` string — Equivalent USDT amount
    - `location` string — Payment URL
    - `merchantName` string — Merchant name
    - `pay_account` string — Payment account
    - `qrcode` string — QR code content
    - `returnUrl` string — Return URL
    - `scheme` string — URL scheme
    - `showChainNameEn` string — Chain name in English
    - `totalFee` string — Total fee
    - `txHash` string — Transaction hash
    - `transaction_info` TransactionInfo
      - `done_amount` string — Amount already confirmed
      - `confirming_list` ConfirmingItem[] — List of confirming transactions
        - `amount` string — Amount
        - `confirm` integer — Confirmation count
        - `txId` string — On-chain transaction hash
        - `confirmingTime` integer — On-chain transaction sync start time in milliseconds
        - `complianceStatus` string — Compliance verification status: `ACCEPTED` approved, `PEND` pending, `REJECTED` rejected.
      - `done_list` DoneItem[] — List of confirmed on-chain transactions
        - `txId` string — On-chain transaction hash
        - `amount` string — Amount
        - `doneTime` integer — On-chain transaction confirmation time in milliseconds
    - `whiteBrandInfo` WhiteBrandInfo
      - `logoUrl` string — Logo URL
      - `brand` string — Brand name
      - `payWays` string[] — Payment methods
    - `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.

---

[API](https://skmtc.net/gate/apis/gatepay-api-2.md) · [All operations](https://skmtc.net/gate/apis/gatepay-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/gate/gatepay-api-2/versions/db3687218ec6/schema)