旧版接口文档

重要提示

此文档为旧版接口文档，仅供已对接旧版接口的商户使用。新商户请使用新版接口进行对接。

旧版接口将逐步停止维护，建议尽快升级到新版接口。

协议规则

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

返回数据格式：JSON

签名算法：MD5

字符编码：UTF-8

页面跳转支付

此接口可用于用户前台直接发起支付，使用form表单跳转或拼接成url跳转。

URL地址：/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

API接口支付

此接口可用于服务器后端发起支付请求，会返回支付二维码链接或支付跳转url。

URL地址：/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 设备类型列表见下方
业务扩展参数 param 否 String 没有请留空 支付后原样返回
签名字符串 sign 是 String 202cb962ac59075b964b07152d234b70 签名算法见下方
签名类型 sign_type 是 String MD5 默认为MD5

返回结果（json）：

字段名 变量名 类型 示例值 描述
返回状态码 code Int 1 1为成功，其它值为失败
返回信息 msg String 失败时返回原因
订单号 trade_no String 20160806151343349 支付订单号
支付跳转url payurl String /pay/wxpay/202010903/ 如果返回该字段，则直接跳转到该url支付
二维码链接 qrcode String weixin://wxpay/bizpayurl?pr=04IPMKM 如果返回该字段，则根据该url生成二维码
小程序跳转url urlscheme String weixin://dl/business/?ticket=xxx 如果返回该字段，则使用js跳转该url，可发起微信小程序支付

支付结果通知

通知类型：服务器异步通知（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

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结果为小写。

设备类型列表

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

[API]查询商户信息

URL地址：/api.php?act=query&pid={商户ID}&key={商户密钥}

请求参数说明：

字段名 变量名 必填 类型 示例值 描述
操作类型 act 是 String query 此API固定值
商户ID pid 是 Int 1001
商户密钥 key 是 String 89unJUB8HZ54Hj7x4nUj56HN4nUzUJ8i

[API]查询结算记录

URL地址：/api.php?act=settle&pid={商户ID}&key={商户密钥}

请求参数说明：

字段名 变量名 必填 类型 示例值 描述
操作类型 act 是 String settle 此API固定值
商户ID pid 是 Int 1001
商户密钥 key 是 String 89unJUB8HZ54Hj7x4nUj56HN4nUzUJ8i

[API]查询单个订单

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

请求参数说明：

字段名 变量名 必填 类型 示例值 描述
操作类型 act 是 String order 此API固定值
商户ID pid 是 Int 1001
商户密钥 key 是 String 89unJUB8HZ54Hj7x4nUj56HN4nUzUJ8i
系统订单号 trade_no 选择 String 20160806151343312
商户订单号 out_trade_no 选择 String 20160806151343349

[API]批量查询订单

URL地址：/api.php?act=orders&pid={商户ID}&key={商户密钥}

请求参数说明：

字段名 变量名 必填 类型 示例值 描述
操作类型 act 是 String orders 此API固定值
商户ID pid 是 Int 1001
商户密钥 key 是 String 89unJUB8HZ54Hj7x4nUj56HN4nUzUJ8i
查询订单数量 limit 否 Int 20 返回的订单数量，最大50

[API]提交订单退款

URL地址：/api.php?act=refund&pid={商户ID}&key={商户密钥}

请求参数说明：

字段名 变量名 必填 类型 示例值 描述
操作类型 act 是 String refund 此API固定值
商户ID pid 是 Int 1001
商户密钥 key 是 String 89unJUB8HZ54Hj7x4nUj56HN4nUzUJ8i
系统订单号 trade_no 选择 String 20160806151343312
商户订单号 out_trade_no 选择 String 20160806151343349
退款金额 money 是 String 1.00 退款金额不能大于订单金额

SDK下载

为了方便您的对接，我们提供了以下语言的SDK：

1. PHP版：点击下载

2. Java版：点击下载

3. Python版：点击下载

4. .NET版：点击下载

注意：旧版接口将逐步停止维护，建议尽快升级到新版接口。如需帮助，请联系客服。