协议规则

传输方式:HTTP

数据格式:JSON

签名算法:MD5

字符编码:UTF-8

[API]创建商户

API权限:该API只能合作支付商户调用

URL地址:http://pay.tkingdoms.com.cn/api.php?act=apply&token={合作者身份TOKEN}&url={商户域名}

请求参数说明:

字段名 变量名 必填 类型 示例值 描述
操作类型 act String apply 此API固定值
合作者TOKEN token String 9ddab6c4f2c87ce442de371b04f36d68 需要事先申请
商户域名 url String pay.12346.cn

返回结果:

字段名 变量名 类型 示例值 描述
返回状态码 code Int 1 1为成功,其它值为失败
返回信息 msg String 添加支付商户成功!
商户ID pid Int 1001 所创建的商户ID
商户密钥 key String(32) 89unJUB8HZ54Hj7x4nUj56HN4nUzUJ8i 所创建的商户密钥
商户类型 type Int 1 此值暂无用

[API]查询商户信息与结算规则

URL地址:http://pay.tkingdoms.com.cn/api.php?act=query&pid={商户ID}&key={商户密钥}

请求参数说明:

字段名 变量名 必填 类型 示例值 描述
操作类型 act String query 此API固定值
商户ID pid Int 1001
商户密钥 key String 89unJUB8HZ54Hj7x4nUj56HN4nUzUJ8i

返回结果:

字段名 变量名 类型 示例值 描述
返回状态码 code Int 1 1为成功,其它值为失败
商户ID pid Int 1001 所创建的商户ID
商户密钥 key String(32) 89unJUB8HZ54Hj7x4nUj56HN4nUzUJ8i 所创建的商户密钥
商户类型 type Int 1 此值暂无用
商户状态 active Int 1 1为正常,0为封禁
商户余额 money String 0.00 商户所拥有的余额
结算账号 account String pay@12356.cn 结算的支付宝账号
结算姓名 username String 张三 结算的支付宝姓名
满多少自动结算 settle_money String 30 此值为系统预定义
手动结算手续费 settle_fee String 1 此值为系统预定义
每笔订单分成比例 money_rate String 98 此值为系统预定义

[API]修改结算账号

URL地址:http://pay.tkingdoms.com.cn/api.php?act=change&pid={商户ID}&key={商户密钥}&account={结算账号}&username={结算姓名}

注:为了保障资金安全,已经设置结算账号的无法再进行修改,如需修改请联系客服

请求参数说明:

字段名 变量名 必填 类型 示例值 描述
操作类型 act String change 此API固定值
商户ID pid Int 1001
商户密钥 key String 89unJUB8HZ54Hj7x4nUj56HN4nUzUJ8i
结算账号 account String pay@123456.cn 结算的支付宝账号
结算姓名 username String 张三 结算的支付宝姓名

返回结果:

字段名 变量名 类型 示例值 描述
返回状态码 code Int 1 1为成功,其它值为失败
返回信息 msg String 修改收款账号成功!

[API]查询结算记录

URL地址:http://pay.tkingdoms.com.cn/api.php?act=settle&pid={商户ID}&key={商户密钥}

请求参数说明:

字段名 变量名 必填 类型 示例值 描述
操作类型 act String settle 此API固定值
商户ID pid Int 1001
商户密钥 key String 89unJUB8HZ54Hj7x4nUj56HN4nUzUJ8i

返回结果:

字段名 变量名 类型 示例值 描述
返回状态码 code Int 1 1为成功,其它值为失败
返回信息 msg String 查询结算记录成功!
结算记录 data Array 结算记录列表

[API]查询单个订单

URL地址:http://pay.tkingdoms.com.cn/api.php?act=order&pid={商户ID}&key={商户密钥}&out_trade_no={商户订单号}

请求参数说明:

字段名 变量名 必填 类型 示例值 描述
操作类型 act String order 此API固定值
商户ID pid Int 1001
商户密钥 key String 89unJUB8HZ54Hj7x4nUj56HN4nUzUJ8i
商户订单号 out_trade_no String 20160806151343349

返回结果:

