感谢您选择官方码支付!
协议规则
传输方式:HTTP
传输方式:HTTP
签名算法:MD5
字符编码:UTF-8
页面跳转支付
URL地址://vip.payyun.net/api.php?pid={商户ID}&type={支付方式}&out_trade_no={商户订单号}¬ify_url={服务器异步通知地址}&return_url={页面跳转通知地址}&name={商品名称}&money={金额}&sitename={网站名称}&sign={签名字符串}&sign_type=MD5
请求参数说明(点击字段查看描述详情):
字段名 | 变量名 | 必填 | 类型 | 示例值 |
---|---|---|---|---|
商户ID | pid | Int | 1001 | |
支付方式 | type | String | alipay:支付宝,tenpay:财付通, qqpay:QQ钱包,wxpay:微信支付 | |
商户订单号 | out_trade_no | String | 20160806151343349 | |
异步通知地址 | notify_url | String | 【API】/notify_url.php服务器异步通知地址 | |
跳转通知地址 | return_url | String | 【API】/return_url.php页面跳转通知地址 | |
商品名称 | name | String | VIP会员 | |
如超过127个字节会自动截取 |
||||
商品金额 | money | String | 1.00 | |
单位:元,最大2位小数 |
||||
网站名称 | sitename | String | 默认留空 | |
签名字符串 | sign | String | 202cb962ac59075b964b07152d234b70 签名算法与支付宝签名算法相同 (money={商品金额}&name={商品名称}& notify_url={异步通知地址}&out_trade_no={商户订单号}&pid={商户ID}&return_url={同步通知地址}&sitename={站点名称}&type={支付方式}{商户密匙}) | |
签名类型 | sign_type | String | 默认:MD5 |
支付方式(type)不传会跳转到收银台支付
API接口支付
此接口可用于服务器后端发起支付请求,会返回支付二维码链接或支付跳转url。
URL地址://vip.payyun.net/api.php?act=query&pid={商户ID}&key={商户密钥}
请求方式:POST
请求参数说明(点击字段查看描述详情):
字段名 | 变量名 | 必填 | 类型 | 示例值 |
---|---|---|---|---|
商户ID | pid | Int | 1001 | |
支付方式 | type | String | alipay | |
商户订单号 | out_trade_no | String | 20160806151343349 | |
异步通知地址 | notify_url | String | 【API】/notify_url.php服务器异步通知地址 | |
跳转通知地址 | return_url | String | 【API】/return_url.php页面跳转通知地址 | |
商品名称 | name | String | VIP会员 | |
如超过127个字节会自动截取 |
||||
商品金额 | money | String | 1.00 | |
单位:元,最大2位小数 |
||||
用户IP地址 | clientip | String | 默认留空 | |
用户发起支付的IP地址 |
||||
设备类型 | device | String | pc | |
根据用户浏览器的UA判断,传入用户所使用的浏览器或设备类型,默认:pc |
||||
业务扩展参数 | param | String | 默认留空 | |
签名字符串 | sign | String | 202cb962ac59075b964b07152d234b70 | |
签名类型 | sign_type | String | 默认:MD5 |
返回结果(json):
字段名 | 变量名 | 类型 | 示例值 |
---|---|---|---|
返回状态码 | code | Int | 1 |
返回值 = 1 时则成功,其它则失败。 |
|||
返回信息 | msg | String | 查询订单号成功! |
失败时返回原因 |
|||
订单号 | trade_no | String | 2016080622555342651 |
支付跳转url | payurl | String | 无 |
如果返回该字段,则直接跳转到该url支付 |
|||
二维码链接 | qrcode | String | 无 |
如果返回该字段,则根据该url生成二维码 |
|||
小程序跳转url | urlscheme | String | 无 |
如果返回该字段,则使用js跳转该url,可发起微信小程序支付 |
注:payurl、qrcode、urlscheme 三个参数只会返回其中一个
支付结果通知
通知类型:服务器异步通知(notify_url)、页面跳转通知(return_url)
请求方式:GET
请求参数说明(点击字段查看描述详情):
字段名 | 变量名 | 必填 | 类型 | 示例值 |
---|---|---|---|---|
商户ID | pid | Int | 1001 | |
易支付订单号 | trade_no | String | 20160806151343349021 | |
商户订单号 | out_trade_no | String | 20160806151343349 | |
支付方式 | type | String | alipay | |
商品名称 | name | String | VIP会员 | |
商品金额 | money | String | 1.00 | |
支付状态 | trade_status | String | TRADE_SUCCESS | |
返回值 = TRADE_SUCCESS 时则成功,其它则失败。 |
||||
业务扩展参数 | param | String | 默认留空 | |
签名字符串 | sign | String | 202cb962ac59075b964b07152d234b70 | |
签名类型 | sign_type | String | 默认:MD5 |
收到异步通知后,需返回success以表示服务器接收到了订单通知
MD5签名算法
1、将发送或接收到的所有参数按照参数名ASCII码从小到大排序(a-z),sign、sign_type、和空值不参与签名!
2、将排序后的参数拼接成URL键值对的格式,例如 a=b&c=d&e=f
,参数值不要进行url编码。
3、再将拼接好的字符串与商户密钥KEY进行MD5加密得出sign签名参数,sign = md5 ( a=b&c=d&e=f + KEY )
(注意:+ 为各语言的拼接符,不是字符!),md5结果为小写。
4、具体签名与发起支付的示例代码可下载SDK查看。
支付方式列表
请求参数说明:
调用值 | 描述 |
---|---|
alipay | 支付宝 |
wxpay | 微信支付 |
usdt | USDT |
设备类型列表
请求参数说明:
调用值 | 描述 |
---|---|
pc | 电脑浏览器 |
mobile | 手机浏览器 |
手机QQ内浏览器 | |
微信内浏览器 | |
alipay | 支付宝客户端 |
jump | 仅返回支付跳转url |
[API]查询商户信息
URL地址:https://vip.payyun.net/api.php?act=query&pid={商户ID}&key={商户密钥}
请求参数说明:
字段名 | 变量名 | 必填 | 类型 | 示例值 |
---|---|---|---|---|
操作类型 | act | String | query(此API固定值) | |
商户ID | pid | Int | alipay | |
商户密钥 | key | String | 89unJUB8HZ54Hj7x4nUj56HN4nUzUJ8i |
返回结果(点击字段查看描述详情):
字段名 | 变量名 | 类型 | 示例值 |
---|---|---|---|
返回状态码 | code | Int | 1 |
返回值 = 1 时则成功,其它则失败。 |
|||
商户ID | pid | Int | 无 |
商户密钥 | key | String(32) | 89unJUB8HZ54Hj7x4nUj56HN4nUzUJ8i |
商户状态 | active | Int | 1 |
返回值 = 0 时则商户被封禁,= 1 则商户状态正常。 |
|||
商户余额 | money | String | 0.00 |
结算方式 | type | Int | 1 |
返回值 = 1:支付宝,2:微信,3:QQ,4:银行卡。 |
|||
结算账号 | account | String | admin@pay.com |
结算姓名 | username | String | 张三 |
订单总数 | orders | Int | 30 |
今日订单 | order_today | Int | 15 |
昨日订单 | order_lastday | Int | 15 |
[API]查询结算记录
URL地址:https://vip.payyun.net/api.php?act=settle&pid={商户ID}&key={商户密钥}
请求参数说明:
字段名 | 变量名 | 必填 | 类型 | 示例值 |
---|---|---|---|---|
操作类型 | act | String | settle(此API固定值) | |
商户ID | pid | Int | alipay | |
商户密钥 | key | String | 89unJUB8HZ54Hj7x4nUj56HN4nUzUJ8i |
返回结果(点击字段查看描述详情):
字段名 | 变量名 | 类型 | 示例值 |
---|---|---|---|
返回状态码 | code | Int | 1 |
返回值 = 1 时则成功,其它则失败。 |
|||
返回信息 | msg | String | 查询结算记录成功! |
结算记录 | data | Array | 结算记录列表 |
[API]查询单个订单
URL地址:https://vip.payyun.net/api.php?act=settle&pid={商户ID}&key={商户密钥}
请求参数说明:
字段名 | 变量名 | 必填 | 类型 | 示例值 |
---|---|---|---|---|
操作类型 | act | String | order(此API固定值) | |
商户ID | pid | Int | alipay | |
商户密钥 | key | String | 89unJUB8HZ54Hj7x4nUj56HN4nUzUJ8i | |
系统订单号 | trade_no | 选择 | String | 20160806151343312 |
商户订单号 | out_trade_no | 选择 | String | 20160806151343349 |
提示:系统订单号 和 商户订单号 二选一传入即可,如果都传入以系统订单号为准!
返回结果(点击字段查看描述详情):
字段名 | 变量名 | 类型 | 示例值 |
---|---|---|---|
返回状态码 | code | Int | 1 |
返回值 = 1 时则成功,其它则失败。 |
|||
返回信息 | msg | String | 查询订单号成功! |
平台订单号 | trade_no | String | 2016080622555342651 |
码支付支付订单号 |
|||
商户订单号 | out_trade_no | String | 20160806151343349 |
商户系统内部的订单号 |
|||
第三方订单号 | api_trade_no | String | 20160806151343349 |
支付宝微信等接口方订单号 |
|||
支付方式 | type | String | alipay |
商户ID | pid | Int | 1001 |
创建订单时间 | 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 |
未支付返回值 = 0 ,支付成功则 = 1 。 |
|||
业务扩展参数 | param | String | 默认留空 |
支付者账号 | buyer | String | 默认留空 |
[API]批量查询订单
URL地址:https://vip.payyun.net/api.php?act=settle&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地址:https://vip.payyun.net/api.php?act=refund
请求方式:POST
请求参数说明:
字段名 | 变量名 | 必填 | 类型 | 示例值 |
---|---|---|---|---|
商户ID | pid | Int | 1001 | |
商户密钥 | key | String | 89unJUB8HZ54Hj7x4nUj56HN4nUzUJ8i | |
易支付订单号 | trade_no | 特殊可选 | String | 20160806151343349021 |
商户订单号 | out_trade_no | 特殊可选 | String | 20160806151343349 |
订单支付时传入的商户订单号,商家自定义且保证商家系统中唯一。 |
||||
退款金额 | money | String | 1.00 | |
少数通道需要与原订单金额一致。 |
注:trade_no、out_trade_no 不能同时为空,如果都传了以trade_no为准
返回结果(点击字段查看描述详情):
字段名 | 变量名 | 类型 | 示例值 |
---|---|---|---|
返回状态码 | code | Int | 1 |
返回值 = 1 时则成功,其它则失败。 |
|||
返回信息 | msg | String | 退款成功 |
SDK下载
SDK.zip
SDK版本:V1.3