订单查询接口文档

Order Query API Documentation

基本信息
接口名称
订单查询
请求方式
POST
Content-Type
application/json
字符编码
UTF-8
接口说明
功能描述
根据商户订单号查询订单详情
签名方式(请求)
MD5(与下单接口一致)
签名方式(响应)
SM3withSM2(与回调接口一致)
请求参数
参数名 类型 必填 描述
merchantNo string 是 商户号(与下单接口一致)
outTradeNo string 是 商户订单号
nonceStr string 是 随机字符串(16位,建议使用UUID)
timestamp string 是 毫秒时间戳
signType string 是 签名类型:MD5
sign string 是 签名(MD5,32位小写)
请求示例
{
    "merchantNo": "M10001",
    "outTradeNo": "202405180001",
    "nonceStr": "abc123def4567890",
    "timestamp": "1716015000000",
    "signType": "MD5",
    "sign": "abc123def4567890abc123def4567890"
}
请求签名规则(MD5)
1
参数排序
所有参数(排除 sign)按参数名 ASCII 码升序排序
2
拼接字符串
将排序后的参数按 key=value 格式用 & 连接
3
拼接密钥
末尾拼接 &key=商户密钥(与下单接口使用相同密钥)
4
MD5 加密
计算 MD5(32位小写)
待签名示例
merchantNo=M10001&nonceStr=abc123def4567890&outTradeNo=202405180001&signType=MD5&timestamp=1716015000000&key=your_merchant_key
响应参数
参数名 类型 必填 描述
code string 是 响应码:SUCCESS-成功,FAIL-失败
message string 是 响应信息
data object 否 响应数据(成功时返回)
data 对象
参数名 类型 必填 描述
systemOrderNo string 是 平台系统订单号
outTradeNo string 是 商户订单号
totalFee int 是 订单应付金额(单位:分)
actualAmount int 是 订单实付金额(单位:分)
orderState int 是 订单状态:1-成功,2-失败,3-处理中
successTime string 否 订单支付成功时间(格式:yyyy-MM-dd HH:mm:ss)
merchantId string 是 商户ID
productCode string 是 产品编码
tradeType int 否 交易类型:1-代收,2-代付
attach string 否 附加数据,下单时原样返回
nonceStr string 是 随机字符串(16位)
timestamp string 是 毫秒时间戳(响应时间)
signType string 是 签名类型:SM3withSM2
sign string 是 国密签名(Base64编码,ASN.1 DER格式)
响应示例
成功响应
{
    "code": "SUCCESS",
    "message": "查询成功",
    "data": {
        "systemOrderNo": "T202405180001234",
        "outTradeNo": "202405180001",
        "totalFee": 100,
        "actualAmount": 100,
        "orderState": 1,
        "successTime": "2024-05-18 15:30:00",
        "merchantId": "10001",
        "productCode": "ALIPAY_WAP",
        "tradeType": 1,
        "attach": "测试订单",
        "nonceStr": "xyz789abc1234567",
        "timestamp": "1716015600000",
        "signType": "SM3withSM2",
        "sign": "MEUCIQD..."
    }
}
失败响应
{
    "code": "FAIL",
    "message": "订单不存在",
    "data": null
}
响应签名规则(SM3withSM2)
1
参数排序
所有参数(排除 sign)按参数名 ASCII 码升序排序
2
拼接字符串
将排序后的参数按 key=value 格式用 & 连接
3
生成待签名原文
将拼接后的字符串转换为 UTF-8 字节数组
4
国密签名
使用 SM3withSM2 算法,传入用户ID(1234567812345678)和私钥进行签名,输出 ASN.1 DER 格式 签名
5
Base64 编码
将 ASN.1 DER 格式签名进行 Base64 编码,得到最终的 sign 值
待签名示例(data 对象内的参数)
actualAmount=100&attach=测试订单&merchantId=10001&nonceStr=xyz789abc1234567&orderState=1&outTradeNo=202405180001&productCode=ALIPAY_WAP&signType=SM3withSM2&successTime=2024-05-18 15:30:00&systemOrderNo=T202405180001234&timestamp=1716015600000&totalFee=100&tradeType=1
响应验签示例代码(C#)
public static bool VerifyQueryResponse(Dictionary<string, string> data, AsymmetricKeyParameter publicKey)
{
    if (!data.ContainsKey("sign")) return false;
    
    // 1. Base64 解码签名
    byte[] signature = Convert.FromBase64String(data["sign"]);
    
    // 2. 构建待签名原文(排除 sign)
    var sortedDict = data.Where(x => x.Key != "sign").OrderBy(x => x.Key);
    string signStr = string.Join("&", sortedDict.Select(x => $"{x.Key}={x.Value}"));
    byte[] msg = Encoding.UTF8.GetBytes(signStr);
    
    // 3. 用户ID(固定值)
    byte[] userId = Encoding.UTF8.GetBytes("1234567812345678");
    
    // 4. 验签
    return VerifySm3WithSm2Asn1Rs(msg, userId, signature, publicKey);
}
错误码
错误码描述
1001参数错误
1002签名错误
1003商户不存在
1004订单不存在
1005系统异常
注意事项
⚠️ 重要提醒
  • 请求签名:使用 MD5 方式,与下单接口完全一致(包含 &key=商户密钥)
  • 响应签名:使用 SM3withSM2 方式,与回调接口完全一致(用户ID:1234567812345678,ASN.1 DER 格式)
  • 时间戳:请求和响应均使用毫秒级时间戳
  • 随机字符串:建议使用16位随机字符串,可使用 UUID 去连字符后取前16位
  • 金额单位:统一为分,避免浮点数精度问题
  • 状态说明:1-成功,2-失败,3-处理中