API开发文档

API开发文档

POST
页面跳转支付
/submit.php

POST 或 GET(推荐POST,不容易被劫持或屏蔽)

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

请求参数
参数名 类型 必填 默认值 描述
pid String 1001 代收PID
type String alipay 支付方式列表
out_trade_no String 20160806151343349 商户订单号
notify_url String http://***.0.0.1/notify_url.php 异步通知地址(服务器异步通知地址)
return_url String http://***.0.0.1/return_url.php 跳转通知地址(页面跳转通知地址)
name String VIP会员 商品名称(如超过127个字节会自动截取)
money String 1.00 商品金额(单位:元,最大2位小数)
param String 没有请留空 业务扩展参数(支付后原样返回)
mid String 没有请留空 账号MID(指定账号收款)
sign String 202cb962ac59075b964b07152d234b70 签名算法点此查看
sign_type String MD5 签名类型(默认为MD5)
支付方式(type)不传会跳转到收银台支付
POST
API接口支付
/mapi.php

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

请求参数
参数名 类型 必填 默认值 描述
pid String 1001 代收PID
type String alipay 支付方式列表
out_trade_no String 20160806151343349 商户订单号
notify_url String http://***.0.0.1/notify_url.php 异步通知地址(服务器异步通知地址)
return_url String http://***.0.0.1/return_url.php 跳转通知地址(页面跳转通知地址)
name String VIP会员 商品名称(如超过127个字节会自动截取)
money String 1.00 商品金额(单位:元,最大2位小数)
param String 没有请留空 业务扩展参数(支付后原样返回)
mid String 没有请留空 账号MID(指定账号收款)
clientip String 192.168.1.100 用户发起支付的IP地址
device String pc 根据当前用户浏览器的UA判断,传入用户所使用的浏览器或设备类型,默认为pc设备类型列表
sign String 202cb962ac59075b964b07152d234b70 签名算法点此查看
sign_type String MD5 签名类型(默认为MD5)
响应示例
{
  "code": 1,
  "msg": "创建订单成功",
  "data": {
      "trade_no": 2025070219004217862,
      "out_trade_no": 20160806151343349,
      "pay_url": "http://***.0.0.1/xxx/?trade_no=xxx"
  }
}
GET
查询单个订单
/api.php

系统订单号 和 商户订单号 二选一传入即可,如果都传入以系统订单号为准!

请求参数
参数名 类型 必填 默认值 描述
act String order 接口分类
pid String 1001 代收PID
key String 89unJUB8HZ54Hj7x4nUj56HN4nUzUJ8i 代收KEY
trade_no String 选择 20160806151343312 系统订单号
out_trade_no String 选择 20160806151343349 商户订单号
响应示例
{
  "code": 1,
  "msg": "查询结算记录成功!",
  "data": {
    "trade_no": "2025070303592145110",
    "out_trade_no": "20160806151343349",
    "api_trade_no": "68658f9933490",
    "type": "alipay",
    "pid": "1001",
    "create_time": "2025-07-03 03:59:21",
    "end_time": null,
    "name": "VIP会员",
    "money": "1.00",
    "status": 0,
    "param": null
  }
}
单个 查询 订单
GET
批量查询订单
/api.php
请求参数
参数名 类型 必填 默认值 描述
act String orders 接口分类
pid String 1001 代收PID
key String 89unJUB8HZ54Hj7x4nUj56HN4nUzUJ8i 代收KEY
limit Int 20 查询订单数量(返回的订单数量,最大50)
page Int 1 页码(当前查询的页码)
响应示例
{
    "code": 1,
    "msg": "查询结算记录成功!",
    "data": [
        {
            "trade_no": "2025070122241671137",
            "out_trade_no": "2025070122241355006",
            "api_trade_no": null,
            "type": "alipay",
            "pid": "1001",
            "create_time": "2025-07-01 22:24:17",
            "end_time": null,
            "name": "账户充值",
            "money": "200.00",
            "status": 0,
            "param": null
        },
        {
            "trade_no": "2025070122244671928",
            "out_trade_no": "2025070122244344342",
            "api_trade_no": null,
            "type": "alipay",
            "pid": "1001",
            "create_time": "2025-07-01 22:24:46",
            "end_time": null,
            "name": "账户充值",
            "money": "100.00",
            "status": 0,
            "param": null
        }
    ],
    "count": 5
}
批量 查询 订单
GET
支付结果通知

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

请求参数
参数名 类型 必填 默认值 描述
pid String 1001 代收PID
trade_no String 20160806151343349021 系统订单号
out_trade_no String 20160806151343349 商户订单号
type String alipay 支付方式列表
name String VIP会员 商品名称(如超过127个字节会自动截取)
money String 1.00 商品金额(单位:元,最大2位小数)
trade_status String TRADE_SUCCESS 支付状态(只有TRADE_SUCCESS是成功)
param String 没有请留空 业务扩展参数(支付后原样返回)
sign String 202cb962ac59075b964b07152d234b70 签名算法点此查看
sign_type String MD5 签名类型(默认为MD5)
响应示例
收到异步通知后,需返回success以表示服务器接收到了订单通知
同步 异步 通知 回调
sign
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查看。
                        
算法 签名 MD5
type
支付方式列表
调用值 描述
alipay 支付宝
wxpay 微信支付
qqpay QQ钱包
usdt USDT
bank 银行卡
device
设备类型列表
调用值 描述
pc 电脑浏览器
mobile 手机浏览器
qq 手机QQ内浏览器
wechat 微信内浏览器
alipay 支付宝客户端