API 接口文档
概述
本 API 为支付聚合平台接口,支持代收(Collection)和代付(Payout)两大业务模块。
所有接口均采用 POST + JSON 方式通信,支持 RSA(默认)和 MD5 两种签名算法。
接口列表
代收接口(Collection)
| 接口 | 路径 | 说明 |
|---|---|---|
| 接口概览 | - | 代收接口总览、签名规则、支付方式、错误码 |
| 代收下单 | POST /api/alliesPay/order | 创建代收订单 |
| 订单查询 | POST /api/alliesPay/query | 查询代收订单状态 |
| 余额查询 | POST /api/alliesPay/queryBalance | 查询商户钱包余额 |
| 回调通知 | POST notifyUrl | 代收支付结果回调 |
代付接口(Payout)
| 接口 | 路径 | 说明 |
|---|---|---|
| 接口概览 | - | 代付接口总览、订单状态、错误码 |
| 代付下单 | POST /api/peerPay/order | 创建代付订单 |
| 订单查询 | POST /api/peerPay/query | 查询代付订单状态 |
| 回调通知 | POST notifyUrl | 代付结果回调 |
支付通道
| 文档 | 说明 |
|---|---|
| 通道概览 | 按国家折叠展示所有支付通道 |
通信协议
- 协议: HTTPS
- 请求方式: POST
- 数据格式: JSON
- 字符编码: UTF-8
签名机制
签名类型
通过请求参数 signType 指定签名算法:
| signType | 算法 | 说明 |
|---|---|---|
RSA | SHA256WithRSA | 默认,更安全 |
MD5 | MD5 (32位大写) | 兼容模式 |
TIP
- 不传
signType时默认使用RSA sign和signType本身不参与签名计算- 响应签名方式与请求一致
RSA 签名流程
1. 提取所有非空参数(排除 sign、signType)
2. 按参数名 ASCII 字典序排序
3. 拼接成 key1=value1&key2=value2...
4. 用 RSA 私钥(SHA256WithRSA)签名
5. Base64 编码 → signMD5 签名流程
1. 提取所有非空参数(排除 sign、signType)
2. 按参数名 ASCII 字典序排序
3. 拼接成 key1=value1&key2=value2...
4. 追加 &key=secretKey
其中 secretKey = MD5(alliesCode + ":" + alliesSecret)
5. MD5 加密 → 转大写 → sign快速签名示例(PHP)
php
<?php
// RSA 签名(推荐)
function rsaSign($params, $rsaPrivateKey) {
unset($params['sign'], $params['signType']);
$params = array_filter($params, fn($v) => $v !== null && $v !== '');
ksort($params);
$content = http_build_query($params);
openssl_sign($content, $signature, $rsaPrivateKey, OPENSSL_ALGO_SHA256);
return base64_encode($signature);
}
// MD5 签名
function md5Sign($params, $alliesCode, $alliesSecret) {
unset($params['sign'], $params['signType']);
$params = array_filter($params, fn($v) => $v !== null && $v !== '');
ksort($params);
$content = http_build_query($params);
$secretKey = strtoupper(md5($alliesCode . ':' . $alliesSecret));
return strtoupper(md5($content . '&key=' . $secretKey));
}通用响应结构
json
{
"code": "10000",
"msg": "success",
...业务字段...,
"sign": "响应签名"
}code 说明
| code | 含义 |
|---|---|
| 10000 | 成功 |
| 其他 | 失败,参考 msg 字段 |
