支付API文档

Appearance

友商余额查询接口 ​

接口路径： /alliesPay/bussiness/queryBalance

请求方式： POST

Content-Type： application/x-www-form-urlencoded 或 application/json（两种均支持）

提交方式

本接口支持表单提交和 JSON 提交两种方式，业务参数和签名规则完全一致。详见 旧版 API 概览 - 提交方式说明。

一、请求参数 ​

参数名称参数变量名类型必填说明
签名signString是按签名规则（MD5）
友商IDalliesNoString(255)是接入方友商的唯一 ID，由平台方提供
渠道类型tradeTypeint是与下单时提交参数值相同

请求示例 ​

表单提交：

bash
curl -X POST "http://接口域名/alliesPay/bussiness/queryBalance" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "alliesNo=test001&tradeType=31&sign=3E541783111209F709ACDA0F4BFD17EA"

JSON 提交：

bash
curl -X POST "http://接口域名/alliesPay/bussiness/queryBalance" \
  -H "Content-Type: application/json" \
  -d '{
    "alliesNo": "test001",
    "tradeType": "31",
    "sign": "3E541783111209F709ACDA0F4BFD17EA"
  }'

二、响应参数 ​

参数名称参数变量名类型是否有值说明
返回码codeString(10)是编码为 10000 成功，其他为失败
返回消息msgString(255)是订单成功失败的详细信息
友商编号alliesNoString(255)是接入方友商的唯一 ID
用户余额BalanceNumber(9,2)是用户当前余额，精确到小数点后 2 位
历史累积金额totalAmountNumber(9,2)是友商历史累积金额
余额更新时间updateTimeString(20)是余额最后更新时间，格式为 yyyy-MM-dd HH:mm:ss，例如：2015-01-01 12:45:52

三、响应示例 ​

成功响应示例 ​

json
{
  "code": "10000",
  "msg": "成功",
  "alliesNo": "test001",
  "Balance": "9500.50",
  "totalAmount": "100000.00",
  "updateTime": "2025-01-15 12:30:45"
}

失败响应示例 ​

json
{
  "code": "2004",
  "msg": "友商不存在"
}

四、PHP 调用示例 ​

php
<?php
$params = [
    'alliesNo'  => 'test001',
    'tradeType' => '31',
];

// 排除空值和sign，按ASCII字典序排序
$filteredParams = [];
foreach ($params as $k => $v) {
    if ($v !== '' && $v !== null) {
        $filteredParams[$k] = $v;
    }
}
ksort($filteredParams);
$stringA = http_build_query($filteredParams, '', '&');

// 拼接密钥并生成签名
$key = 'your_api_key_here';
$sign = strtoupper(md5($stringA . '&key=' . $key));
$params['sign'] = $sign;

// 发送请求
$ch = curl_init('http://接口域名/alliesPay/bussiness/queryBalance');
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($params));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);

$result = json_decode($response, true);
if ($result['code'] === '10000') {
    echo "当前余额: " . $result['Balance'] . " 元";
    echo "历史累积: " . $result['totalAmount'] . " 元";
}

五、注意事项 ​

  1. 余额查询频率：建议不要频繁查询余额，避免不必要的 API 调用
  2. 余额更新：余额可能随时变化，以查询结果为准
  3. 代付前检查：代付下单前建议先查询可用余额，确保账户金额充足
  4. 签名验证：建议验证响应签名确保数据安全性