开发文档

使用此接口可以实现支付宝、QQ钱包与微信支付的即时到账/免签约/无需企业认证。本文阅读对象:商户系统(在线购物平台、人工收银系统、自动化智能收银系统或其他)集成聚享易支付 涉及的技术架构师,研发工程师,测试工程师,系统运维工程师。


[API]添加商户[API]查询商户信息[API]修改结算账号
[API]查询结算记录[API]查询单个订单[API]批量查询订单
[API]二维码下单接口发起支付请求支付结果通知


接口申请方式

(一)普通支付商户
可以获得一个支付商户。可联系人工申请QQ113337494或网页自助申请,申请之后会将商户ID和商户KEY给你!

协议规则

传输方式:HTTP

数据格式:JSON

签名算法:MD5

字符编码:UTF-8


[API]添加商户

使用此接口前需先拥有本平台商户账号,并联系客服开通权限,否则无权使用本接口

URL地址:https://yzf.cxymz.vip/api.php?act=add&id={商户ID}&token={商户生成密钥}

请求参数说明:

字段名变量名必填类型示例值描述
操作类型actStringquery此API固定值
商户IDidInt100
商户生成密钥tokenString123456

返回结果:

字段名变量名类型示例值描述
返回状态码codeInt11为成功,其它值为失败
返回信息msgString添加支付商户成功!
商户IDpidString101所创建的商户ID
商户密钥keyString(32)hb7Sqn7XR00mBe6B01hE0X007ehX1KKx所创建的商户密钥
结算状态typeString启用

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

URL地址:https://yzf.cxymz.vip/api.php?act=query&pid={商户ID}&key={商户密钥}

请求参数说明:

字段名变量名必填类型示例值描述
操作类型actStringquery此API固定值
商户IDpidInt100
商户密钥keyString(32)0X06gt006qwZKXGgkVgC8KkKG87ptO6M

返回结果:

字段名变量名类型示例值描述
返回状态码codeInt11为成功,其它值为失败
商户IDpidInt100所创建的商户ID
商户密钥keyString(32)VBi9o2W81JL9ZmSL89Ww1k8xZ2L9ku8x所创建的商户密钥
商户类型typeInt1此值暂无用
商户状态activeInt11为正常,0为封禁
商户余额moneyString0.00商户所拥有的余额
结算账号accountStringadmin@coolcat.cn结算的支付宝账号
结算姓名usernameString张三结算的支付宝姓名
商户订单总数ordersInt1商户产生的订单总数量
商户今日交易额order_todayString1商户今日产生的订单总金额
商户昨日交易额order_lastdayString1商户昨日产生的订单总金额
满多少自动结算settle_moneyString10此值为系统预定义
手动结算最低手续费sdtx_money_minString1此值为系统预定义
平台最大结算手续费settle_fee_maxString10此值为系统预定义
支付宝每笔订单分成比例alirateString97此值为系统预定义
微信每笔订单分成比例wxrateString97此值为系统预定义
QQ钱包每笔订单分成比例qqrateString97此值为系统预定义

[API]修改结算信息

URL地址:https://yzf.cxymz.vip/api.php?act=change&pid={商户ID}&key={商户密钥}&soft={安全码}&account={结算账号}&username={结算姓名}&url={网站域名}&stype={结算方式}

请求参数说明:

字段名变量名必填类型示例值描述
操作类型actStringchange此API固定值
商户IDpidInt100所创建的商户ID
商户密钥keyString(32)KtkKSq7HH97TdtKJ2DSkF2c7fTm7Z92K所创建的商户密钥
安全码softString123456用户中心内设置的安全码
结算账号accountStringadmin@coolcat.cn结算的支付宝账号
结算姓名usernameString张三结算的支付宝姓名
网站域名urlStringopen.axiwl.cn您的网站域名
结算方式stypeString11为支付宝,2为微信,3为QQ钱包,4为银行卡

返回结果:

字段名变量名类型示例值描述
返回状态码codeInt11为成功,其它值为失败
返回信息msgString修改收款账号成功!
商户IDpidString100所创建的商户ID
商户密钥keyString6jJHR6qO20p0tr2jjX0TnzgK2G2gC0jH所创建的商户密钥
结算账号accountStringadmin@coolcat.cn您设置的结算账号
结算姓名accountString张三您设置的结算姓名
网站域名urlStringopen.axiwl.cn您设置的网站域名

[API]查询结算记录

URL地址:https://yzf.cxymz.vip/api.php?act=settle&pid={商户ID}&key={商户密钥}

请求参数说明:

所创建的商户ID
字段名变量名必填类型示例值描述
操作类型actStringsettle此API固定值
商户IDpidInt100
商户密钥keyStringn8Z6fv4X1ra3881FVQ8VD6DAsRxqsza8所创建的商户密钥

