首页 > 开发文档

开发文档

爱客710966年前 (2021-03-01)

协议规则

  • 请求数据格式:application/x-www-form-urlencoded

  • 返回数据格式:JSON

  • 签名算法:MD5

  • 字符编码:UTF-8

页面跳转支付

该接口适用于前端页面发起支付,支持 Form 表单跳转或 URL 拼接跳转。 接口地址:https://域名/submit.php请求方式:POST 或 GET(推荐 POST,降低劫持、屏蔽风险)

请求参数

表格

字段名变量名必填类型示例值描述
商户 IDpid是Int1001商户编号
支付方式type否Stringalipay支付渠道;不传则跳转统一收银台
商户订单号out_trade_no是String20160806151343349商户本地订单编号
异步通知地址notify_url是Stringhttp://www.pay.com/notify_url.php服务器异步回调地址
页面跳转地址return_url是Stringhttp://www.pay.com/return_url.php用户支付完成后页面跳转地址
商品名称name是StringVIP 会员超过 127 字节自动截断
商品金额money是String1.00金额单位:元,保留 2 位小数
业务扩展参数param否String
自定义参数,支付回调原样返回,无则留空
签名字符串sign是String202cb962ac59075b964b07152d234b70签名结果
签名类型sign_type是StringMD5固定 MD5

API 接口支付

后端服务端调用接口,返回支付跳转链接、二维码链接或小程序唤起地址。 接口地址:https://域名/mapi.php请求方式:POST

请求参数

表格

字段名变量名必填类型示例值描述
商户 IDpid是Int1001商户编号
支付方式type是Stringalipay支付渠道
商户订单号out_trade_no是String20160806151343349商户本地订单编号
异步通知地址notify_url是Stringhttp://www.pay.com/notify_url.php服务器异步回调地址
页面跳转地址return_url否Stringhttp://www.pay.com/return_url.php支付完成页面跳转地址
商品名称name是StringVIP 会员超过 127 字节自动截断
商品金额money是String1.00金额单位:元,保留 2 位小数
用户 IP 地址clientip是String192.168.1.100用户客户端 IP
设备类型device否Stringpc读取 UA 识别,不传默认 pc
业务扩展参数param否String
自定义参数,回调原样返回,无则留空
签名字符串sign是String202cb962ac59075b964b07152d234b70签名结果
签名类型sign_type是StringMD5固定 MD5

接口返回 JSON

表格

字段名变量名类型示例值描述
返回状态码codeInt11 = 成功,其他为失败
返回信息msgString
失败时返回错误说明
平台订单号trade_noString20160806151343349平台生成订单号
支付跳转链接payurlStringhttps://xxx存在此字段直接跳转支付
二维码链接qrcodeStringweixin://xxx存在此字段生成二维码
小程序跳转地址urlschemeStringweixin://dl/business/?ticket=xxxJS 唤起微信小程序支付

备注:payurl、qrcode、urlscheme 同一请求只会返回其中一个字段

支付结果通知

通知分为两类:服务器异步通知notify_url、前端页面跳转通知return_url请求方式:GET

回调参数

表格

字段名变量名必填类型示例值描述
商户 IDpid是Int1001商户编号
平台订单号trade_no是String20160806151343349021聚合平台订单号
商户订单号out_trade_no是String20160806151343349商户本地订单号
支付方式type是Stringalipay支付渠道
商品名称name是StringVIP 会员商品标题
商品金额money是String1.00支付金额
支付状态trade_status是StringTRADE_SUCCESS仅TRADE_SUCCESS代表支付成功
业务扩展参数param否String
自定义回传参数
签名字符串sign是String202cb962ac59075b964b07152d234b70签名校验串
签名类型sign_type是StringMD5固定 MD5

重要:收到异步通知,业务处理完成后,页面直接输出字符串 success,代表接收成功。

MD5 签名算法

  1. 将待签名全部参数,按照参数名 ASCII 码升序 (a-z)排序;sign、sign_type、空值参数不参与签名

  2. 排序后拼接为 URL 键值对格式:a=b&c=d&e=f,参数值不要 URL 编码

  3. 将拼接字符串末尾拼接商户密钥 KEY,执行 MD5,结果转为小写。公式:sign = md5(参数串 + KEY)

