退款接口
[!WARNING] 目前退款接口只支持90日内成功支付的退款,若订单使用优惠券,仅支持全额退款,若订单未使用优惠券,退款接口支持单笔订单部分退款,单笔退款次数小于等于10次
接口名称
openapi.payment.order.refund
请求方式
POST
请求头
application/json; charset=utf-8
请求业务参数
参数 | 类型 | 是否必填 | 最大长度 | 描述 |
---|---|---|---|---|
merchant_order_sn | string | 否 | 32 | 第三方订单号[二选一必填] |
order_sn | string | 否 | 32 | 付呗订单号[二选一必填] |
merchant_refund_sn | string | 是 | 32 | 第三方退款号 |
refund_money | float | 否 | 10 | 退款金额,为空时默认为全额退款,补充说明:订单使用优惠券,仅支持全额退款 |
handler | int | 否 | 10 | 退款操作人员ID |
device_no | string | 否 | 32 | 硬件设备号 |
- 请求示例:
{
"biz_content": "{\"merchant_order_sn\":\"201705031493809521781openapi\",\"merchant_refund_sn\":\"201705031493809558962openapi\",\"device_no\": \"sn2323277\"}",
"method": "openapi.payment.order.refund",
"format": "json",
"sign_method": "md5",
"sign": "E51746E2799BD5B98437939D1E6087C9",
"app_id": "20170224132045932173",
"nonce": "pp2kiwi",
"version": "1.0"
}
成功响应参数
参数 | 类型 | 是否必填 | 最大长度 | 描述 |
---|---|---|---|---|
refund_sn | string | 是 | 32 | 付呗退款号 |
merchant_refund_sn | string | 是 | 32 | 第三方退款号 |
trade_no | string | 是 | 32 | 商户单号 |
order_sn | string | 是 | 32 | 付呗订单号 |
merchant_order_sn | string | 是 | 32 | 第三方订单号 |
type | int | 是 | 1 | 支付方式[微信1/支付宝2] |
device_no | string | 否 | 32 | 硬件设备号 |
- 响应示例:
{
"result_message": "退款请求成功,请调用接口查询",
"data": {
"refund_sn": "20170503190546706324",
"merchant_refund_sn": "201705031493809558962openapi",
"trade_no": "2017050319051001956367763520",
"order_sn": "20170503190509857215",
"merchant_order_sn": "201705031493809521781openapi",
"device_no": "sn2323277",
"type": 1
},
"result_code": 200
}
失败响应参数
参数 | 类型 | 是否必填 | 最大长度 | 描述 |
---|---|---|---|---|
result_message | string | 是 | 不定 | 订单退款错误信息 |
result_code | int | 是 | 3 | 付呗错误码 |
sub_code | string | 否 | 不定 | 平台方错误码 |
- 响应示例:
{ "result_message": "您的帐号需要进行服务商验证,请联系您的服务商或付呗客服。", "result_code": 400, "sub_code":"NO_ORDER" }
[!DANGER] 若订单使用优惠券,仅支持全额退款,若订单未使用优惠券,退款接口支持单笔订单部分退款,单笔退款次数小于等于10次