> ## 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 Address Payment Order > 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. ## Overview This page documents the `GET /v1/pay/address/query` endpoint. The full schema, parameters, and examples are rendered from the linked OpenAPI definition above. ## Notes * Provide at least one of `prepayId` or `merchantTradeNo`. * If both query parameters are provided, they must refer to the same address payment order. * The response is the current order snapshot for status and on-chain confirmation tracking, not the callback payload structure. * 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/address-payment-openapi.json GET /v1/pay/address/query openapi: 3.1.0 info: title: GatePay Address Payment API description: GatePay Address Payment APIs for crypto payment via blockchain address. version: 1.0.0 servers: - url: https://openplatform.gateapi.io security: [] paths: /v1/pay/address/query: get: summary: Query Order description: >- 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. 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' - name: prepayId in: query required: false description: >- Prepay order ID for address payment; use with merchantTradeNo as either-or, and provide at least one schema: type: string - name: merchantTradeNo in: query required: false description: >- Merchant system transaction number; use with prepayId as either-or, and provide at least one schema: type: string responses: '200': description: SUCCESS content: application/json: schema: allOf: - $ref: '#/components/schemas/ApiResponse' - type: object properties: data: $ref: '#/components/schemas/AddressQueryOrderData' description: Address payment order details example: status: SUCCESS code: '000000' errorMessage: '' data: prepayId: '1661239048576446' merchantId: 10002 merchantTradeNo: '43959345943769874395' transactionId: '347827943294834379' goodsName: abc fromAddress: '' currency: BTC orderAmount: '9.88' payCurrency: USDT payAmount: '197600' surchargeAmount: '' fiatCurrency: '' fiatAmount: '' fiatRate: '' rate: '20000' status: PENDING createTime: 1663657128148 expireTime: 1664089128000 transactTime: 1663829928000 order_name: orderName totalFeeAmount: '0' totalSettleAmount: '' payDetails: [] transaction_info: done_amount: '10.11' done_amount_total: '10.11' confirming_list: - amount: '0.35' confirm: 3 - amount: '0.65' confirm: 4 done_tx_item_list: - chain: BSC address: '0x5E86088F084dD253fBd6d5ad955af6f53EFC8073' fullCurrType: USDT_BSC amount: '10.11' txId: D1758212402891 utcCreateTime: '2025-09-18 08:20:03' utcUpdateTime: '2025-09-18 08:20:03' fromAddress: LHDwcMPVPXXvrmSlRVeEcxsLUCvtThHLa confirming_tx_item_list: - chain: BSC address: '0x5E86088F084dD253fBd6d5ad955af6f53EFC8022' fullCurrType: USDT_BSC amount: '10.11' txId: D1758212402811 utcCreateTime: '2025-09-18 08:20:03' utcUpdateTime: '2025-09-18 08:20:03' fromAddress: LHDwcMPVPXXvrmSlRVeEcxsLUCvtThHLa channelId: '123456' chain: ETN address: '0x67C30f439D7734f393c2F4a587B198b8F4086Ccb' components: parameters: X-GatePay-Certificate-ClientId: name: X-GatePay-Certificate-ClientId in: header required: true description: Merchant client ID, obtained from GatePay platform schema: type: string X-GatePay-Signature: name: X-GatePay-Signature in: header required: true description: HMAC-SHA256 signature for request validation schema: type: string X-GatePay-Timestamp: name: X-GatePay-Timestamp in: header required: true description: >- Timestamp in milliseconds, must not differ from server time by more than 5 minutes schema: type: string X-GatePay-Nonce: name: X-GatePay-Nonce in: header required: true description: Random nonce for replay attack prevention schema: type: string schemas: ApiResponse: type: object properties: status: type: string description: Payment status code: type: string description: Error code errorMessage: type: string description: Error message AddressQueryOrderData: type: object description: Address payment order details in the response body field `data` properties: prepayId: type: string description: Payment order ID merchantId: type: integer format: int64 description: Gate UID used to apply for a merchant account merchantTradeNo: type: string description: Merchant system transaction number transactionId: type: string description: Transaction ID goodsName: type: string description: Product name provided by the merchant when creating the order currency: type: string description: Currency of the order orderAmount: type: string description: Amount of the order surchargeAmount: type: string description: Amount of the surcharge toleranceAmount: type: string description: >- 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: type: string description: After payment is completed, the remaining payment amount fiatCurrency: type: string description: Fiat order currency. fiatAmount: type: string description: Fiat order amount. fiatRate: type: string description: Fiat rate. payCurrency: type: string description: >- Currency that the user actually paid, which is the same as the order currency in non-flash payment orders payAmount: type: string description: >- Payment amount field; interpret it together with the order mode and related amount fields rate: type: string description: >- Exchange rate between the order currency and the user's payment currency, for example, 1 BTC for 20,000 USDT status: type: string description: >- 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: type: integer format: int64 description: Order creation time expireTime: type: integer format: int64 description: Order expiration time transactTime: type: integer format: int64 description: Time when the order was traded within Gate order_name: type: string description: Order name totalFeeAmount: type: string description: >- Cumulative fees charged. May be empty or `0` when payment flows are not settled, unpaid, or in centralized-payment-only scenarios, etc. totalSettleAmount: type: string description: >- Cumulative settled amount. May be empty when payment flows are not settled, etc. payDetails: type: array description: Payment information items: $ref: '#/components/schemas/OrderQueryPayDetail' transaction_info: $ref: '#/components/schemas/ChainTransactionInfo' channelId: type: string description: Client Name chain: type: string description: Network name address: type: string description: Collection address fromAddress: type: string description: Payer address OrderQueryPayDetail: type: object description: >- Fee and settlement information for a single payment in the flow (payDetail). properties: transactionId: type: string description: Payment flow / transaction ID. payType: type: string description: 'Payment type: `GatePay` for Gate Pay, `Web3Pay` for Web3 payment.' payTime: type: string description: Payment time. payAmount: type: string description: Payment amount. payCurrency: type: string description: Payment currency feeAmount: type: string description: Fee amount. settleAmount: type: string description: Settled amount. settlementStatus: type: string description: 'Settlement status: `pending` not settled, `done` settled.' ChainTransactionInfo: type: object properties: done_amount: type: string description: Total confirmed on-chain payment amount within the validity period done_amount_total: type: string description: >- Total confirmed on-chain payment amount within and outside the validity period confirming_list: type: array description: >- List of payments pending on-chain confirmation within the validity period items: $ref: '#/components/schemas/ConfirmItem' done_tx_item_list: type: array description: List of confirmed payments within and outside the validity period items: $ref: '#/components/schemas/TxItem_Query' confirming_tx_item_list: type: array description: >- List of payments pending confirmation within and outside the validity period items: $ref: '#/components/schemas/TxItem_Query' ConfirmItem: type: object properties: amount: type: string description: Payment amount in the payment record confirm: type: integer description: Number of confirmations TxItem_Query: type: object properties: chain: type: string description: Name of the blockchain. address: type: string description: The address. FromAddress: type: string description: from address fullCurrType: type: string description: The name of the chain including network information. amount: type: string description: The payment amount. txId: type: string description: The transaction ID on the blockchain. utcCreateTime: type: string description: >- The UTC timestamp when the payment record was detected on the blockchain, for example, 2023-01-07 14:04:02. utcUpdateTime: type: string description: >- The UTC timestamp when the payment record status was updated on the blockchain, for example, 2023-01-07 14:04:02. ````