Appearance
申请退款
说明:退款支持单笔交易分多次退款,多次退款需要提交原支付订单的商户订单号和设置不同的退款单号。申请退款总金额不能超过订单金额。 一笔退款失败后重新提交,请不要更换退款单号,请使用原商户退款单号。
公共参数
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
mch_no | String | 是 | 32 | 商户号 | 2014072300007148 |
method | String | 是 | 128 | 接口名称 | trade.pay.refund |
charset | String | 是 | 10 | 调用的接口版本,固定为:utf-8 | utf-8 |
sign_type | String | 是 | 10 | 商户生成签名字符串所使用的签名算法类型,目前支持 RSA | RSA |
sign | String | 是 | 344 | 商户请求参数的签名串 | 详见示例 |
timestamp | String | 是 | 19 | 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" | 2014-07-24 03:07:50 |
version | String | 是 | 3 | 调用的接口版本,固定为:1.0 | 1.0 |
notify_url | String | 是 | 256 | 异步通知地址,退款成功或者失败的状态会通过次通知给商户 | |
return_url | String | 否 | 256 | 同步跳转地址 | |
biz_content | String | 是 | 业务参数 |
业务参数
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
out_trade_no | String | 二选一 | 64 | 商户订单号。由商家自定义,需保证在商户端唯一 | 20150320010101001 |
trade_no | String | 二选一 | 64 | 平台商订单号 | 20150320010101001 |
out_trade_refund_no | String | 是 | 64 | 商户退款订单号,保证唯一,多笔退款此单号不同且唯一 | 202329112001 |
refund_amount | String | 是 | 10 | 退款金额(元) | 9.98 |
refund_reason | String | 否 | 128 | 退款原因 | 申请退款的原因 |
返回信息
json
申请退款失败 即判断 code != 20000 , 不会发异步通知,退款一定失败。
申请退款成功 即判断 code = 20000 ,才会进一步发退款的异步通知。
流程:申请退款 -》 退款 -》 发异步通知
成功返回信息:
{
"code": 20000,
"msg": "success",
"mch_no": "21629082503094",
"trade_no": 571004898850897920,
"out_trade_no": "q1211231111",
"refund_order_id": 571006234799636480,
"out_trade_refund_no": "2155111252233333",
"refund_status": "REFUND_DEFAULT",
"refund_amount": "0.01",
"succeed_time": 0,
"failed_time": 0,
"sign": "MFN4L4vyNYkFJvloI6jlecLrkLAZ+bisJomusFuvDpvVPpcnKggAVC2pfPMN0QPyJUIZRNs42KdwRc2+MbZQIvTaBXGoPErKQ5buHZSGqVw1OuOdmM7yT7mHOgfjuZl/dncfdzvg/nKC1SagPY+ejQRqTqQc2cok5pugg7LfPAnL6K7xTSMuVv6k05IGpqMBX+FDr23x3gEY4TT6kRJgvmBHJmOaiybzt/FxQ13YLjf2VqwAVebKaEhyFWvQc2vzcuQVLw1WnYlDh0SnPPCLv9f8Cm45a8DMwAK0yKf/sCjdi+yWltTTHDsE0WYb3HWskGPg6xBdCX6FzePZqPZR+w=="
}
失败返回信息示例:
{
"code": 50000,
"msg": "申请退款失败",
"mch_no": "21629082503094",
"trade_no": 570913639062810625,
"out_trade_no": "q12111111",
"refund_order_id": 570914020383764480,
"out_trade_refund_no": "21551125xx1xxxxxx1421",
"refund_status": "REFUND_FAIL",
"refund_amount": "0.05",
"succeed_time": 0,
"failed_time": 0,
"sign": "vwleKae4uwn/hQPjQNRkCXLVLtj+tZAcX3FTjmEdV2disKx3/mYrUT2+oFlKnNJAEAhWUColZigYZ6288Wt3DElYugsrZTxA0u+0eZoiucGC2XW0FC1pqiEVZZLH33PUZBKIhjqm7gglXiL+5OS8PUii05Hpic/QKqKm9deBGrFdR8XLdweTYxx3Kp5o4e1IdnE3LcXIgxF8WPRQijRM0UKuntlcQjNLUJ0vHwmRYfuVAmBkeQj2ewEcWinTgoXWpxtULVZWb26aGP83iTSqIlUKqhh5ZK/78KNtN64uXrje20nFyjugsW9LMgIwf5EjBB5s+U4T9zyV4XrlxTfZ/Q=="
}
另一种失败返回信息:
{
"code": 40400,
"msg": "支付渠道异常",
"sub_code": 50001005,
"sub_msg": "请等待分账完成",
"sign": "lDOlaE2jFopiyCYM45pt1mWrqDwc+U+ISGE+d2QVUn89tte6MQ8A5HUmChowFYdxWg8mi+qkhDkGubBpASyxO6W/uQrUnujow2Z6W5Unvv6M6IbxC0q/MWMmbk5vHylPVnWvwWXjS1kFV4m4WtjP/KOCCge+lp3XR27sCH0LLLxOPyL00PaeYW6855qRJbEpt/YRL9n9rO5Wg/z6DuaQhTGuTiOjOTd69evefetYteRyKrhDPc9oZqj9RMDiZcmcFZ6sEvv+1KkmbfPyjvw8t6EX6SlF4lcWJ4MuOZ8KU9f6xHlPu6GFNOugQbcsiMXCNFSNbgE1CjgAOPdkffMIZQ=="
}
返回状态说明
参数 | 描述 |
---|---|
REFUND_DEFAULT | 申请退款成功 |
REFUND_FAIL | 申请退款失败 |
REFUND_DIVIDE_ERROR | 申请退款失败(申请分账失败),此状态可等同于申请退款失败,过渡状态,后期废除 |