# Query Refund
Merchants query refund orders through this API, and the payment gateway will return the latest order data.
# Query Refund API
API
Request API: /api/refund/query
Request method: POST
Request type: application/json or application/x-www-form-urlencoded
# Request parameters
| Field Name | Variable Name | Required | Type | Example Value | Description |
|---|---|---|---|---|---|
| Merchant No | mchNo | Yes | String(30) | M1621873433953 | Merchant Number |
| App ID | appId | Yes | String(24) | 60cc09bce4b0f1c0b83761c9 | App ID |
| Refund Order No | refundOrderId | Yes | String(30) | R20160427210604000490 | The refund order number generated by the payment center can be combined with mchRefundNo to generate a refund |
| Merchant Refund Order No | mchRefundNo | Yes | String(30) | 20160427210604000490 | The refund order number generated by the merchant can be passed along with the refundOrderId |
| Merchant Refund Order No | mchRefundNo | Yes | String(30) | M27210632100491 | Merchant generated refund order number |
| Request Time | reqTime | Yes | long | 1622016572190 | Request API time, 13-digit timestamp |
| API Version | version | Yes | String(3) | 1.0 | API version number, fixed: 1.0 |
| Signature | sign | Yes | String(32) | C380BEC2BFD727A4B6845133519F3AD6 | Signature value, see signature algorithm for details |
| Signature Type | signType | Yes | String(32) | MD5 | Signature type, currently only supports MD5 mode |
# Request Example Data
{
"refundOrderId": "P202106181105527690009",
"appId": "60cc09bce4b0f1c0b83761c9",
"sign": "1484293FCAEAFE11DEC8949DB6B525A9",
"signType": "MD5",
"reqTime": "1624008199",
"mchNo": "M1623984572",
"version": "1.0"
}
# Return parameters
| Field Name | Variable Name | Required | Type | Example Value | Description |
|---|---|---|---|---|---|
| Return State | code | Yes | int | 0 | 0 - processing successful, others - processing error, see error code for details |
| Return Message | msg | No | String(128) | Signature failure | Specific error reasons, such as: signature failure, parameter format verification error |
| Signature | sign | No | String(32) | CCD9083A6DAD9A2DA9F668C3D4517A84 | Sign the data in data, if data is empty, it will not be returned |
| Return Data | data | No | String(512) | {} | Return order data, json format data |
# Parameter Data Format
| Field Name | Variable Name | Required | Type | Example Value | Description |
|---|---|---|---|---|---|
| Refund Order No | refundOrderId | Yes | String(30) | R20160427210604000490 | Refund order number generated by the payment center |
| Payment Order No | payOrderId | Yes | String(30) | P12021022311124442600 | Return payment system order number |
| Merchant No | mchNo | Yes | String(30) | M1621873433953 | Merchant Number |
| App ID | appId | Yes | String(24) | 60cc09bce4b0f1c0b83761c9 | App ID |
| Merchant Refund Order No | mchRefundNo | Yes | String(30) | 20160427210604000490 | Refund order number generated by the merchant |
| Payment Amount | payAmount | Yes | String(long) | 100 | Payment amount, in cents |
| Refund Amount | refundAmount | Yes | String(long) | 100 | Refund amount, in cents |
| Currency Code | currency | Yes | String(3) | USD | Three-digit currency code |
| Refund State | state | Yes | int | 2 | Refund status 0-Order generated 1-Refund in progress 2-Refund successful 3-Refund failed 4-Refund closed |
| Channel Error Code | errCode | No | String | 1002 | Channel return error code |
| Channel Error Message | errMsg | No | String | 134586944573118714 | Channel return error description |
| Extended Parameters | extraParam | No | String(512) | 134586944573118714 | Merchant extended parameters, which will be returned unchanged during callback |
| Creation Time | createdAt | Yes | String(long) | 1622016572190 | Order creation time, 13-digit timestamp |
| Success Time | successTime | No | String(long) | 1622016572190 | Order payment success time, 13-digit timestamp |
# Return Example Data
{
"code": 0,
"data": {
"appId": "60cc09bce4b0f1c0b83761c9",
"channelOrderNo": "2021061822001423031419593035",
"createdAt": "1623985552769",
"currency": "USD",
"extParam": "",
"mchNo": "M1623984572",
"mchRefundNo": "mho1623985552430",
"payAmount": "58",
"payOrderId": "P202106181104177050002",
"refundAmount": "4",
"refundOrderId": "P202106181105527690009",
"state": 2,
"successTime": "1623985554000"
},
"msg": "SUCCESS",
"sign": "E3F9F008FC5EF84BD782CCC7BE69DC5E"
}