API文档

本文档介绍如何调用 大猫码支付 接口，请仔细阅读后进行开发对接。

接口说明

接口采用 HTTP 协议，支持 GET 和 POST 请求方式，参数编码格式为 UTF-8。

接口地址

支付方式

Submit 支付请求

页面跳转方式，调用后直接跳转到支付页面，适合网页端对接。

请求参数

MAPI 支付请求

返回 JSON 数据，包含支付链接和二维码信息，适合 API 对接或自定义支付页面。

请求参数

与 Submit 接口参数相同，详见上方表格。

返回示例

{
    "code": 1,
    "msg": "获取成功",
    "trade_no": "YRPay1234520231229120000",
    "price": "10.00",
    "payurl": "https://xxx.com/pay.php/pay?trade_no=xxx",
    "qrcode": "二维码内容或链接",
    "urlscheme": ""
}

返回参数

异步通知

用户支付成功后，系统会向商户设置的 notify_url 发送 GET 请求。

同步跳转

支付完成后，用户浏览器会跳转到 return_url，参数与异步通知相同。

查询商户信息

查询当前商户的账户信息，包括余额、状态等。

请求参数

返回示例

{
    "code": 1,
    "msg": "获取成功",
    "pid": 1001,
    "username": "testuser",
    "money": "100.00",
    "status": 1,
    "vip_time": "2025-12-31 23:59:59",
    "create_time": "2024-01-01 00:00:00"
}

查询单个订单

根据订单号查询单个订单的详细信息。

请求参数

返回示例

{
    "code": 1,
    "msg": "获取成功",
    "trade_no": "YRPay1234520231229120000",
    "out_trade_no": "202312290001",
    "type": "alipay",
    "name": "测试商品",
    "money": "10.00",
    "price": "10.00",
    "status": 1,
    "addtime": "2023-12-29 12:00:00",
    "endtime": "2023-12-29 12:05:00"
}

批量查询订单

分页查询商户的订单列表，支持按状态、类型、时间筛选。

请求参数

返回示例

{
    "code": 1,
    "msg": "获取成功",
    "total": 100,
    "page": 1,
    "limit": 20,
    "list": [
        {
            "trade_no": "YRPay1234520231229120000",
            "out_trade_no": "202312290001",
            "type": "alipay",
            "name": "商品名称",
            "money": "10.00",
            "price": "10.00",
            "status": 1,
            "addtime": "2023-12-29 12:00:00",
            "endtime": "2023-12-29 12:05:00"
        }
    ]
}

PC 监控心跳

用于 PC 客户端维持在线状态，确保监控软件正常运行。

请求参数

返回示例

{
    "code": 1,
    "msg": "Success"
}

PC 监控回调

PC 客户端监控到收款后，调用此接口进行回调通知。

请求参数

返回示例

{
    "code": 1,
    "msg": "Success"
}

APP 监控心跳

用于手机 APP 客户端维持在线状态，一次性更新该商户下所有APP通道的心跳。

请求参数

返回示例

{
    "code": 1,
    "msg": "Success",
    "updated": 3
}

返回参数

APP 监控回调

APP 客户端监控到收款后，调用此接口进行回调通知。系统会根据支付类型和金额匹配对应的待支付订单。

请求参数

返回示例

{
    "code": 1,
    "msg": "Success"
}

SMSF 监控心跳

用于 SMSF 应用通知转发客户端维持在线状态，一次性更新该商户下所有SMSF通道的心跳。

请求参数

返回示例

{
    "code": 1,
    "msg": "Success",
    "updated": 2
}

返回参数

SMSF 监控回调

SMSF 客户端监控到收款通知后，调用此接口进行回调通知。系统会根据支付类型和金额匹配对应的待支付订单。

请求参数

返回示例

{
    "code": 1,
    "msg": "Success"
}

微信收款单心跳

用于微信PC自挂(收款单免输)客户端维持在线状态，确保监控软件正常运行。

请求参数

返回示例

{
    "code": 1,
    "msg": "Success"
}

微信收款单回调

微信PC自挂客户端监控到收款后，调用此接口进行回调通知。通过备注（系统订单号）匹配订单。

请求参数

返回示例

{
    "code": 1,
    "msg": "Success"
}

上传微信收款单Cookie

上传微信收款单的认证Cookie，用于创建收款单和获取二维码。

请求参数

Cookie格式说明

Cookie需要先转为JSON格式，然后进行Base64编码后传递。JSON格式如下：

{
    "sid": "会话ID",
    "account_id": "账户ID",
    "shop_id": "店铺ID(可选)",
    "account_type": "账户类型: 1=门店, 2=微信, 3=收款小账本"
}

返回示例

{
    "code": 1,
    "msg": "Cookie uploaded successfully"
}

签名算法

签名用于验证请求的合法性，生成步骤如下：

1. 将所有参数按参数名 ASCII 码从小到大排序（字典序）
2. 将参数按 key=value 格式用 & 连接成字符串
3. 在字符串末尾直接拼接商户密钥
4. 对拼接后的字符串进行 MD5 加密，得到32位小写签名

代码示例

PHP - 发起支付

<?php
$pid = '1001';            // 商户ID
$key = 'YourSecretKey';   // 商户密钥
$apiUrl = 'https://pay.xn--6krz1l.xn--io0a7i';

$params = [
    'pid'          => $pid,
    'type'         => 'alipay',
    'out_trade_no' => date('YmdHis') . mt_rand(1000,9999),
    'notify_url'   => 'https://你的域名/notify.php',
    'return_url'   => 'https://你的域名/return.php',
    'name'         => '商品名称',
    'money'        => '10.00',
];

// 生成签名
ksort($params);
$signStr = '';
foreach ($params as $k => $v) {
    if ($v !== '') $signStr .= "{$k}={$v}&";
}
$signStr = rtrim($signStr, '&') . $key;
$params['sign'] = md5($signStr);
$params['sign_type'] = 'MD5';

// 跳转支付
header('Location: ' . $apiUrl . '/submit.php?' . http_build_query($params));
?>

PHP - 异步通知处理

<?php
$key = 'YourSecretKey';

$params = $_GET;
$sign = $params['sign'];
unset($params['sign'], $params['sign_type']);

ksort($params);
$signStr = '';
foreach ($params as $k => $v) {
    if ($v !== '') $signStr .= "{$k}={$v}&";
}
$signStr = rtrim($signStr, '&') . $key;

if (md5($signStr) !== $sign) {
    exit('签名错误');
}

if ($params['trade_status'] !== 'TRADE_SUCCESS') {
    exit('交易未成功');
}

// TODO: 处理订单逻辑
echo 'success';
?>