聚鑫-关闭订单接口

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

1. 接口描述

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

通过此接口关闭此前已创建的订单,关闭后,用户将无法继续付款。仅能关闭创建后未支付的订单

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CloseOrder
Version String 公共参数,本接口取值:2019-08-20
Region String 公共参数,详见产品支持的 地域列表
MidasAppId String 聚鑫分配的支付主MidasAppid
UserId String 用户Id,长度不小于5位, 仅支持字母和数字的组合
MidasSecretId String 聚鑫分配的安全ID
MidasSignature String 按照聚鑫安全密钥计算的签名
OutTradeNo String 业务订单号,OutTradeNo , TransactionId二选一,不能都为空,优先使用 OutTradeNo
TransactionId String 聚鑫订单号,OutTradeNo , TransactionId二选一,不能都为空,优先使用 OutTradeNo

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 关闭订单请求示例

用于关闭未支付订单的场景,确保用户不会重复支付。

输入示例

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

输出示例

{
  "RequestId": "43941f8c-270a-4b16-b385-44e772549c6c"
}

5. 开发者资源

API Explorer

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

SDK

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

命令行工具

6. 错误码

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

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