返回结果:

字段名变量名类型示例值描述
返回状态码codeInt11为成功,其它值为失败
返回信息msgString查询结算记录成功!
结算记录dataArray结算记录列表

[API]查询单个订单

URL地址:https://yzf.cxymz.vip/api.php?act=order&pid={商户ID}&key={商户密钥}&out_trade_no={商户订单号}

请求参数说明:

字段名变量名必填类型示例值描述
操作类型actStringorder此API固定值
商户IDpidInt100所创建的商户ID
商户密钥keyString(32)BZ9ZYBgg9zBlddN2R31aTNBE8D39oT0e所创建的商户密钥
商户订单号out_trade_noString2019050823435494926

返回结果:

字段名变量名类型示例值描述
返回状态码codeInt11为成功,其它值为失败
返回信息msgString查询订单号成功!
易支付订单号trade_noString2019050823435494926OPEN易支付订单号
商户订单号out_trade_noString2019050823435494926商户系统内部的订单号
支付方式typeStringalipayalipay:支付宝,wxpay:微信支付,qqpay:QQ钱包
商户IDpidInt100发起支付的商户ID
创建订单时间addtimeString2019-05-08 23:43:54
完成交易时间endtimeString2019-05-08 23:43:54
商品名称nameStringOPEN易支付余额充值
商品金额moneyString1.00
支付状态statusInt01为支付成功,0为未支付

[API]批量查询订单

URL地址:https://yzf.cxymz.vip/api.php?act=orders&pid={商户ID}&key={商户密钥}

请求参数说明:

所创建的商户ID
字段名变量名必填类型示例值描述
操作类型actStringorders此API固定值
商户IDpidInt100
商户密钥keyStringg3Z9RzTxjjWBZnB959bEJWJz3sAob5nb所创建的商户密钥
查询订单数量limitInt20返回的订单数量,最大50

返回结果:

字段名变量名类型示例值描述
返回状态码codeInt11为成功,其它值为失败
返回信息msgString查询结算记录成功!
订单列表dataArray订单列表

[API]二维码下单接口

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

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

请求参数说明:

字段名变量名必填类型示例值描述
商户IDpidInt1001
支付方式typeStringalipayalipay:支付宝,wxpay:微信支付,qqpay:QQ钱包
商户订单号out_trade_noString2019050823435494926
异步通知地址notify_urlStringhttps://yzf.cxymz.vip/notify_url.php
商品名称nameString余额充值
商品金额moneyString1.00
签名字符串signString202cb962ac59075b964b07152d234b70签名算法与支付宝签名算法相同
签名类型sign_typeStringMD5默认为MD5

返回结果:

字段名变量名类型示例值描述
返回状态码codeInt11为成功,其它值为失败
返回信息msgString下单成功!
订单号trade_noString2019050823435494926
商户订单号out_trade_noString2019050823435494926
二维码链接code_urlStringweixin://wxpay/bizpayurl?pr=XXXXXXX

发起支付请求

URL地址:https://yzf.cxymz.vip/submit.php?pid={商户ID}&type={支付方式}&out_trade_no={商户订单号}&notify_url={服务器异步通知地址}&return_url={页面跳转通知地址}&name={商品名称}&money={金额}&sitename={网站名称}&sign={签名字符串}&sign_type=MD5

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

请求参数说明(支持POST或GET请求):

字段名变量名必填类型示例值描述
商户IDpidInt100
支付方式typeStringalipayalipay:支付宝,wxpay:微信支付,qqpay:QQ钱包
商户订单号out_trade_noString2019050823435494926
异步通知地址notify_urlStringhttp:服务器异步通知地址
跳转通知地址return_urlStringhttp:页面跳转通知地址
商品名称nameStringOPEN易支付余额充值
商品金额moneyString1.00
网站名称sitenameStringOPEN易支付
签名字符串signString202cb962ac59075b964b07152d234b70签名算法与支付宝签名算法相同
签名类型sign_typeStringMD5默认为MD5

支付结果通知

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

请求方式:GET

请求参数说明:

字段名变量名必填类型示例值描述
商户IDpidInt100
支付订单号trade_noString2019050823435494926021OPEN易支付订单号
商户订单号out_trade_noString2019050823435494926商户系统内部的订单号
支付方式typeStringalipayalipay:支付宝,wxpay:微信支付,qqpay:QQ钱包
商品名称nameStringOPEN易支付余额充值
商品金额moneyString1.00
支付状态trade_statusStringTRADE_SUCCESS
签名字符串signString202cb962ac59075b964b07152d234b70签名算法与支付宝签名算法相同
签名类型sign_typeStringMD5默认为MD5