字段名 变量名 类型 示例值 描述
返回状态码 code Int 1 1为成功,其它值为失败
返回信息 msg String 查询订单号成功!
易支付订单号 trade_no String 2016080622555342651 鸿鹄支付订单号
商户订单号 out_trade_no String 20160806151343349 商户系统内部的订单号
支付方式 type String alipay alipay:支付宝,tenpay:财付通,
qqpay:QQ钱包,wxpay:微信支付
商户ID pid Int 1001 发起支付的商户ID
创建订单时间 addtime String 2016-08-06 22:55:52
完成交易时间 endtime String 2016-08-06 22:55:52
商品名称 name String VIP会员
商品金额 money String 1.00
支付状态 status Int 0 1为支付成功,0为未支付

[API]批量查询订单

URL地址:http://pay.tkingdoms.com.cn/api.php?act=orders&pid={商户ID}&key={商户密钥}

请求参数说明:

字段名 变量名 必填 类型 示例值 描述
操作类型 act String orders 此API固定值
商户ID pid Int 1001
商户密钥 key String 89unJUB8HZ54Hj7x4nUj56HN4nUzUJ8i
查询订单数量 limit Int 20 返回的订单数量,最大50
页码 page Int 1 当前查询的页码

返回结果:

字段名 变量名 类型 示例值 描述
返回状态码 code Int 1 1为成功,其它值为失败
返回信息 msg String 查询结算记录成功!
订单列表 data Array 订单列表

[API]二维码下单接口

此接口可用于服务器后端发起支付请求,会返回支付二维码链接

URL地址:http://pay.tkingdoms.com.cn/qrcode.php?pid={商户ID}&type={支付方式}&out_trade_no={商户订单号}&notify_url={服务器异步通知地址}&name={商品名称}&money={金额}&sign={签名字符串}&sign_type=MD5

请求参数说明:

字段名 变量名 必填 类型 示例值 描述
商户ID pid Int 1001
支付方式 type String alipay qqpay:QQ钱包,wxpay:微信支付
商户订单号 out_trade_no String 20160806151343349
异步通知地址 notify_url String http://www.123456.cc/notify_url.php 服务器异步通知地址
商品名称 name String VIP会员
商品金额 money String 1.00
签名字符串 sign String 202cb962ac59075b964b07152d234b70 签名算法与支付宝签名算法相同
签名类型 sign_type String MD5 默认为MD5

返回结果:

字段名 变量名 类型 示例值 描述
返回状态码 code Int 1 1为成功,其它值为失败
返回信息 msg String 下单成功!
订单号 trade_no String 20160806151343349
商户订单号 out_trade_no String 20160806151343349
二维码链接 code_url String weixin://wxpay/bizpayurl?pr=04IPMKM

发起支付请求

URL地址:http://pay.tkingdoms.com.cn/submit.php

POST数据:pid={商户ID}&type={支付方式}&out_trade_no={商户订单号}&notify_url={服务器异步通知地址}&return_url={页面跳转通知地址}&name={商品名称}&money={金额}&sitename={网站名称}&sign={签名字符串}&sign_type=MD5

请求参数说明:

字段名 变量名 必填 类型 示例值 描述
商户ID pid Int 1001
支付方式 type String alipay alipay:支付宝,tenpay:财付通,
qqpay:QQ钱包,wxpay:微信支付
商户订单号 out_trade_no String 20160806151343349
异步通知地址 notify_url String http://www.123456.cc/notify_url.php 服务器异步通知地址
跳转通知地址 return_url String http://www.123456.cc/return_url.php 页面跳转通知地址
商品名称 name String VIP会员
商品金额 money String 1.00
网站名称 sitename String 彩虹云任务
签名字符串 sign String 202cb962ac59075b964b07152d234b70 签名算法与支付宝签名算法相同
签名类型 sign_type String MD5 默认为MD5

支付结果通知

通知类型:服务器异步通知(notify_url)、页面跳转通知(return_url)

请求方式:GET

请求参数说明:

字段名 变量名 必填 类型 示例值 描述
商户ID pid Int 1001
易支付订单号 trade_no String 20160806151343349021 鸿鹄支付订单号
商户订单号 out_trade_no String 20160806151343349 商户系统内部的订单号
支付方式 type String alipay alipay:支付宝,tenpay:财付通,
qqpay:QQ钱包,wxpay:微信支付,
alipaycode:支付宝扫码,jdpay:京东支付
商品名称 name String VIP会员
商品金额 money String 1.00
支付状态 trade_status String TRADE_SUCCESS
签名字符串 sign String 202cb962ac59075b964b07152d234b70 签名算法与支付宝签名算法相同
签名类型 sign_type String MD5 默认为MD5

SDK下载

SDK.zip
SDK版本:V1.1