提示:+代表字符串拼接,不是文本加号字符

  1. 签名示例、各语言 Demo 代码,可以前往【软件下载】获取 SDK。

渠道与设备枚举

支付方式列表

表格

调用值描述
alipay支付宝
wxpay微信支付
qqpayQQ 钱包

设备类型列表

表格

调用值描述
pc电脑浏览器
mobile手机浏览器
qq手机 QQ 内置浏览器
wechat微信内置浏览器
alipay支付宝客户端
jump仅返回支付跳转 URL

API:查询商户信息

接口地址:https://域名/api.php?act=query&pid={商户ID}&key={商户密钥}

请求参数

表格

字段名变量名必填类型示例值描述
操作类型act是Stringquery固定值 query
商户 IDpid是Int1001商户编号
商户密钥key是String89unJUB8HZ54Hj7x4nUj56HN4nUzUJ8i商户密钥

返回结果

表格

字段名变量名类型示例值描述
返回状态码codeInt11 成功,其他失败
商户 IDpidInt1001商户编号
商户密钥keyString(32)89unJUB8HZ54Hj7x4nUj56HN4nUzUJ8i密钥串
商户状态activeInt11 正常,0 封禁
商户余额moneyString0.00账户余额
结算方式typeInt11 支付宝,2 微信,3QQ,4 银行卡
结算账号accountStringadmin@pay.com收款结算账号
结算姓名usernameString张三结算实名
订单总数ordersInt30历史订单总量
今日订单order_todayInt15当日订单数量
昨日订单order_lastdayInt15昨日订单数量

API:查询单个订单

接口地址:https://域名/api.php?act=order&pid={商户ID}&key={商户密钥}&out_trade_no={商户订单号}

请求参数

表格

字段名变量名必填类型示例值描述
操作类型act是Stringorder固定值 order
商户 IDpid是Int1001商户编号
商户密钥key是String89unJUB8HZ54Hj7x4nUj56HN4nUzUJ8i商户密钥
平台订单号trade_no选填String20160806151343312平台订单号
商户订单号out_trade_no选填String20160806151343349商户本地订单号

提示:trade_no、out_trade_no二选一即可;两个同时传入,优先使用平台订单号trade_no

返回结果

表格

字段名变量名类型示例值描述
返回状态码codeInt11 成功,其他失败
返回信息msgString查询订单号成功!提示文本
平台订单号trade_noString2016080622555342651平台订单编号
商户订单号out_trade_noString20160806151343349商户本地订单号
第三方订单号api_trade_noString20160806151343349微信 / 支付宝原始单号
支付方式typeStringalipay支付渠道
商户 IDpidInt1001商户编号
创建订单时间addtimeString2016-08-06 22:55:52下单时间
交易完成时间endtimeString2016-08-06 22:55:52支付完成时间
商品名称nameStringVIP 会员商品标题
商品金额moneyString1.00订单金额
支付状态statusInt01 支付成功,0 未支付
业务扩展参数paramString
自定义回传参数
付款账号buyerString
付款方账号

API:批量查询订单

接口地址:https://域名/api.php?act=orders&pid={商户ID}&key={商户密钥}

请求参数

表格

字段名变量名必填类型示例值描述
操作类型act是Stringorders固定值 orders
商户 IDpid是Int1001商户编号
商户密钥key是String89unJUB8HZ54Hj7x4nUj56HN4nUzUJ8i商户密钥
查询条数limit否Int20最大 50 条
页码page否Int1分页页码

返回结果

表格

字段名变量名类型示例值描述
返回状态码codeInt11 成功,其他失败
返回信息msgString查询结算记录成功!提示文本
订单列表dataArray
订单数组,数组内结构参考【查询单个订单】

开发文档  第1张

MaPay 码支付|免签约聚合收款平台

每一笔支付都承载着故事,感谢您选择我们

  • 性能稳定
    性能稳定

    极速回调,稳定可靠

  • 安全防护
    安全防护

    多层防护,交易安心

  • 持续更新
    持续更新

    迭代维护,多端兼容

  • 用户体验
    用户体验

    贴心服务,体验优先