Merchants can use the refund query API to check the refund transaction details on the PayEase platform. This interface allows merchants to actively retrieve the refund status of specific orders.
Note: This API is subject to a rate limit of 200 requests per minute. Exceeding this limit will result in an error.
https://apis.5upay.com/onlinePay/refundQuery
| Name | Type& Length | Description | Required |
|---|---|---|---|
| merchantId | varchar(9) | Merchant ID — The unique identifier assigned to the merchant in the PayEase system. Can be viewed in the merchant backend. | M |
| requestId | varchar(50) | Order Number — The requestId submitted via the refund API. |
C |
| partnerId | varchar(9) | Partner ID — The unique identifier of the service provider in the PayEase system. Can be viewed in the merchant backend. | C |
| hmac | varchar(500) | Parameter Signature — HMAC signature generated by the merchant. For signature generation method, refer to the request encryption documentation. | M |
Note: The parameter values above must not contain the following special characters: ' " & < > ( ) [Space]
| Name | Description |
|---|---|
| merchantId | Same as the request parameter |
| requestId | Same as the request parameter |
| partnerId | Same as the request parameter |
| serialNumber | Transaction serial number assigned by Geoswift |
| status | Status INIT Initialized |
| SUCCESS Success | |
| FAILED Failed | |
| ERROR Error(Refer to the Exception Handling section for returned parameters) | |
| amount | Refund amount, in cents (1 Yuan = 100 cents) |
| completeDateTime | Refund completion time |
| currency | Currency of the refund. Default is CNY (Chinese Yuan) |
| errorMessage | Error message, returned when refund fails |
| hmac | HMAC signature generated by Geoswift. Refer to the decryption process for verification |