API 文档

聚鑫-统一下单接口

最近更新时间:2020-11-18 08:47:18

1. 接口描述

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

应用需要先调用本接口生成支付订单号,并将应答的PayInfo透传给聚鑫SDK,拉起客户端(包括微信公众号/微信小程序/客户端App)支付。

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:UnifiedOrder。
Version String 公共参数,本接口取值:2019-08-20。
Region String 公共参数,详见产品支持的 地域列表
CurrencyType String ISO 货币代码,CNY
MidasAppId String 聚鑫分配的支付主MidasAppId
OutTradeNo String 支付订单号,仅支持数字、字母、下划线(_)、横杠字符(-)、点(.)的组合
ProductDetail String 商品详情,需要URL编码
ProductId String 商品ID,仅支持数字、字母、下划线(_)、横杠字符(-)、点(.)的组合
ProductName String 商品名称,需要URL编码
TotalAmt Integer 支付金额,单位: 分
UserId String 用户ID,长度不小于5位,仅支持字母和数字的组合
RealChannel String 银行真实渠道.如:bank_pingan
OriginalAmt Integer 原始金额
MidasSecretId String 聚鑫分配的安全ID
MidasSignature String 按照聚鑫安全密钥计算的签名
CallbackUrl String Web端回调地址
Channel String 指定支付渠道: wechat:微信支付 qqwallet:QQ钱包
bank:网银支付 只有一个渠道时需要指定
Metadata String 透传字段,支付成功回调透传给应用,用于业务透传自定义内容
Quantity Integer 购买数量,不传默认为1
SubAppId String 聚鑫计费SubAppId,代表子商户
SubOrderList.N Array of UnifiedOrderInSubOrderList 子订单信息列表,格式:子订单号、子应用ID、金额。 压缩后最长不可超过65535字节(去除空格,换行,制表符等无意义字符)
注:接入银行或其他支付渠道服务商模式下,必传
TotalMchIncome Integer 结算应收金额,单位:分
TotalPlatformIncome Integer 平台应收金额,单位:分
WxOpenId String 微信公众号/小程序支付时为必选,需要传微信下的openid
WxSubOpenId String 在服务商模式下,微信公众号/小程序支付时wx_sub_openid和wx_openid二选一
MidasEnvironment String 环境名:
release: 现网环境
sandbox: 沙箱环境
development: 开发环境
缺省: release
WxAppId String 微信商户应用ID
WxSubAppId String 微信商户子应用ID

3. 输出参数

参数名称 类型 描述
TotalAmt Integer 支付金额,单位: 分
OutTradeNo String 应用支付订单号
PayInfo String 支付参数透传给聚鑫SDK(原文透传给SDK即可,不需要解码)
TransactionId String 聚鑫的交易订单
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 统一下单请求示例

统一下单接口获取的支付参数PayInfo,用以调起包括iOS/Android客户端SDK,微信小程序,公众号等支付。

输入示例

https://cpdp.tencentcloudapi.com/?Action=UnifiedOrder
&CurrencyType=CNY
&MidasAppId=your_midas_app_id
&OutTradeNo=your_order_no
&ProductDetail=商品详情
&ProductId=your_product_id
&ProductName=商品名称
&TotalAmt=1
&UserId=your_user_id
&Channel=wechat
&Quantity=1
&RealChannel=bank_pingan
&SubAppId=your_sub_app_id
&TotalMchIncome=1
&TotalPlatformIncome=0
&WxSubOpenId=your_wx_sub_open_id
&OriginalAmt=1
&MidasSecretId=your_midas_secret_id
&MidasSignature=your_midas_signature
&WxAppId=your_wx_app_id
&WxSubAppId=your_wx_sub_app_id
&SubOrderList.0.SubMchIncome=1
&SubOrderList.0.PlatformIncome=0
&SubOrderList.0.ProductDetail=商品详情
&SubOrderList.0.ProductName=商品名称
&SubOrderList.0.SubAppId=your_sub_app_id
&SubOrderList.0.SubOutTradeNo=your_sub_order_no
&SubOrderList.0.Amt=1
&SubOrderList.0.OriginalAmt=1
&<公共请求参数>

输出示例

{
  "Response": {
    "TotalAmt": 1,
    "OutTradeNo": "your_order_no",
    "TransactionId": "E-191018160200005000",
    "PayInfo": "data=%7B%22appid%22%3A%22unibank10001%22%2C%22user_id%22%3A%22user123%22%2C%22out_trade_no%22%3A%22mikeuf1910181230%22%2C%22product_id%22%3A%22product_111%22%7D&sign=sign",
    "RequestId": "6a895298-cd08-4170-b8e2-eeda98794a16"
  }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
FailedOperation.AppDeny 该业务代码对应的配置没有发布到相应的环境。
FailedOperation.ChannelDeny 支付渠道错误,请确认配置信息是 否提交至聚鑫。
FailedOperation.OcCompletedOrder 订单已经支付。
FailedOperation.OcRepeatOrder 订单号重复,但是两次请求参数不 一致。
FailedOperation.ParentAppIdError AppId、SubAppId不匹配。
FailedOperation.PortalError 聚鑫内部系统调用失败。
FailedOperation.WechatError 调用渠道错误,请确认渠道如微信 wxappid是否配置正确。
InvalidParameter 参数错误。
目录