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={商户密钥}
请求参数说明
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
操作类型 | act | 是 | String | query | 此API固定值 |
商户ID | pid | 是 | Int | 1000 | |
商户密钥 | key | 是 | String | g6BBsX8xBt2t6SqEqZQ8KzKKEQstf6x6 | |
返回结果
字段名 | 变量名 | 类型 | 示例值 | 描述 |
返回状态码 | code | Int | 1 | 1为成功,其它值为失败 |
商户ID | pid | Int | 1000 | 所创建的商户ID |
商户密钥 | key | String(32) | g6BBsX8xBt2t6SqEqZQ8KzKKEQstf6x6 | 所创建的商户密钥 |
商户类型 | type | Int | 1 | 此值暂无用 |
商户状态 | active | Int | 1 | 1为正常,0为封禁 |
商户余额 | money | String | 0.00 | 商户所拥有的余额 |
结算账号 | account | String | hnjindai@qq.com | 结算的支付宝账号 |
结算姓名 | username | String | 张三 | 结算的支付宝姓名 |
满多少自动结算 | settle_money | String | 30 | 此值为系统预定义 |
手动结算手续费 | settle_fee | String | 1 | 此值为系统预定义 |
每笔订单分成比例 | money_rate | String | 98 | 此值为系统预定义 |
API修改结算账号
URL地址:https://pay.517900.com/api.php?act=change&pid={商户ID}&key={商户密钥}&account={结算账号}&username={结算姓名}
请求参数说明
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
操作类型 | act | 是 | String | change | 此API固定值 |
商户ID | pid | 是 | Int | 1000 | |
商户密钥 | key | 是 | String | g6BBsX8xBt2t6SqEqZQ8KzKKEQstf6x6 | |
结算账号 | account | 是 | String | pay.svip | 结算的支付宝账号 |
结算姓名 | username | 是 | String | 张三 | 结算的支付宝姓名 |
返回结果
字段名 | 变量名 | 类型 | 示例值 | 描述 |
返回状态码 | code | Int | 1 | 1为成功,其它值为失败 |
返回信息 | msg | String | 修改收款账号成功! | |
API查询结算记录
URL地址:https://pay.517900.com/api.php?act=settle&pid={商户ID}&key={商户密钥}
请求参数说明:
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
操作类型 | act | 是 | String | settle | 此API固定值 |
商户ID | pid | 是 | Int | 1000 | |
商户密钥 | key | 是 | String | g6BBsX8xBt2t6SqEqZQ8KzKKEQstf6x6 | |
返回结果:
字段名 | 变量名 | 类型 | 示例值 | 描述 |
返回状态码 | code | Int | 1 | 1为成功,其它值为失败 |
返回信息 | msg | String | 查询结算记录成功! | |
结算记录 | data | Array | 结算记录列表 | |
API查询单个订单
URL地址:https://pay.517900.com/api.php?act=order&pid={商户ID}&key={商户密钥}&out_trade_no={商户订单号}
请求参数说明:
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
操作类型 | act | 是 | String | order | 此API固定值 |
商户ID | pid | 是 | Int | 1000 | |
商户密钥 | key | 是 | String | g6BBsX8xBt2t6SqEqZQ8KzKKEQstf6x6 | |
商户订单号 | out_trade_no | 是 | String | 20160806151343349 | |
返回结果:
字段名 | 变量名 | 类型 | 示例值 | 描述 |
返回状态码 | code | Int | 1 | 1为成功,其它值为失败 |
返回信息 | msg | String | 查询订单号成功! | |
易支付订单号 | trade_no | String | 2016080622555342651 | Hack易支付订单号 |
商户订单号 | out_trade_no | String | 20160806151343349 | 商户系统内部的订单号 |
支付方式 | type | String | alipay | alipay:支付宝,tenpay:财付通, qqpay:QQ钱包,wxpay:微信支付 |
商户ID | pid | Int | 1000 | 发起支付的商户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地址:https://pay.517900.com/api.php?act=orders&pid={商户ID}&key={商户密钥}
请求参数说明:
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
操作类型 | act | 是 | String | orders | 此API固定值 |
商户ID | pid | 是 | Int | 1000 | |
商户密钥 | key | 是 | String | g6BBsX8xBt2t6SqEqZQ8KzKKEQstf6x6 | |
查询订单数量 | limit | 否 | Int | 20 | 返回的订单数量,最大50 |
返回结果:
字段名 | 变量名 | 类型 | 示例值 | 描述 |
返回状态码 | code | Int | 1 | 1为成功,其它值为失败 |
返回信息 | msg | String | 查询结算记录成功! | |
订单列表 | data | Array | | 订单列表 |
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
请求参数说明:
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
商户ID | pid | 是 | Int | 1000 | |
支付方式 | type | 是 | String | alipay | alipay:支付宝,tenpay:财付通, qqpay:QQ钱包,wxpay:微信支付 |
商户订单号 | out_trade_no | 是 | String | 20160806151343349 | |
异步通知地址 | notify_url | 是 | String | http://域名/notify_url.php | 服务器异步通知地址 |
跳转通知地址 | return_url | 是 | String | http://域名/return_url.php | 页面跳转通知地址 |
商品名称 | name | 是 | String | VIP会员 | |
商品金额 | money | 是 | String | 1.00 | |
网站名称 | sitename | 否 | String | 某某某平台 | |
签名字符串 | sign | 是 | String | 202cb962ac59075b964b07152d234b70 | 签名算法与支付宝签名算法相同 |
签名类型 | sign_type | 是 | String | MD5 | 默认为MD5 |
API支付结果通知
通知类型:服务器异步通知(notify_url)、页面跳转通知(return_url)
请求方式:GET
请求参数说明:
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
商户ID | pid | 是 | Int | 1000 | |
易支付订单号 | trade_no | 是 | String | 20160806151343349021 | Hack易支付订单号 |
商户订单号 | out_trade_no | 是 | String | 20160806151343349 | 商户系统内部的订单号 |
支付方式 | type | 是 | String | alipay | alipay:支付宝,tenpay:财付通, qqpay:QQ钱包,wxpay:微信支付 |
商品名称 | name | 是 | String | VIP会员 | |
商品金额 | money | 是 | String | 1.00 | |
支付状态 | trade_status | 是 | String | TRADE_SUCCESS | |
签名字符串 | sign | 是 | String | 202cb962ac59075b964b07152d234b70 | 签名算法与支付宝签名算法相同 |
签名类型 | sign_type | 是 | String | MD5 | 默认为MD5 |