接口规范:
请求数据格式:application/x-www-form-urlencoded
返回数据格式:JSON
签名算法:MD5
字符编码:UTF-8
此接口可用于用户前台直接发起支付,使用form表单跳转或拼接成url跳转。
URL地址:https://api.kuaixiaopu.com/submit.php
请求方式: POST 或 GET(推荐POST,不容易被劫持或屏蔽)
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 商户ID | pid | 是 | Int | 1001 | |
| 支付方式 | type | 否 | String | alipay | 支付方式列表 |
| 商户订单号 | out_trade_no | 是 | String | 20160806151343349 | |
| 异步通知地址 | notify_url | 是 | String | http://www.pay.com/notify_url.php | 服务器异步通知地址 |
| 跳转通知地址 | return_url | 是 | String | http://www.pay.com/return_url.php | 页面跳转通知地址 |
| 商品名称 | name | 是 | String | VIP会员 | 如超过127个字节会自动截取 |
| 商品金额 | money | 是 | String | 1.00 | 单位:元,最大2位小数 |
| 业务扩展参数 | param | 否 | String | 支付后原样返回 | |
| 签名字符串 | sign | 是 | String | 202cb962ac59075b964b07152d234b70 | 签名算法点此查看 |
| 签名类型 | sign_type | 是 | String | MD5 | 默认为MD5 |
注意:支付方式(type)不传会跳转到收银台支付
此接口可用于服务器后端发起支付请求,会返回支付二维码链接或支付跳转url。
URL地址:https://api.kuaixiaopu.com/mapi.php
请求方式: POST
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 商户ID | pid | 是 | Int | 1001 | |
| 支付方式 | type | 是 | String | alipay | 支付方式列表 |
| 商户订单号 | out_trade_no | 是 | String | 20160806151343349 | |
| 异步通知地址 | notify_url | 是 | String | http://www.pay.com/notify_url.php | 服务器异步通知地址 |
| 跳转通知地址 | return_url | 否 | String | http://www.pay.com/return_url.php | 页面跳转通知地址 |
| 商品名称 | name | 是 | String | VIP会员 | 如超过127个字节会自动截取 |
| 商品金额 | money | 是 | String | 1.00 | 单位:元,最大2位小数 |
| 用户IP地址 | clientip | 是 | String | 192.168.1.100 | 用户发起支付的IP地址 |
| 设备类型 | device | 否 | String | pc | 根据用户浏览器的UA判断,默认为pc 设备类型列表 |
| 业务扩展参数 | param | 否 | String | 支付后原样返回 | |
| 签名字符串 | sign | 是 | String | 202cb962ac59075b964b07152d234b70 | 签名算法点此查看 |
| 签名类型 | sign_type | 是 | String | MD5 | 默认为MD5 |
| 字段名 | 变量名 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|
| 返回状态码 | code | Int | 1 | 1为成功,其它值为失败 |
| 返回信息 | msg | String | 失败时返回原因 | |
| 订单号 | trade_no | String | 20160806151343349 | 支付订单号 |
| 支付跳转url | payurl | String | https://api.kuaixiaopu.com/pay/wxpay/202010903/ | 如果返回该字段,则直接跳转到该url支付 |
| 二维码链接 | qrcode | String | weixin://wxpay/bizpayurl?pr=04IPMKM | 如果返回该字段,则根据该url生成二维码 |
| 小程序跳转url | urlscheme | String | weixin://dl/business/?ticket=xxx | 如果返回该字段,则使用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 | 默认为MD5 |
重要:收到异步通知后,需返回 success 以表示服务器接收到了订单通知
a=b&c=d&e=f,参数值不要进行url编码。sign = md5 ( a=b&c=d&e=f + KEY ) (注意:+ 为各语言的拼接符,不是字符!),md5结果为小写。| 调用值 | 描述 |
|---|---|
alipay | 支付宝 |
wxpay | 微信支付 |
| 调用值 | 描述 |
|---|---|
pc | 电脑浏览器 |
mobile | 手机浏览器 |
qq | 手机QQ内浏览器 |
wechat | 微信内浏览器 |
alipay | 支付宝客户端 |
jump | 仅返回支付跳转url |
URL地址:https://api.kuaixiaopu.com/api.php?act=query&pid={商户ID}&key={商户密钥}
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 操作类型 | act | 是 | String | query | 此API固定值 |
| 商户ID | pid | 是 | Int | 1001 | |
| 商户密钥 | key | 是 | String | 89unJUB8HZ54Hj7x4nUj56HN4nUzUJ8i |
| 字段名 | 变量名 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|
| 返回状态码 | code | Int | 1 | 1为成功,其它值为失败 |
| 商户ID | pid | Int | 1001 | 商户ID |
| 商户密钥 | key | String(32) | 89unJUB8HZ54Hj7x4nUj56HN4nUzUJ8i | 商户密钥 |
| 商户状态 | active | Int | 1 | 1为正常,0为封禁 |
| 商户余额 | 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 | 昨日订单数量 |
URL地址:https://api.kuaixiaopu.com/api.php?act=settle&pid={商户ID}&key={商户密钥}
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 操作类型 | act | 是 | String | settle | 此API固定值 |
| 商户ID | pid | 是 | Int | 1001 | |
| 商户密钥 | key | 是 | String | 89unJUB8HZ54Hj7x4nUj56HN4nUzUJ8i |
| 字段名 | 变量名 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|
| 返回状态码 | code | Int | 1 | 1为成功,其它值为失败 |
| 返回信息 | msg | String | 查询结算记录成功! | |
| 结算记录 | data | Array | 结算记录列表 |
URL地址:https://api.kuaixiaopu.com/api.php?act=order&pid={商户ID}&key={商户密钥}&trade_no={订单号}
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 操作类型 | act | 是 | String | order | 此API固定值 |
| 商户ID | pid | 是 | Int | 1001 | |
| 商户密钥 | key | 是 | String | 89unJUB8HZ54Hj7x4nUj56HN4nUzUJ8i | |
| 商户订单号 | out_trade_no | 否 | String | 20160806151343349 | 商户系统内部的订单号 |
| 易支付订单号 | trade_no | 否 | String | 20160806151343349021 | 好收米订单号,与out_trade_no二选一 |
| 字段名 | 变量名 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|
| 返回状态码 | code | Int | 1 | 1为成功,其它值为失败 |
| 商户ID | pid | Int | 1001 | 商户ID |
| 易支付订单号 | 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为成功,WAIT_BUYER_PAY为等待支付 |
| 创建时间 | addtime | String | 2016-08-06 15:13:43 | 订单创建时间 |
| 结束时间 | endtime | String | 2016-08-06 15:13:55 | 订单支付时间 |
| 业务扩展参数 | param | String |
URL地址:https://api.kuaixiaopu.com/api.php?act=orders&pid={商户ID}&key={商户密钥}&limit={查询数量}
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 操作类型 | act | 是 | String | orders | 此API固定值 |
| 商户ID | pid | 是 | Int | 1001 | |
| 商户密钥 | key | 是 | String | 89unJUB8HZ54Hj7x4nUj56HN4nUzUJ8i | |
| 查询数量 | limit | 否 | Int | 50 | 返回订单数量,默认50,最大1000 |
| 起始时间 | date_start | 否 | String | 2016-08-06 00:00:00 | 订单创建起始时间 |
| 结束时间 | date_end | 否 | String | 2016-08-06 23:59:59 | 订单创建结束时间 |
| 字段名 | 变量名 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|
| 返回状态码 | code | Int | 1 | 1为成功,其它值为失败 |
| 返回信息 | msg | String | 查询订单成功! | |
| 订单总数 | count | Int | 50 | 返回的订单总数 |
| 订单列表 | data | Array | 订单列表 | 订单对象数组 |
URL地址:https://api.kuaixiaopu.com/api.php?act=refund&pid={商户ID}&key={商户密钥}&trade_no={订单号}
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 操作类型 | act | 是 | String | refund | 此API固定值 |
| 商户ID | pid | 是 | Int | 1001 | |
| 商户密钥 | key | 是 | String | 89unJUB8HZ54Hj7x4nUj56HN4nUzUJ8i | |
| 商户订单号 | out_trade_no | 否 | String | 20160806151343349 | 商户系统内部的订单号 |
| 易支付订单号 | trade_no | 否 | String | 20160806151343349021 | 好收米订单号,与out_trade_no二选一 |
| 退款金额 | money | 否 | String | 1.00 | 退款金额,留空则全额退款 |
| 字段名 | 变量名 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|
| 返回状态码 | code | Int | 1 | 1为成功,其它值为失败 |
| 返回信息 | msg | String | 退款申请已提交! | 退款申请已提交,请等待系统处理 |
注意:退款申请提交后,系统会自动处理。处理结果将通过异步通知(notify_url)或API查询方式获取。