2022年第三方充值平台接口开发文档 .pdf

《2022年第三方充值平台接口开发文档 .pdf》由会员分享，可在线阅读，更多相关《2022年第三方充值平台接口开发文档 .pdf（20页珍藏版）》请在淘文阁 - 分享文档赚钱的网站上搜索。

1、深圳市创盾网络科技有限公司1/20API接口说明书版本更新内容时间3.0 签名生成方式2013.11.12 2.0 参数注释2013.07.24 1.1 验证服务器ip 2013.02.08 1.0 创建文档2012.12.21 名师资料总结-精品资料欢迎下载-名师精心整理-第 1 页，共 20 页 -深圳市创盾网络科技有限公司2/20目录1、API介绍 .31.1 通讯协议.31.2 充值流程.31.3 权限版本（power）.31.4 版本号（ver）.41.5 时间戳（timestamp）.41.6 订单号（orderid）.41.7 数字签名（sign 和 signkey）.42、AP

2、I调用说明 .52.1 在线充值.52.2 订单回调.72.3 商品进价表.72.4 渠道商信息.92.5 游戏区服表.11 2.6 用户余额.12 2.7 手机号码归属地.12 2.8 系统时间戳.13 2.9 销售软件.13 2.10 激活码开通软件.14 2.11 下级用户列表.15 2.12 财务记录.16 2.13 订单记录.17 2.14 转账 .19 3、注意事项.19 4、通用状态码.20 5、附录 .20 5.1 全国省份直辖市ID 对照表 .20 名师资料总结-精品资料欢迎下载-名师精心整理-第 2 页，共 20 页 -深圳市创盾网络科技有限公司3/201、API介绍1.1

3、 通讯协议1.联系速度达技术（QQ：1551369420）获取密钥KEY，及接口地址。2.接口采用 GET/POST方式提交请求3.返回 XML 或 JSON，传入参数增加format=xml 或者 format=json 1.2 充值流程一次请求保存在本地1 请求时间戳系统启动，获取服务器时间戳 api/sys_now 2请求产品表、渠道表、区服表获取充值产品表 api/product、渠道表 api/product_channel、区服表 api/product_area(该步骤执行一次存储在本地即可)多次请求3选择产品根据所要充值的业务需要先调用本地数据(游戏充值需调用区服表、手机充值需

4、调用渠道表并请求归属地 api/sys_phone)，然后选择产品。4提交订单将充值订单提交到充值接口 api/recharge。其中 productid就是 api/product的 i；area的值就是手机号码归属地对应的值（见附录）如果是游戏则是api/product_area的i。5回调订单状态回调订单状态 api/status。1.3 权限版本（power）13 代表普及版15 代表专业版名师资料总结-精品资料欢迎下载-名师精心整理-第 3 页，共 20 页 -深圳市创盾网络科技有限公司4/2016 代表豪华版17 代表旗舰版1.4 版本号（ver）固定值等于3，每个 api 接口必

5、须要传的参数。1.5 时间戳（timestamp）时间戳是自1970 年 1 月 1 日（00:00:00 GMT）至当前时间的总秒数。时间戳的有效期为 10 分钟。如果您的本机时间为准确的“北京时间”，可使用本机时间戳，否则可通过接口获取当前服务器的时间戳，以它为基本，开始自动计时。时间戳是很多接口必须要传的一个参数。时间戳的目的是为了使一个接口产生的URL在 10 分钟后失效，提高安全性。1.6 订单号（orderid）为防止重复提交，很多接口都必须传入订单号。建议按如下方法生成：取系统当前时间按年月日小时分钟秒毫秒，再与用户编号用字母“v”相连。生成如：20131112170125156

