订单查询接口

此接口用于查询订单的支付状态、支付金额、支付时间等信息。

请求信息

请求URL /api/pay/query
请求方式 POST

请求参数

参数名 类型 必填 示例值 说明
pid Int 是 1001 商户ID
trade_no String 特殊 20160806151343349 平台订单号，与商户订单号必传其一
out_trade_no String 特殊 20160806151343351 商户订单号，与平台订单号必传其一
timestamp String 是 1721206072 当前时间戳，10位整数，单位秒
sign String 是 签名字符串，详见签名规则
sign_type String 是 RSA 签名类型，默认为RSA

返回参数

参数名 类型 示例值 说明
code Int 0 返回状态码，0为成功，其它值为失败
msg String 错误信息，失败时返回原因
trade_no String 20160806151343349 平台订单号
out_trade_no String 20160806151343351 商户订单号
api_trade_no String 40001249985198893 微信支付宝返回的单号
type String alipay 支付方式，详见支付方式列表
status Int 1 支付状态，详见支付状态列表
pid Int 1001 商户ID
addtime String 2024-07-01 16:47:32 订单创建时间
endtime String 2024-07-01 16:49:24 订单完成时间，仅完成才返回
name String 商品名称
money String 1.00 商品金额
refundmoney String 已退款金额，仅部分退款情况才返回
param String 业务扩展参数
buyer String 支付用户标识，一般为openid
clientip String 支付用户IP
timestamp String 1721206072 当前时间戳，10位整数，单位秒
sign String 签名字符串，详见签名规则
sign_type String RSA 签名类型，默认为RSA

支付状态列表

状态值 描述
0 未支付
1 已支付
2 已退款
3 已冻结
4 预授权

返回示例

成功示例：

{
    "code": 0,
    "trade_no": "20160806151343349",
    "out_trade_no": "20160806151343351",
    "api_trade_no": "40001249985198893",
    "type": "alipay",
    "status": 1,
    "pid": 1001,
    "addtime": "2024-07-01 16:47:32",
    "endtime": "2024-07-01 16:49:24",
    "name": "VIP会员",
    "money": "1.00",
    "buyer": "2088102122524333",
    "clientip": "192.168.1.100",
    "timestamp": "1721206072",
    "sign": "xxxxx",
    "sign_type": "RSA"
}

失败示例：

{
    "code": -1,
    "msg": "订单号不存在"
}

其他说明

注意事项