话费充值接口文档
接口版本:1.0
本文档提供话费充值接口规范说明,提供一整套的完整的接入示例(http 接口)供商户参 考,可以帮助商户开发人员快速完成接口开发与联调,实现与话费充值系统的交易互联。
公司官网:http://www.wikeyun.cn/
本文阅读对象:开发人员与微客云系统对接支付相关的技术人员。
1、打开控制台 https://control.wikeyun.cn/ 进行注册账号
2、点击添加店铺,只勾选CMS即可,或者店铺ID保存。
3、联系客服申请 app_key与app_secret 。
4、开发对接,需求在控制台进行预存。
网关URL:https://router.wikeyun.cn/rest/Recharge/pushOrder
参数名 |
类型 |
必填 |
参数说明 |
store_id |
字符串 |
是 |
店铺ID |
mobile |
字符串 |
是 |
充值号码 |
order_no |
字符串 |
是 |
充值订单号 |
money |
整数 |
是 |
充值金额(100,200) |
recharge_type |
整型 |
是 |
1快充 0慢充 |
notify_url |
字符串 |
是 |
异步回调地址(POST) |
change |
整数 |
否 |
失败更换渠道充值 0 否 1是 不传系统根据设置判断 |
source |
整形 |
否 |
是否强制渠道 |
注意:因为每个渠道价格不同,不同用户提交的业务不同,默认不强制;
传source字段则可以强制某渠道,强制快充走94折则,source传6
失败返回数据格式:
{"code":"1003","msg":"app_key不能为空","time":"1624868000","data":null}
成功返回数据格式:
{"code":"0000","msg":"推送成功","data":{"order_number":"xxxx"}}
参数名 |
类型 |
参数说明 |
order_no |
字符串 |
充值订单号 |
order_number |
字符串 |
官方订单号 |
status |
字符串 |
交易结果(0 待支付 1 已付 充值中 2充值成功 3充值失败 需要退款 4退款成功 6待充值 7 已匹配) |
收到回调后,商户必须同步返回字符串 success,否则平台认为商户没有收到回调,会重复发送5
次回调。
网关URL:https://router.wikeyun.cn/rest/Recharge/query
参数名 |
类型 |
必填 |
参数说明 |
order_number |
字符串 |
是 |
官方订单号 |
失败返回数据格式:
{"code":"1003","msg":"app_key不能为空","time":"1624868000","data":null}
成功返回数据格式:
{"code":"0000","msg":"获取成功","data":{"order_number":"xxxx","status":"1","mobile":"13786517891","amount":"100","order_no":"xxxx"}}
网关URL:https://router.wikeyun.cn/rest/User/query
数据格式:
{"code":"0000","msg":"获取成功","data":{"money":"100","id":1234}}
网关URL:https://router.wikeyun.cn/rest/Oil/addCard
参数名 |
类型 |
必填 |
参数说明 |
store_id |
字符串 |
是 |
店铺ID |
card_num |
字符串 |
是 |
充值卡号 |
name |
字符串 |
是 |
姓名 |
phone |
字符串 |
是 |
手机号 |
user_num |
字符串 |
是 |
身份证 |
card_type |
整数 |
否 |
0中石化 1中石油 |
网关URL:https://router.wikeyun.cn/rest/Oil/pushOrder
参数名 |
类型 |
必填 |
参数说明 |
store_id |
字符串 |
是 |
店铺ID |
cardId |
整数 |
是 |
充值卡ID,来自创建接口 |
order_no |
字符串 |
是 |
充值订单号 |
amount |
整数 |
是 |
充值金额(500) |
recharge_type |
整型 |
是 |
1快充 0慢充,目前请传0 |
notify_url |
字符串 |
是 |
异步回调地址(POST) |
失败返回数据格式:
{"code":"1003","msg":"app_key不能为空","time":"1624868000","data":null}
成功返回数据格式:
{"code":"0000","msg":"推送成功","data":{"order_number":"xxxx"}}
参数名 |
类型 |
参数说明 |
order_no |
字符串 |
充值订单号 |
order_number |
字符串 |
官方订单号 |
status |
字符串 |
交易结果(0 待支付 1 已付 充值中 2充值成功 3充值失败 需要退款 4退款成功 6待充值 7 已匹配) |
收到回调后,商户必须同步返回字符串 success,否则平台认为商户没有收到回调,会重复发送5
次回调。
网关URL:https://router.wikeyun.cn/rest/Oil/query
参数名 |
类型 |
必填 |
参数说明 |
order_number |
字符串 |
是 |
官方订单号 |
失败返回数据格式:
{"code":"1003","msg":"app_key不能为空","time":"1624868000","data":null}
成功返回数据格式:
{"code":"0000","msg":"获取成功","data":{"order_number":"xxxx","status":"1","mobile":"13786517891","amount":"100","order_no":"xxxx"}}
以下参数必须传参,全部采用get传参(拼接至url内),系统参数包括:
参数名 |
类型 |
参数说明 |
app_key |
字符串 |
应用唯一表示 |
timestamp |
字符串 |
unix时间戳(秒单位) |
client |
字符串 |
客户端请求ip |
v |
字符串 |
客户端接口版本,目前是1.0 |
format |
字符串 |
默认json |
sign |
字符串 |
sign签名 |
把业务参数+系统参数合并成一个数组,然后对数组进行ksort排序(按ASCII由小到大排序),然后对合并后的数组进行循环拼接,格式如下:key1value1key2value2key3value3的形式拼接,最终首尾各拼接一个app_secret,对最终字符串进行md5大写加密。
最终拼接完成的URL如下:https://router.wikeyun.cn/rest/Recharge/pushOrder?app_key=1037110417×tamp=1624862089&client=127.0.0.1&format=json&v=1.0&sign=831EFFE3A7A59A530DA8CEC4A05D744
然后对上面的url 进行post传业务参数
附录
1、充值请求code 状态码
0000 |
接口成功 |
1003 |
app_key不存在 |
1004 |
业务错误,具体看msg |
1005 |
sign签名不对 |
1006 |
timestamp Out |
1007 |
应用已禁用 |
1008 |
余额不足 |
1009 |
相同面值太多,请拆分充值或者稍后再试 |
注意事项(话费快充)
1、请勿同一时间段推送大量订单。
2、请勿推送大量相同面值的订单,比如全是50,全是100,又或者50,100相间有规律的金额
3、系统会严格审核充值金额,同时出现多个金额相同的单子,就会返回1009失败,请稍后再试或者拆分提交处理。