当退款请求发起后,可调用本退款查询接口了解退款的状态,接口地址如下:
https://平台域名/yunke-order/query-refund
如:https://pay.wn.com/yunke-order/query-refund
退款请求:
请求参数如下:
参数名 | 类型 | 是否必选 | 限制 | 描述 | 示例 |
---|---|---|---|---|---|
user_id | int | 是 | 系统分配,不可自定义 | 用户id:商家在平台注册时获得的用户ID | 4 |
order_number | string | 是 |
长度:string[6,32] |
商户订单号:在商家系统中全局唯一 | 20210530_R060524 |
refund_number | string | 否 |
长度:string[6,32] |
退款单号:用以唯一标识同一个订单中的一个退款申请,如退款时省略了该参数时,则可不传递或使用商户订单号代替 | R060524_1 |
sign | string | 是 | 长度string[64] 哈希值 |
签名字符串:用于保证请求真实、不被篡改、防止重放攻击,通讯必须签名,点击查看签名算法 |
接口响应如下:
响应分为公共参数部分和业务参数部分
参数名 | 类型 | 是否必选 | 限制 | 描述 | 示例 |
---|---|---|---|---|---|
code | int | 是 | 三位整数 | 处理结果的状态码,详见这里 | 2000 |
msg | string | 是 | 长度string[1,256] | 处理结果的描述短语 | “ok” |
sign | string | 是 | 长度string[64] 哈希值 |
签名字符串:用于保证请求真实、不被篡改、防止重放攻击,通讯必须签名,点击查看签名算法 |
参数名 | 类型 | 是否必选 | 限制 | 描述 | 示例 |
---|---|---|---|---|---|
user_id | int | 是 | 系统分配 | 用户id:商家在平台注册时获得的用户ID | 4 |
order_number | string | 是 | 长度:string[6,32] 仅限大小写字母、数字、下划线 |
商户订单号:在商家系统中全局唯一 | 20210530_R060524 |
system_number | string | 是 | 目前暂定长度:24位数字 前12位表示时间,8位随机数,4位产品类别 |
在统一平台中的系统订单号,全局唯一 将来可能会升位,用户应预留32位储存 |
210602150849375331066319 |
refund_number | string | 按条件 |
长度:string[6,32] |
退款单号:用以唯一标识同一个订单中的一个退款申请 | R060524_1 |
amount | float | 是 | 可带小数点精确到分,值大于0,小于等于订单总金额 | 退款金额:单位:元 | 18.6 |
total | float | 是 | 可带小数点精确到分 取值范围为 0.01~100000000.00 |
订单总付款金额:单位元 | 18.6 |
reason | string | 可选 | string[1, 80] | 退款原因:若传入,会在下发给用户的退款消息中体现退款原因 | 示例值:商品已售完 |
notify_url | string | 可选 | string[1, 256]必须为直接可访问的URL绝对地址,且异步通知地址不能重定向 | 退款异步通知地址:用于通知商家退款是否成功的异步通知URL绝对地址,如无将不通知,采用POST方法通知,参数见下 | https://www.drupal.org |
success_time | int | 按条件 | Unix时间戳( 1970年1月1日 00:00:00 到当前时间的秒数) | 成功退款的时间,如不成功则不存在 | 1622341093 |
refund_state | int | 是 | 一位整数 | 退款状态:0表示退款等待中,1退款成功,2退款失败 | 这是关键参数,如失败可再次尝试 |
refund_time | int | 是 | Unix时间戳( 1970年1月1日 00:00:00 到当前时间的秒数) | 退款申请发起的时间 | 1622341093 |
响应和退款接口一致