Merchants can use this API to query the status of a specific order on the PayEase platform by passing the requestId from the original payment request. This allows merchants to actively retrieve order information.
Note: The query API is limited to 200 requests per minute. Exceeding this limit will result in an error.
https://apis.5upay.com/onlinePay/query
| Name | Type& Length | Description | Required |
|---|---|---|---|
| merchantId | varchar(9) | Unique merchant ID assigned by PayEase. Can be found in the merchant dashboard. | M |
| requestId | varchar(50) | Order ID passed in the original Order Submission API request. | M |
| partnerId | varchar(9) | Unique service provider ID assigned by PayEase. Can be found in the merchant backend. | C |
| hmac | varchar(500) | Parameter signature generated by the merchant. Refer to the encryption guide for HMAC generation. | M |
Note: The values of the parameters above must not contain the following special characters: ' " & < > ( ) [space]
| Name | Description |
|---|---|
| merchantId | Same as request parameter. |
| requestId | Same as request parameter. |
| partnerId | Same as request parameter. |
| serialNumber | Transaction Serial Number |
| totalRefundCount | Total number of refund transactions for this order. |
| totalRefundAmount | Total amount refunded for this order. |
| orderCurrency | Default: CNY (Chinese Yuan). |
| orderAmount | Order amount. In cents. 1 Yuan = 100 cents. |
| status | Order status: INIT Initialized |
| CANCEL Canceled | |
| SUCCESS – Payment successful | |
| FAILED – Payment failed | |
| ERROR – System error | |
| completeDateTime | Date and time when the payment was completed. |
| clearingOrg | Clearing Institution: NUCC NetsUnion Clearing Corporation |
| UNION_PAY UnionPay | |
| paymentModeAlias | Payment Method: B2C Online Banking(Personal) |
| B2B – Online Banking (Corporate) | |
| UNION_SCANCODE_PAY – UnionPay QR Code Payment | |
| EXPRESS_PAY – Express Payment | |
| CREDIT_EXPRESS_PAY – Express Payment (Credit Card) | |
| DEBIT_EXPRESS_PAY – Express Payment (Debit Card) | |
| ALI_SCANCODE_PAY – Alipay QR Code Payment | |
| ALIPAY_OFFICIAL_PAY – Alipay Official Account Payment | |
| WEIXIN_SCANCODE_PAY – WeChat QR Code Payment | |
| WEIXIN_OFFICIAL_PAY – WeChat Official Account Payment | |
| MINIAPPS_WEIXIN_PAY – WeChat Mini Program Payment | |
| APPLE_PAY – Apple Pay | |
| ALIPAY_WAP_PAY – Alipay WAP Payment | |
| APP_ALIPAY – Alipay App Payment | |
| ALIPAY_B2C_PAY – Alipay B2C Payment | |
| MINIAPPS_ALI_PAY – Alipay Mini Program Payment | |
| SCANCODE-EQRCODE_PAY-ALI – Easy QR – Alipay | |
| SCANCODE-EQRCODE_PAY-WEIXIN – Easy QR – WeChat | |
| SCANCODE-EQRCODE_PAY-WEBOX – Easy QR – Webox | |
| SCANCODE-EQRCODE_PAY-UNION – Easy QR – UnionPay | |
| AGREEMENT_PAY – Agreement Payment | |
| WAP – UnionPay WAP Payment | |
| APP_UNION – UnionPay App Payment | |
| WEBOX_APP – Webox App Payment | |
| WEBOX_CSP – Webox QR Code Payment | |
| WEBOX_SVC – Webox Official Account Payment | |
| APP_WEIXIN – WeChat App Payment | |
| MERCHANT_ACCOUNT_PAY – Enterprise Account Payment | |
| realBankSerialNumber | Transaction serial number assigned by the bank. |
| realBankRequestNumber | Order number assigned by the bank. |
| projectId | Unique identifier for the project associated with this transaction. |
| bindCardId | ID of the card bound by the user. |
| splitMark | >Split Settlement Indicator: DO_SPLIT - Split settlement enabled |
| NOT_DO_SPLIT - Split settlement not enabled | |
| canSplitAmount | Remaining amount available for splitting, in cents. Formula: canSplitAmount = Order Split Amount - Settled SplitAmount - Pending Refund Aggregation Amount |
| orderSplitAmount | The total amount available for splitting for this order. This is a fixed value, in cents. If the billing type is “real-time”: splitable amount = order amount - merchant-borne fee If the billing type is not “real-time”: splitable amount = order amount |
| payMerchantId | Payer Merchant ID. This field is returned when the payment is made using an enterprise account. |
| remark | The remark submitted in the original request. Returned to the merchant. |
| errorMessage | Error Message |
| cardType | Card Type DEBIT_CARD - Debit Card |
| CREDIT_CARD — Credit Card | |
| Actual card type used for payment. | |
| This field is returned upon successful transaction if supported by the payment channel. | |
| usersSign | User Identifier. If specified in the original request, this field will be returned upon successful transaction. Currently applicable only to WeChat Pay, Alipay, and WeBox. |
| finalPaymentType | Payment Type: BANK_CARD - Bank Card |
| BALANCE - Balance | |
| Actual payment method used by the user. | |
| This field is returned upon successful transaction if the acquiring merchant has enabled this configuration with us. | |
| payerNameMd5 | Payer's name in MD5 format. Returned upon successful transaction if the acquiring merchant has enabled this configuration and the payment channel supports it. |
| bankCardNumberMd5 | MD5 format of the actual bank card number used for payment. Returned if the acquiring merchant has enabled this configuration, the payment type is bank card, and the channel supports it. |
| bankCardNumber | Masked format of the actual bank card number used for payment. Returned if the acquiring merchant has enabled this configuration, the payment type is bank card, and the channel supports it. |
| bankCode | Bank code of the card-issuing bank used for payment. Returned if the acquiring merchant has enabled this configuration, the payment type is bank card, and the channel supports it. |
| feeAmount | The fee charged by PayEase for this transaction, in cents. Returned upon successful transaction. |
| feeBear | The party that bears the transaction fee. Returned upon successful transaction. MERCHANT — Merchant PARTNER — Service Provider |
| deliveryStatus | Delivery Status: This field is only applicable for the MINIAPPS_WEIXIN_PAY payment method. It can be ignored for other payment methods. |
| INIT — Initialized. Default status before order is completed. | |
| CANCELED — Canceled. Triggered when the order fails. | |
| PENDING — Pending. Payment succeeded, delivery required. | |
| DELIVERED — Delivered. Delivery successful for a pending order. | |
| NOREQUIRED — Not Required. Payment succeeded, delivery not required. | |
| deliveryDateTime | Delivery Timestamp: Format: yyyy-mm-dd hh:mm:ss Only returned when deliveryStatus is “DELIVERED”. |
| hmac | HMAC signature generated by PayEase. Please refer to the decryption flow for verification details. |
Note: When processing response messages from PayEase, merchants should implement forward compatibility for potential future fields. This ensures that newly added fields do not cause system errors or disrupt the parsing of existing fields.