聚鑫-退款接口

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

1. 接口描述

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

如交易订单需退款,可以通过本接口将支付款全部或部分退还给付款方,聚鑫将在收到退款请求并且验证成功之后,按照退款规则将支付款按原路退回到支付帐号。最长支持1年的订单退款。在订单包含多个子订单的情况下,如果使用本接口传入OutTradeNo或TransactionId退款,则只支持全单退款;如果需要部分退款,请通过传入子订单的方式来指定部分金额退款。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:Refund
Version String 公共参数,本接口取值:2019-08-20
Region String 公共参数,详见产品支持的 地域列表
UserId String 用户Id,长度不小于5位, 仅支持字母和数字的组合
RefundId String 退款订单号,仅支持数字、 字母、下划线(_)、横杠字 符(-)、点(.)的组合
MidasAppId String 聚鑫分配的支付主MidasAppid
TotalRefundAmt Integer 退款金额,单位:分。备 注:当该字段为空或者为0 时,系统会默认使用订单当 实付金额做为退款金额
SubOrderRefundList.N Array of RefundOutSubOrderRefundList 支持多个子订单批量退款单 个子订单退款支持传 SubOutTradeNo ,也支持传 SubOutTradeNoList ,都传的时候以 SubOutTradeNoList 为准。 如果传了子单退款细节,外 部不需要再传退款金额,平 台应退,商户应退金额,我 们可以直接根据子单退款算 出来总和。
MidasSecretId String 聚鑫分配的安全ID
MidasSignature String 按照聚鑫安全密钥计算的签名
OutTradeNo String 商品订单,仅支持数字、字 母、下划线(_)、横杠字符 (-)、点(.)的组合。 OutTradeNo ,TransactionId 二选一,不能都为空,优先使用 OutTradeNo
MchRefundAmt Integer 结算应收金额,单位:分
TransactionId String 调用下单接口获取的聚鑫交 易订单。 OutTradeNo ,TransactionId 二选一,不能都为空,优先使用 OutTradeNo
PlatformRefundAmt Integer 平台应收金额,单位:分

3. 输出参数

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

4. 示例

示例1 退款请求示例

用于订单退款场景。

输入示例

https://cpdp.tencentcloudapi.com/?Action=Refund
&<公共请求参数>
&UserId=your_user_id
&RefundId=testrefund10002
&MidasAppId=your_midas_app_id
&TotalRefundAmt=10
&OutTradeNo=order_no_10002
&MchRefundAmt=9
&PlatformRefundAmt=1
&MidasSecretId=your_midas_secret_id
&MidasSignature=your_midas_signature
&SubOrderRefundList.0.PlatformRefundAmt=1
&SubOrderRefundList.0.RefundAmt=10
&SubOrderRefundList.0.SubMchRefundAmt=9
&SubOrderRefundList.0.SubOutTradeNo=sub_order_no_10002
&SubOrderRefundList.0.SubRefundId=sub_testrefund10002

输出示例

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

5. 开发者资源

API Explorer

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.NoRecord 订单不存在
FailedOperation.PortalError 聚鑫内部系统调用失败
FailedOperation.ServiceError 接口执行失败
FailedOperation.WxCrtNotSet 微信支付证书未配置
InvalidParameter 参数错误