话费充值接口文档
接口版本:1.0
―、引言
-
- 文档概述
本文档提供话费充值接口规范说明,提供一整套的完整的接入示例(http 接口)供商户参 考,可以帮助商户开发人员快速完成接口开发与联调,实现与话费充值系统的交易互联。
-
- 阅读对象
本文阅读对象:开发人员与微客云系统对接支付相关的技术人员。
-
- 业务流程
- 打开控制台 https://control.wikeyun.cn/ 进行注册账号
- 点击添加店铺,只勾选CMS即可,或者店铺ID保存。
- 联系客服申请 app_key与app_secret 。
- 开发对接,需求在控制台进行预存。
二、话费充值接口
1、充值请求下单(post 表单提交)
网关URL:https://router.wikeyun.cn/rest/Recharge/pushOrder
|---------------|-----|----|----------------------------|
| 参数名 | 类型 | 必填 | 参数说明 |
| store_id | 字符串 | 是 | 店铺ID |
| mobile | 字符串 | 是 | 充值号码 |
| order_no | 字符串 | 是 | 充值订单号 |
| money | 整数 | 是 | 充值金额(50,100,200) |
| recharge_type | 整型 | 是 | 1快充 0慢充 |
| notify_url | 字符串 | 是 | 异步回调地址(POST) |
| change | 整数 | 否 | 失败更换渠道充值 0 否 1是 不传系统根据设置判断 |
| source | 整形 | 否 | 是否强制渠道 |
注意:因为每个渠道价格不同,不同用户提交的业务不同,默认不强制;
失败返回数据格式:
{"code":"1003","msg":"app_key不能为空","time":"1624868000","data":null}
成功返回数据格式:
{"code":"0000","msg":"推送成功","data":{"order_number":"xxxx"}}
2、回调通知
|--------------|-----|--------------------------------------------------------|
| 参数名 | 类型 | 参数说明 |
| order_no | 字符串 | 充值订单号 |
| order_number | 字符串 | 官方订单号 |
| status | 字符串 | 交易结果(0 待支付 1 已付 充值中 2充值成功 3充值失败 需要退款 4退款成功 6待充值 7 已匹配) |
收到回调后,商户必须同步返回字符串 success,否则平台认为商户没有收到回调,会重复发送5
次回调。
3、查询接口(post 表单提交)
网关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"}}
4、查询余额接口(post 表单提交)
网关URL:https://router.wikeyun.cn/rest/User/query
数据格式:
{"code":"0000","msg":"获取成功","data":{"money":"100","id":1234}}
- 油卡充值接口
1、添加充值卡
网关URL:https://router.wikeyun.cn/rest/Oil/addCard
|-----------|-----|----|-----------|
| 参数名 | 类型 | 必填 | 参数说明 |
| store_id | 字符串 | 是 | 店铺ID |
| card_num | 字符串 | 是 | 充值卡号 |
| name | 字符串 | 是 | 姓名 |
| phone | 字符串 | 是 | 手机号 |
| user_num | 字符串 | 是 | 身份证 |
| card_type | 整数 | 否 | 0中石化 1中石油 |
2、编辑充值卡
网关URL:https://router.wikeyun.cn/rest/Oil/editCard
|-----------|-----|----|-----------|
| 参数名 | 类型 | 必填 | 参数说明 |
| card_id | 字符串 | 是 | 卡ID |
| card_num | 字符串 | 是 | 充值卡号 |
| name | 字符串 | 是 | 姓名 |
| phone | 字符串 | 是 | 手机号 |
| user_num | 字符串 | 是 | 身份证 |
| card_type | 整数 | 否 | 0中石化 1中石油 |