聚鑫-查询订单接口

最近更新时间:2020-01-02 16:53:40

1. 接口描述

接口请求域名: cpdp.tencentcloudapi.com 。

根据订单号,或者用户Id,查询支付订单状态

默认接口请求频率限制:20次/秒。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:QueryOrder
Version String 公共参数,本接口取值:2019-08-20
Region String 公共参数,详见产品支持的 地域列表
MidasAppId String 聚鑫分配的支付主 MidasAppId
UserId String 用户Id,长度不小于5位, 仅支持字母和数字的组合
Type String type=by_order根据订单号 查订单;
type=by_user根据用户id 查订单 。
MidasSecretId String 聚鑫分配的安全ID
MidasSignature String 按照聚鑫安全密钥计算的签名
Count Integer 每页返回的记录数。根据用户 号码查询订单列表时需要传。 用于分页展示。Type=by_order时必填
Offset Integer 记录数偏移量,默认从0开 始。根据用户号码查询订单列 表时需要传。用于分页展示。Type=by_order时必填
StartTime String 查询开始时间,Unix时间戳。Type=by_order时必填
EndTime String 查询结束时间,Unix时间戳。Type=by_order时必填
OutTradeNo String 业务订单号,OutTradeNo与 TransactionId不能同时为 空,都传优先使用 OutTradeNo
TransactionId String 聚鑫订单号,OutTradeNo与 TransactionId不能同时为 空,都传优先使用 OutTradeNo

3. 输出参数

参数名称 类型 描述
TotalNum Integer 返回订单数
OrderList Array of QueryOrderOutOrderList 查询结果的订单列表
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 订单查询请求示例

适用于单个订单查询状态的场景

输入示例

https://cpdp.tencentcloudapi.com/?Action=QueryOrder
&<公共请求参数>
&MidasAppId=your_midas_app_id
&UserId=your_user_id
&Type=by_order
&OutTradeNo=your_order_no
&MidasSecretId=your_midas_secret_id
&MidasSignature=your_midas_signature

输出示例

{
  "TotalNum": 1,
  "OrderList": [
    {
      "MidasAppId": "your_midas_app_id",
      "Amt": 1,
      "UserId": "your_user_id",
      "CashAmt": "",
      "Metadata": "",
      "PayTime": "1576225234",
      "CouponAmt": "",
      "OrderTime": "1576224034",
      "ProductId": "product_111",
      "SceneInfo": "",
      "OrderState": "0",
      "Channel": "",
      "RefundFlag": "0",
      "OutTradeNo": "20191210182602",
      "ProductName": "测试商品",
      "CallBackTime": "1576230034",
      "CurrencyType": "CNY",
      "AcctSubAppId": "",
      "TransactionId": "E-191213160100048000",
      "ChannelOrderId": "",
      "SubOrderList": [
        {
          "Amt": 1,
          "SubMchIncome": 1,
          "Metadata": "测试透传字段",
          "OriginalAmt": 1,
          "PlatformIncome": 0,
          "ProductDetail": "子订单物品描述",
          "ProductName": "子订单物品名称",
          "SettleCheck": 0,
          "SubAppId": "your_sub_app_id",
          "SubOutTradeNo": "your_sub_out_trade_no"
        }
      ],
      "ChannelExternalOrderId": ""
    }
  ],
  "RequestId": "048b9ee5-7eac-43df-b0e8-d7fb585180aa"
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.AppDeny 该业务代码对应的配置没有发布到相应的环境
FailedOperation.NoRecord 订单不存在
InvalidParameter 参数错误