6、v123456 1.7 数字签名（sign 和 signkey）sign 以时间戳作为秘钥signkey 以 KEY值和时间戳作为秘钥如下请求为例，来说明signkey 生成步骤http:/* 将除“signkey”外的所有参数 按 key 进行字典升序排列，将接口名和排序后的参数(key=value)用&拼接起来。例如：/api/recharge?count=1&orderid=1384243215449v9631&productid=1139×tamp=1384243215&to=13800138000&username=&ver=3&将上面生成的字符串连上用户设置的秘钥进行 U

7、RLencode转码，把转码后的字符串进行MD5 加密，即是 signkey。signkey=md5(URLencode(/api/recharge?count=1&orderid=1384243215449v9631&productid=1139×tamp=1384243215&to=13800138000&username=&ver=3&用户秘钥)sign则是以/api/recharge?count=1&orderid=1384243215449v9631&productid=1139×tamp=1384243215&t名师资料总结-精品资料欢迎下载-名师精心整理-第

8、4 页，共 20 页 -深圳市创盾网络科技有限公司5/20o=13800138000&username=&ver=3进行进行 URLencode转码，把转码后的字符串进行MD5 加密。sign=md5(URLencode(/api/recharge?count=1&orderid=1384243215449v9631&productid=1139×tamp=1384243215&to=13800138000&username=&ver=3)2、API调用说明2.1 在线充值http:/* 参数名称数据类型说明是否必填username Varchar(50)速度达用户名Y orderi

9、d Varchar(50)订单号Y productid long 产品 ID Y to Varchar(50)充值对象Y area NVARCHAR2(25)地区 ID/区服 ID（手机充值详见 附录 1）N shop int N count int 购买数量（件数）Y ip Varchar2(25)用户的真实IP N timestamp long 时间戳Y ver int 接口版本号Y signkey Varchar2(32)签名串(不参与加密)Y 返回参数说明：参数名称数据类型说明balance float 用户余额-1 表示余额未变化status int 状态详见“通用状态码”tips

10、String 状态提示信息请求示例http:/* 69.46充值后用户所剩余额 1 状态码：0(状态已更新！)提示名师资料总结-精品资料欢迎下载-名师精心整理-第 5 页，共 20 页 -深圳市创盾网络科技有限公司6/20使用下表商品 ID 充值话费，area 值可传 0（无需判断号码归属地）。中国移动（全国）商品 ID 1 元18 2 元369 3 元370 4 元371 5 元24 6 元372 7 元373 8 元374 9 元375 中国联通（全国）商品 ID 1 元1089 2 元1090 3 元1091 4 元1092 5 元1093 6 元1094 7 元1095 8 元1096

11、 9 元1097 中国电信（全国）商品 ID 10 元1582 20 元1583 30 元1130 50 元1131 100 元1132 全国固话（全国）商品 ID 10 元1699 20 元1698 30 元1700 50 元1701 100 元1702 名师资料总结-精品资料欢迎下载-名师精心整理-第 6 页，共 20 页 -深圳市创盾网络科技有限公司7/202.2订 单 回 调(建 议 下 单 成 功1分 钟 后 调 用)http:/* 参数名称数据类型说明是否必填username Varchar(50)速度达用户名Y orderid Varchar(50)订单号Y timestamp

12、long 时间戳Y ver int 接口版本号Y sign Varchar2(32)签名串(不参与加密)Y 返回参数说明：参数名称数据类型说明balance float 用户余额-1 表示余额未变化status int 状态详见“通用状态码”tips String 状态提示信息请求示例http:/* 69.46充值后用户所剩余额-1 表示余额未变 1 状态码：0(状态已更新！)提示2.3 商品进价表http:/* 参数名称数据类型说明是否必填username NVARCHAR2(25)要获取的用户名Y power int 对应自己的版本豪华版：16 旗舰版：17 Y timestamp lon

13、g 时间戳Y gzip Varchar2(10)gzip=true 时返回加密后的 GZIP串N ver int 接口版本号Y sign Varchar2(32)签名串(不参与加密)Y 名师资料总结-精品资料欢迎下载-名师精心整理-第 7 页，共 20 页 -深圳市创盾网络科技有限公司8/20返回参数说明：参数名称数据类型说明ver int 商品进价表版本号i int 产品 ID 充值时传给服务器b String 产品名称f float 面值u String 单位t int 小分类移动是 100，联通是101，电信是 102，固话是 103 QQ 业务是 200，Q 币 Q 点是 201 游戏

14、是大等于300 c int 渠道 ID v int 省份 ID 详见“全国省份直辖市ID 对照表”q int 商品大类话费业务是1，QQ业务是 2，游戏业务是3 s int 库存大于 0 均表示库存充足o int 排序m String 限购数量如：1-1 目前话费业务不支持倍充p16 float 豪华版进价旗舰版是 p17 status int 状态详见“通用状态码”tips String 状态提示信息请求示例http:/* 30 版本号 1349产品 ID，充值时传给服务端 浙江电信(手机)产品名称 50 面值 元单位 102小分类，移动是100,联通是 101,电信是 102，固话是103

15、 11 渠道 ID 33 省份 1 名师资料总结-精品资料欢迎下载-名师精心整理-第 8 页，共 20 页 -深圳市创盾网络科技有限公司9/201 表示手机，2 表示 QQ业务，3 是游戏。99 库存 2排序，值越小越靠前 1 1 提交件数限止 49.3 49.3普及版充值报价 49.3 49.3专业版充值报价 49.3豪华版充值报价 49.3 340 湖北联通(手机)100 元 101 12 42 1 99 3 1 1 98.6 98.6 98.6 98.6 98.6 98.6 1 状态码2.4 渠道商信息http:/* 参数名称数据类型说明是否必填名师资料总结-精品资料欢迎下载-名师精心整

16、理-第 9 页，共 20 页 -深圳市创盾网络科技有限公司10/20username NVARCHAR2(25)要获取的用户名Y timestamp long 时间戳Y gzip Varchar2(10)gzip=true 时返回加密后的 GZIP串N ver int 接口版本号Y sign Varchar2(32)签名串(不参与加密)Y 返回参数说明：参数名称数据类型说明i int 渠道商 ID 对应产品进价表的c c String 渠道名称r String 备注status int 状态详见“通用状态码”tips String 状态提示信息请求示例http:/* s 1 渠道 ID。对应

17、product中的 C 腾讯 渠道名称备注,（数据返回量大，为避免本文档冗余，有删节）203 网易 获取成功！提示 1 状态码名师资料总结-精品资料欢迎下载-名师精心整理-第 10 页，共 20 页 -深圳市创盾网络科技有限公司11/202.5 游戏区服表http:/* 参数名称数据类型说明是否必填gzip Varchar2(10)gzip=true 时返回加密后的 GZIP串N Username Varchar2(50)用户名Y timestamp long 时间戳Y ver int 接口版本号Y sign Varchar2(32)签名串(不参与加密)Y 返回参数说明：参数名称数据类型说明i

18、 int 产品 ID 对应产品进价表的i t String 游戏区服名称v String 游戏区服值充值接口的 area status int 状态详见“通用状态码”tips String 状态提示信息请求示例http:/* 1209产品 ID。对应 product 中的 i 华夏电信7-8区 名称 556 area ID,（数据返回量大，为避免本文档冗余，有删节）1531 网通一区-黎明港湾 1915名师资料总结-精品资料欢迎下载-名师精心整理-第 11 页，共 20 页 -深圳市创盾网络科技有限公司12/20 获取成功！提示 1 状态码2.6 用户余额http:/* 参数名称数据类型说明是

19、否必填username NVARCHAR2(50)要获取的用户名N timestamp long 时间戳Y ver int 接口版本号Y signkey Varchar2(32)签名串(不参与加密)Y 返回参数说明：参数名称数据类型说明blance float 用户余额balance_lock float 未确认余额power_text String 用户类型status int 状态详见“通用状态码”tips String 状态提示信息请求示例http:/* 50.0用户余额 0.0 未确认余额 豪华版 用户类型 获取成功！提示 1 状态码2.7 手机号码归属地http:/* 参数名称数据类

20、型说明是否必填username NVARCHAR2(50)要获取的用户名N phone long 要获取的手机号timestamp long 时间戳Y 名师资料总结-精品资料欢迎下载-名师精心整理-第 12 页，共 20 页 -深圳市创盾网络科技有限公司13/20ver int 接口版本号Y sign Varchar2(32)签名串(不参与加密)Y 返回参数说明：参数名称数据类型说明type String 号码运营商city String 归属地areacode String 区号zipcode String 邮编status int 状态详见“通用状态码”tips String 状态提示信息

21、请求示例http:/* 中国移动GSM 号码运营商 北京北京 归属地 010 区号 100000邮编 获取成功！提示 1 状态码2.8 系统时间戳http:/* 参数名称数据类型说明是否必填请求示例http:/* 1387437191系统时间戳 获取成功！提示 1 状态码2.9 销售软件http:/* 参数名称数据类型说明是否必填名师资料总结-精品资料欢迎下载-名师精心整理-第 13 页，共 20 页 -深圳市创盾网络科技有限公司14/20username Varchar(50)速度达用户名Y orderid Varchar(50)订单号Y open Varchar(50)要开通用户名Y po

22、wer int 权限版本号Y timestamp long 时间戳Y ver int 接口版本号Y signkey Varchar2(32)签名串(不参与加密)Y 返回参数说明：参数名称数据类型说明income float 此次扣费金额balance float 用户余额status int 状态详见“通用状态码”tips String 状态提示信息请求示例http:/* in-270 此次扣费金额 69.46用户余额 1 状态码开通成功！提示2.10 激活码开通软件http:/* 参数名称数据类型说明是否必填username Varchar(50)速度达用户名Y code Varchar(5

23、0)激活码Y open Varchar(50)要开通用户名Y power int 权限版本号Y timestamp long 时间戳Y ver int 接口版本号Y signkey Varchar2(32)签名串(不参与加密)Y 返回参数说明：参数名称数据类型说明power_text String 开通版本名称status int 状态名师资料总结-精品资料欢迎下载-名师精心整理-第 14 页，共 20 页 -深圳市创盾网络科技有限公司15/20详见“通用状态码”tips String 状态提示信息请求示例http:/* 普及版 开通版本激活成功！提示1 状态码2.11 下级用户列表http:

24、/* 参数名称数据类型说明是否必填username Varchar(50)速度达用户名Y date1 Varchar2(10)开始时间 2013-11-01 Y date2 Varchar2(10)结束时间 2013-11-22 Y key Varchar(50)下级速度达账号N page Int 第几页N line Int 每页几行默认 25 行N timestamp long 时间戳Y ver int 接口版本号Y signkey Varchar2(32)签名串(不参与加密)Y 返回参数说明：参数名称数据类型说明username String 开通的用户名time String 开通时间p

25、ower int 开通的版本power_text String 开通版本名称status int 状态详见“通用状态码”tips String 状态提示信息请求示例http:/* 15 页，共 20 页 -深圳市创盾网络科技有限公司16/ 2013-11-12 16:47:5313普及版 1 共几页1 总行数获取成功！12.12 财务记录http:/* 参数名称数据类型说明是否必填username Varchar(50)速度达用户名Y do Varchar2(20)search Y date1 Varchar2(10)开始时间 2013-11-01 Y date2 Varchar2(10)结束

26、时间 2013-11-22 Y param Varchar(50)订单编号/交易对方账号/加款账号N page Int 第几页N line Int 每页几行默认 25 行N timestamp long 时间戳Y ver int 接口版本号Y signkey Varchar2(32)签名串(不参与加密)Y 返回参数说明：参数名称数据类型说明o String 财务流水号i float 收/支b float 余额t String 交易时间r String 交易备注status int 状态详见“通用状态码”tips String 状态提示信息请求示例http:/* 16 页，共 20 页 -深圳市

27、创盾网络科技有限公司17/20&username=&ver=3&signkey=431797b941087085221f720b5b5d2f8b响应示例138502484370012329878.0 29878.0 2013-11-21 17:08来自 的转账(士大夫)20131121170706215v9631 财务流水号-29878.5 收/支0.1 余额2013-11-21 17:07 交易时间转账至 备注4 共几页37 总行数获取成功！12.13 订单记录http:/* 参数名称数据类型说明是否必填username Varchar(50)速度达用户名Y do Varchar2(20)s

28、earch Y date1 Varchar2(10)开始时间 2013-11-01 Y date2 Varchar2(10)结束时间 2013-11-22 Y param Varchar(50)订单编号/充值号码N page Int 第几页N line Int 每页几行默认 25 行N timestamp long 时间戳Y ver int 接口版本号Y signkey Varchar2(32)签名串(不参与加密)Y 返回参数说明：参数名称数据类型说明o String 订单编号名师资料总结-精品资料欢迎下载-名师精心整理-第 17 页，共 20 页 -深圳市创盾网络科技有限公司18/20e S

29、tring 备注p float 价格b String 充值号码a String 买家s_text String 状态描述t String 下单时间t_ok String 订单成功时间c String 渠道s String 客户端y String 业务类型f String 数量status int 状态详见“通用状态码”tips String 状态提示信息请求示例http:/* 订单编号Q币1个 备注0.92 元 1件 0.92 元 价格1551369420 充值号码 买家疑似成功(直通车账户 IP 地址不匹配)状态2013-12-18 14:49 下单时间2013-12-18 14:49 订单

30、成功时间腾讯 渠道电脑网页 QQ 业务 业务类型1.0 个 1件 1.0 个 数量 4 共几页37 总行数获取成功！名师资料总结-精品资料欢迎下载-名师精心整理-第 18 页，共 20 页 -深圳市创盾网络科技有限公司19/2012.14 转账http:/* 参数名称数据类型说明是否必填username Varchar(50)速度达用户名Y orderid Varchar(50)订单号Y to Varchar(50)收款方速度达用户名Y amount float 转账金额Y remark Varchar2(50)备注N timestamp long 时间戳Y ver int 接口版本号Y si

31、gnkey Varchar2(32)签名串(不参与加密)Y 请求示例http:/* 69.46用户余额 1 状态码开通成功！提示3、注意事项1.系统对同一 IP的充值请求频次限制在30秒90次。如果商户的交易量超过该频次限制的话，切记不要把交易请求通过同一IP发送。2.系统对提交的充值请求只进行单次处理，如果交易过程出现错误，该笔交易被视为无效请求，系统不会再继续处理该交易请求（如已对商户进行扣款的，系统会自动在当日或次日进行退款）。商户需根据自己的实际情况确定是否再次发起充值请求。3.如部分订单未及时退款的，请商户联系我们的在线客服查单退款。4.本系统所有参数及MD5加密串均为小写。5.因速

32、度达 API 接口基于 Linux+Java 架构，所以URL区分大小写。6.所有请求接口都需传入username 参数7.URLEncode转码注意各语言的差异，本系统采用的是.URLEncode.encode()，相对应的c#用Uri.EscapeDataString()。名师资料总结-精品资料欢迎下载-名师精心整理-第 19 页，共 20 页 -深圳市创盾网络科技有限公司20/204、通用状态码状态码说明-9 订单未提交，未扣款（提示各种异常）-1 已扣款，将提交供货商1 成功0 处理中5 疑似成功9 部分退款10 全额退款5、附录5.1 全国省份直辖市ID 对照表ID text ID text 0 全国41 河南11 北京42 湖北12 天津43 湖南13 河北44 广东14 山西45 广西15 内蒙古46 海南21 辽宁50 重庆22 吉林51 四川23 黑龙江52 贵州31 上海53 云南32 江苏54 西藏33 浙江61 陕西34 安徽62 甘肃35 福建63 青海36 江西64 宁夏37 山东65 新疆名师资料总结-精品资料欢迎下载-名师精心整理-第 20 页，共 20 页 -