退款请求
- Endpoint:
POST /delSuffixStart6 - Tags: 收款
Description
注意请求地址不包含括号内的接口说明
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 | PayerMax分配给商户的唯一标识 | |
bizType | string | Yes | maxLength: 30 | 业务代码，此接口需传入“refundApply” | |
version | string | Yes | maxLength: 5 | 接口版本。当前值为：2.1 | |
refundId | string | Yes | maxLength: 64 | 商户退款请求流水号 | |
orderId | string | Yes | maxLength: 64 | 原商户订单号 | |
amount | string | Yes | maxLength: 12 | 退款金额等于原订单金额，目前暂不支持部分退款 | |
currency | string | Yes | maxLength: 3 | 货币代码，大写字母，参见【支持的国家与币种】 | |
callbackUrl | string | No | maxLength: 256 | 退款结果callBack URL，以http/https开头，传入该值可获得【退款结果异步回调通知】 | |
comment | string | Yes | maxLength: 256 | 退款说明 | |
email | string | No | maxLength: 32 | 巴西的Lottery和Boleto支付方式退款，上送邮箱接受退款信息收集页 |
Example
json
{
"merchantId": "SP12345678",
"bizType": "refundApply",
"version": "2.1",
"refundId": "2018111211260556846",
"orderId": "1535433555559",
"amount": "1000.00",
"currency": "INR",
"callbackUrl": "https://***.com/revMsg",
"comments": "Sales return",
"email": "123@gmail.com"
}Responses
200
| Field | Type | Required | Constraints | Description | Enum |
|---|---|---|---|---|---|
bizCode | string | Yes | maxLength: 10 | 返回码 | |
message | string | No | maxLength: 256 | 返回描述 | |
data | object | Yes | 返回数据体，内容参考下方的【data参数】 | ||
data.refundId | string | Yes | maxLength: 64 | 商户退款请求流水号 | |
data.tradeNo | string | Yes | maxLength: 64 | payermax平台订单号 | |
data.orderId | string | Yes | maxLength: 64 | 原交易商户订单号 | |
data.status | number | Yes | 退款状态： 0-退款初始，1-退款成功，2-退款失败 | ||
data.errorCode | string | No | maxLength: 64 | 退款错误码 | |
data.errorMsg | string | No | maxLength: 256 | 退款错误原因 |
Response Example
json
{
"bizCode": "0000",
"data": {
"tradeNo": "20220914153025TI2536162084804117",
"refundId": "2018111211260556846",
"orderId": "1535433555559",
"status": 0
}
}