API开发文档简介
本文阅读对象:使用河南金代网络科技有限公司旗下同富云支付 商户自服务系统的技术架构师、研发工程师、系统运维工程师。通过本文档,商户可了解 同富云支付 接入的技术、接入的产品业务、接入的流程、接入规范等信息,以便于商户顺利完成接入工作。
同富云支付接口API地址是:https://pay.517900.com
API接口申请方式
共有两种接口模式: (一)普通支付商户
可以获得一个支付商户。请前往网址https://pay.517900.com/user/reg.php进行申请,申请之后会将商户ID和商户KEY给你!
API协议接入规则
传输方式:HTTP
数据格式:JSON
签名算法:MD5
字符编码:UTF-8
API查询商户信息与结算规则
URL地址:https://pay.517900.com/api.php?act=query&pid={商户ID}&key={商户密钥}
请求参数说明
字段名变量名必填类型示例值描述
操作类型actStringquery此API固定值
商户IDpidInt1000
商户密钥keyStringg6BBsX8xBt2t6SqEqZQ8KzKKEQstf6x6
返回结果
字段名变量名类型示例值描述
返回状态码codeInt11为成功,其它值为失败
商户IDpidInt1000所创建的商户ID
商户密钥keyString(32)g6BBsX8xBt2t6SqEqZQ8KzKKEQstf6x6所创建的商户密钥
商户类型typeInt1此值暂无用
商户状态activeInt11为正常,0为封禁
商户余额moneyString0.00商户所拥有的余额
结算账号accountStringhnjindai@qq.com结算的支付宝账号
结算姓名usernameString张三结算的支付宝姓名
满多少自动结算settle_moneyString30此值为系统预定义
手动结算手续费settle_feeString1此值为系统预定义
每笔订单分成比例money_rateString98此值为系统预定义
API修改结算账号
URL地址:https://pay.517900.com/api.php?act=change&pid={商户ID}&key={商户密钥}&account={结算账号}&username={结算姓名}
请求参数说明
字段名变量名必填类型示例值描述
操作类型actStringchange此API固定值
商户IDpidInt1000
商户密钥keyStringg6BBsX8xBt2t6SqEqZQ8KzKKEQstf6x6
结算账号accountStringpay.svip结算的支付宝账号
结算姓名usernameString张三结算的支付宝姓名
返回结果
字段名变量名类型示例值描述
返回状态码codeInt11为成功,其它值为失败
返回信息msgString修改收款账号成功!
API查询结算记录
URL地址:https://pay.517900.com/api.php?act=settle&pid={商户ID}&key={商户密钥}
请求参数说明:
字段名变量名必填类型示例值描述
操作类型actStringsettle此API固定值
商户IDpidInt1000
商户密钥keyStringg6BBsX8xBt2t6SqEqZQ8KzKKEQstf6x6
返回结果:
字段名变量名类型示例值描述
返回状态码codeInt11为成功,其它值为失败
返回信息msgString查询结算记录成功!
结算记录dataArray结算记录列表
API查询单个订单
URL地址:https://pay.517900.com/api.php?act=order&pid={商户ID}&key={商户密钥}&out_trade_no={商户订单号}
请求参数说明:
字段名变量名必填类型示例值描述
操作类型actStringorder此API固定值
商户IDpidInt1000
商户密钥keyStringg6BBsX8xBt2t6SqEqZQ8KzKKEQstf6x6
商户订单号out_trade_noString20160806151343349
返回结果:
字段名变量名类型示例值描述
返回状态码codeInt11为成功,其它值为失败
返回信息msgString查询订单号成功!
易支付订单号trade_noString2016080622555342651Hack易支付订单号
商户订单号out_trade_noString20160806151343349商户系统内部的订单号
支付方式typeStringalipayalipay:支付宝,tenpay:财付通,
qqpay:QQ钱包,wxpay:微信支付
商户IDpidInt1000发起支付的商户ID
创建订单时间addtimeString2016-08-06 22:55:52
完成交易时间endtimeString2016-08-06 22:55:52
商品名称nameStringVIP会员
商品金额moneyString1.00
支付状态statusInt01为支付成功,0为未支付
API批量查询订单
URL地址:https://pay.517900.com/api.php?act=orders&pid={商户ID}&key={商户密钥}
请求参数说明:
字段名变量名必填类型示例值描述
操作类型actStringorders此API固定值
商户IDpidInt1000
商户密钥keyStringg6BBsX8xBt2t6SqEqZQ8KzKKEQstf6x6
查询订单数量limitInt20返回的订单数量,最大50
返回结果:
字段名变量名类型示例值描述
返回状态码codeInt11为成功,其它值为失败
返回信息msgString查询结算记录成功!
订单列表dataArray订单列表
API发起支付请求
URL地址:https://pay.517900.com/submit.php?pid={商户ID}&type={支付方式}&out_trade_no={商户订单号}¬ify_url={服务器异步通知地址}&return_url={页面跳转通知地址}&name={商品名称}&money={金额}&sitename={网站名称}&sign={签名字符串}&sign_type=MD5
请求参数说明:
字段名变量名必填类型示例值描述
商户IDpidInt1000
支付方式typeStringalipayalipay:支付宝,tenpay:财付通,
qqpay:QQ钱包,wxpay:微信支付
商户订单号out_trade_noString20160806151343349
异步通知地址notify_urlStringhttp://域名/notify_url.php服务器异步通知地址
跳转通知地址return_urlStringhttp://域名/return_url.php页面跳转通知地址
商品名称nameStringVIP会员
商品金额moneyString1.00
网站名称sitenameString某某某平台
签名字符串signString202cb962ac59075b964b07152d234b70签名算法与支付宝签名算法相同
签名类型sign_typeStringMD5默认为MD5
API支付结果通知
通知类型:服务器异步通知(notify_url)、页面跳转通知(return_url)
请求方式:GET
请求参数说明:
字段名变量名必填类型示例值描述
商户IDpidInt1000
易支付订单号trade_noString20160806151343349021Hack易支付订单号
商户订单号out_trade_noString20160806151343349商户系统内部的订单号
支付方式typeStringalipayalipay:支付宝,tenpay:财付通,
qqpay:QQ钱包,wxpay:微信支付
商品名称nameStringVIP会员
商品金额moneyString1.00
支付状态trade_statusStringTRADE_SUCCESS
签名字符串signString202cb962ac59075b964b07152d234b70签名算法与支付宝签名算法相同
签名类型sign_typeStringMD5默认为MD5