Refund Result Query
- Endpoint:
POST /delSuffixStart7 - Tags: Collection Service
Description
Note that the request address does not contain the interface description in brackets
Parameters
| Field | In | Type | Required | Constraints | Description |
|---|---|---|---|---|---|
sign | header | string | Yes |
Parameter Examples
sign:"FPFVT3o227JrFRbqu19boZCpVVTF9KznxyRawUmxpfXilHV/0yK46haPhAjNu1hPUMy7Vw/ILXhfzffNm4Fj0apWknlTY9OJxnSoQxS9BTFtc61tn5yV1q69x/kkBl82/qwg+XTJ4fOzy7Mar3VaC1E2PlDA6RkkKBUyNE6RYgsdB+Su7an4+4HVTNAnoe74WyvBgxTLMNg28igBTdqxaO3w/UBY6ObVp7vkqkQGdL1Y+HgmMYaAVwrM3+ALWGId0sJ+YqTY4WJ+0xCRGhaSnybiIjZsQEYyID68WNUfuavDLDsEhaMm/HfQvf5p0R1Ltovp3wwJnEbQcjY458iX5A=="
Request Body
Content-Type: application/json
| Field | Type | Required | Constraints | Description | Enum |
|---|---|---|---|---|---|
merchantId | string | Yes | maxLength: 30 | Merchant ID assigned by PayerMax. | |
bizType | string | Yes | maxLength: 30 | Business type. Value 'refundQuery' needs to be passed here. | |
version | string | Yes | maxLength: 5 | API version, currently always pass '2.1'. | |
refundId | string | Yes | maxLength: 64 | Refund request ID. |
Example
json
{
"merchantId": "SP12345678",
"version": "2.1",
"bizType": "refundQuery",
"refundId": "20181112112606288846"
}Responses
200
| Field | Type | Required | Constraints | Description | Enum |
|---|---|---|---|---|---|
bizCode | string | Yes | maxLength: 10 | Response code. | |
message | string | No | maxLength: 256 | Response message. | |
data | object | Yes | Response body,refer to the below【data parameters】 | ||
data.refundId | string | Yes | maxLength: 64 | Merchant refund request serial number. | |
data.tradeNo | string | Yes | maxLength: 64 | PayerMax platform order number. | |
data.orderId | string | Yes | maxLength: 64 | Merchant order number. | |
data.refundAmount | string | Yes | maxLength: 12 | Refund order amount. Value range: [1, 100000000], up to two decimal places. | |
data.currency | string | Yes | maxLength: 8 | Currency code in capital letters. Must be consistent with countryCode. See 【Country & Region Codes】 | |
data.status | number | Yes | The refund order status: 0-Pending, 1-Success, 2-Failed. This parameter shows the current refund order status. | ||
data.errorCode | string | Yes | maxLength: 64 | Error code for failed refund. Empty string if refund is successful. | |
data.errorMsg | string | Yes | maxLength: 256 | Error message for failed refund. Empty string if refund is successful. |
Response Example
json
{
"bizCode": "0000",
"message": "success",
"data": {
"refundId": "20181112112606266846",
"tradeNo": "20220914153025TI2536162084804117",
"orderId": "1535433516149",
"refundAmount": "1000",
"currency": "INR",
"status": 1,
"errorCode": "",
"errorMsg": ""
}
}