开发文档
使用此接口可以实现支付宝、QQ钱包与微信支付的即时到账/免签约/无需企业认证。本文阅读对象:商户系统(在线购物平台、人工收银系统、自动化智能收银系统或其他)集成聚享易支付 涉及的技术架构师,研发工程师,测试工程师,系统运维工程师。
[API]添加商户[API]查询商户信息[API]修改结算账号
[API]查询结算记录[API]查询单个订单[API]批量查询订单
[API]二维码下单接口发起支付请求支付结果通知
接口申请方式
(一)普通支付商户
可以获得一个支付商户。可联系人工申请QQ113337494或网页自助申请,申请之后会将商户ID和商户KEY给你!
协议规则
传输方式:HTTP
数据格式:JSON
签名算法:MD5
字符编码:UTF-8
[API]添加商户
使用此接口前需先拥有本平台商户账号,并联系客服开通权限,否则无权使用本接口
URL地址:http://yzf.cxymz.vip/api.php?act=add&id={商户ID}&token={商户生成密钥}
请求参数说明:
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 操作类型 | act | 是 | String | query | 此API固定值 |
| 商户ID | id | 是 | Int | 100 | |
| 商户生成密钥 | token | 是 | String | 123456 |
返回结果:
| 字段名 | 变量名 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|
| 返回状态码 | code | Int | 1 | 1为成功,其它值为失败 |
| 返回信息 | msg | String | 添加支付商户成功! | |
| 商户ID | pid | String | 101 | 所创建的商户ID |
| 商户密钥 | key | String(32) | 0HzUZEQfFEnEzvOZ00VfTei0ieh0nfh0 | 所创建的商户密钥 |
| 结算状态 | type | String | 启用 |
[API]查询商户信息与结算规则
URL地址:http://yzf.cxymz.vip/api.php?act=query&pid={商户ID}&key={商户密钥}
请求参数说明:
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 操作类型 | act | 是 | String | query | 此API固定值 |
| 商户ID | pid | 是 | Int | 100 | |
| 商户密钥 | key | 是 | String(32) | K6F8kXyzzgHr8ikbdR3QI86KIRhK36hC |
返回结果:
| 字段名 | 变量名 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|
| 返回状态码 | code | Int | 1 | 1为成功,其它值为失败 |
| 商户ID | pid | Int | 100 | 所创建的商户ID |
| 商户密钥 | key | String(32) | CTWjJ5J8AC5K0ZEUq666ct669id96mUc | 所创建的商户密钥 |
| 商户类型 | type | Int | 1 | 此值暂无用 |
| 商户状态 | active | Int | 1 | 1为正常,0为封禁 |
| 商户余额 | money | String | 0.00 | 商户所拥有的余额 |
| 结算账号 | account | String | admin@coolcat.cn | 结算的支付宝账号 |
| 结算姓名 | username | String | 张三 | 结算的支付宝姓名 |
| 商户订单总数 | orders | Int | 1 | 商户产生的订单总数量 |
| 商户今日交易额 | order_today | String | 1 | 商户今日产生的订单总金额 |
| 商户昨日交易额 | order_lastday | String | 1 | 商户昨日产生的订单总金额 |
| 满多少自动结算 | settle_money | String | 10 | 此值为系统预定义 |
| 手动结算最低手续费 | sdtx_money_min | String | 1 | 此值为系统预定义 |
| 平台最大结算手续费 | settle_fee_max | String | 10 | 此值为系统预定义 |
| 支付宝每笔订单分成比例 | alirate | String | 97 | 此值为系统预定义 |
| 微信每笔订单分成比例 | wxrate | String | 97 | 此值为系统预定义 |
| QQ钱包每笔订单分成比例 | qqrate | String | 97 | 此值为系统预定义 |
[API]修改结算信息
URL地址:http://yzf.cxymz.vip/api.php?act=change&pid={商户ID}&key={商户密钥}&soft={安全码}&account={结算账号}&username={结算姓名}&url={网站域名}&stype={结算方式}
请求参数说明:
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 操作类型 | act | 是 | String | change | 此API固定值 |
| 商户ID | pid | 是 | Int | 100 | 所创建的商户ID |
| 商户密钥 | key | 是 | String(32) | 4deLTekEkED33d34Z13a4k3eLgtKDl11 | 所创建的商户密钥 |
| 安全码 | soft | 是 | String | 123456 | 用户中心内设置的安全码 |
| 结算账号 | account | 是 | String | admin@coolcat.cn | 结算的支付宝账号 |
| 结算姓名 | username | 是 | String | 张三 | 结算的支付宝姓名 |
| 网站域名 | url | 是 | String | open.axiwl.cn | 您的网站域名 |
| 结算方式 | stype | 否 | String | 1 | 1为支付宝,2为微信,3为QQ钱包,4为银行卡 |
返回结果:
| 字段名 | 变量名 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|
| 返回状态码 | code | Int | 1 | 1为成功,其它值为失败 |
| 返回信息 | msg | String | 修改收款账号成功! | |
| 商户ID | pid | String | 100 | 所创建的商户ID |
| 商户密钥 | key | String | pd7oASARoDHAW4zh4qhGQ8sq4d7ssZ1P | 所创建的商户密钥 |
| 结算账号 | account | String | admin@coolcat.cn | 您设置的结算账号 |
| 结算姓名 | account | String | 张三 | 您设置的结算姓名 |
| 网站域名 | url | String | open.axiwl.cn | 您设置的网站域名 |
[API]查询结算记录
URL地址:http://yzf.cxymz.vip/api.php?act=settle&pid={商户ID}&key={商户密钥}
请求参数说明:
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 操作类型 | act | 是 | String | settle | 此API固定值 |
| 商户ID | pid | 是 | Int | 100 | 所创建的商户ID|
| 商户密钥 | key | 是 | String | MMIviz990cBjjCBI00c0I9jJDCI0w8B9 | 所创建的商户密钥 |
返回结果:
| 字段名 | 变量名 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|
| 返回状态码 | code | Int | 1 | 1为成功,其它值为失败 |
| 返回信息 | msg | String | 查询结算记录成功! | |
| 结算记录 | data | Array | 结算记录列表 |
[API]查询单个订单
URL地址:http://yzf.cxymz.vip/api.php?act=order&pid={商户ID}&key={商户密钥}&out_trade_no={商户订单号}
请求参数说明:
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 操作类型 | act | 是 | String | order | 此API固定值 |
| 商户ID | pid | 是 | Int | 100 | 所创建的商户ID |
| 商户密钥 | key | 是 | String(32) | unAeEmjVe4f1eUJ4z4PeUe4JeVapa4p4 | 所创建的商户密钥 |
| 商户订单号 | out_trade_no | 是 | String | 2019050823435494926 |
返回结果:
| 字段名 | 变量名 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|
| 返回状态码 | code | Int | 1 | 1为成功,其它值为失败 |
| 返回信息 | msg | String | 查询订单号成功! | |
| 易支付订单号 | trade_no | String | 2019050823435494926 | OPEN易支付订单号 |
| 商户订单号 | out_trade_no | String | 2019050823435494926 | 商户系统内部的订单号 |
| 支付方式 | type | String | alipay | alipay:支付宝,wxpay:微信支付,qqpay:QQ钱包 |
| 商户ID | pid | Int | 100 | 发起支付的商户ID |
| 创建订单时间 | addtime | String | 2019-05-08 23:43:54 | |
| 完成交易时间 | endtime | String | 2019-05-08 23:43:54 | |
| 商品名称 | name | String | OPEN易支付余额充值 | |
| 商品金额 | money | String | 1.00 | |
| 支付状态 | status | Int | 0 | 1为支付成功,0为未支付 |
[API]批量查询订单
URL地址:http://yzf.cxymz.vip/api.php?act=orders&pid={商户ID}&key={商户密钥}
请求参数说明:
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 操作类型 | act | 是 | String | orders | 此API固定值 |
| 商户ID | pid | 是 | Int | 100 | 所创建的商户ID|
| 商户密钥 | key | 是 | String | vENev05La505e5nppBjn7Jb27NC2av0N | 所创建的商户密钥 |
| 查询订单数量 | limit | 否 | Int | 20 | 返回的订单数量,最大50 |
返回结果:
| 字段名 | 变量名 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|
| 返回状态码 | code | Int | 1 | 1为成功,其它值为失败 |
| 返回信息 | msg | String | 查询结算记录成功! | |
| 订单列表 | data | Array | 订单列表 |
[API]二维码下单接口
此接口可用于服务器后端发起支付请求,会返回支付二维码链接
URL地址:http://yzf.cxymz.vip/qrcode.php?pid={商户ID}&type={支付方式}&out_trade_no={商户订单号}¬ify_url={服务器异步通知地址}&name={商品名称}&money={金额}&sign={签名字符串}&sign_type=MD5
请求参数说明:
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 商户ID | pid | 是 | Int | 1001 | |
| 支付方式 | type | 是 | String | alipay | alipay:支付宝,wxpay:微信支付,qqpay:QQ钱包 |
| 商户订单号 | out_trade_no | 是 | String | 2019050823435494926 | |
| 异步通知地址 | notify_url | 是 | String | http://yzf.cxymz.vip/notify_url.php | |
| 商品名称 | name | 是 | String | 余额充值 | |
| 商品金额 | money | 是 | String | 1.00 | |
| 签名字符串 | sign | 是 | String | 202cb962ac59075b964b07152d234b70 | 签名算法与支付宝签名算法相同 |
| 签名类型 | sign_type | 是 | String | MD5 | 默认为MD5 |
返回结果:
| 字段名 | 变量名 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|
| 返回状态码 | code | Int | 1 | 1为成功,其它值为失败 |
| 返回信息 | msg | String | 下单成功! | |
| 订单号 | trade_no | String | 2019050823435494926 | |
| 商户订单号 | out_trade_no | String | 2019050823435494926 | |
| 二维码链接 | code_url | String | weixin://wxpay/bizpayurl?pr=XXXXXXX |
发起支付请求
URL地址:http://yzf.cxymz.vip/submit.php?pid={商户ID}&type={支付方式}&out_trade_no={商户订单号}¬ify_url={服务器异步通知地址}&return_url={页面跳转通知地址}&name={商品名称}&money={金额}&sitename={网站名称}&sign={签名字符串}&sign_type=MD5
POST数据:pid={商户ID}&type={支付方式}&out_trade_no={商户订单号}¬ify_url={服务器异步通知地址}&return_url={页面跳转通知地址}&name={商品名称}&money={金额}&sitename={网站名称}&sign={签名字符串}&sign_type=MD5
请求参数说明(支持POST或GET请求):
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 商户ID | pid | 是 | Int | 100 | |
| 支付方式 | type | 是 | String | alipay | alipay:支付宝,wxpay:微信支付,qqpay:QQ钱包 |
| 商户订单号 | out_trade_no | 是 | String | 2019050823435494926 | |
| 异步通知地址 | notify_url | 是 | String | http: | 服务器异步通知地址 |
| 跳转通知地址 | return_url | 是 | String | http: | 页面跳转通知地址 |
| 商品名称 | name | 是 | String | OPEN易支付余额充值 | |
| 商品金额 | money | 是 | String | 1.00 | |
| 网站名称 | sitename | 否 | String | OPEN易支付 | |
| 签名字符串 | sign | 是 | String | 202cb962ac59075b964b07152d234b70 | 签名算法与支付宝签名算法相同 |
| 签名类型 | sign_type | 是 | String | MD5 | 默认为MD5 |
支付结果通知
通知类型:服务器异步通知(notify_url)、页面跳转通知(return_url)
请求方式:GET
请求参数说明:
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 商户ID | pid | 是 | Int | 100 | |
| 支付订单号 | trade_no | 是 | String | 2019050823435494926021 | OPEN易支付订单号 |
| 商户订单号 | out_trade_no | 是 | String | 2019050823435494926 | 商户系统内部的订单号 |
| 支付方式 | type | 是 | String | alipay | alipay:支付宝,wxpay:微信支付,qqpay:QQ钱包 |
| 商品名称 | name | 是 | String | OPEN易支付余额充值 | |
| 商品金额 | money | 是 | String | 1.00 | |
| 支付状态 | trade_status | 是 | String | TRADE_SUCCESS | |
| 签名字符串 | sign | 是 | String | 202cb962ac59075b964b07152d234b70 | 签名算法与支付宝签名算法相同 |
| 签名类型 | sign_type | 是 | String | MD5 | 默认为MD5 |