tencent cloud

接口列表
最后更新时间:2025-12-05 23:14:41
接口列表
最后更新时间: 2025-12-05 23:14:41

1. 小程序登录接口

1.1 检查用户是否存在

Path: /user/checkUser
Method: POST
接口描述:
根据 superapp 用户 ID 检查用户是否存在

请求参数

Body
名称
类型
是否必须
备注
userId
string
用户匿名化 ID,由使用 SDK 的 superapp 负责生成,用于临时向 superapp 的服务端请求生成匿名化的 openid。 在小程序需要获取 openid 时临时使用。

响应参数

名称
类型
是否必须
备注
returnCode
string
响应 code,0表示成功
returnMessage
string
响应信息
data
boolean
用户是否存在
requestId
string
请求链路 ID

1.2 获取用户临时信息 Code

Path: /user/getUserInfoTemporaryCode
Method: POST
接口描述:
根据 Type 获取用户手机号或者邮箱的临时凭证

请求参数

Body
名称
类型
是否必须
备注
type
string
获取类型 有效值:email、phone
userId
string
用户匿名化 ID,由使用 SDK 的 superapp 负责生成,用于临时向 superapp 的服务端请求生成匿名化的 openid。 在小程序需要获取 openid 时临时使用。

响应参数

名称
类型
是否必须
备注
returnCode
string
响应 code,0表示成功
returnMessage
string
响应信息
data
object
响应数据。
data.data
string
根据查询类型返回脱敏的手机号或者邮箱,例如 158****2850,mu****ng@tencent.com
data.code
string
获取手机或者邮箱的临时凭证 Code
requestId
string
请求链路 ID

1.3 获取用户邮箱

Path: /user/getUserEmail
Method: POST
接口描述:
根据临时凭证 code 获取用户邮箱

请求参数

Body
名称
类型
是否必须
备注
temporaryCode
string
临时凭证 Code
userId
string
用户匿名化 ID,由使用 SDK 的 superapp 负责生成,用于临时向superapp 的服务端请求生成匿名化的 openid。 在小程序需要获取openid 时临时使用。

响应参数

名称
类型
是否必须
备注
returnCode
string
响应 code,0表示成功
returnMessage
string
响应信息
data
string
用户邮箱信息,基于 AES CBC(使用密钥的前16字节作为iv) 加密后进行 base64 编码后的字符串,密钥参考 配置管理 中的 SecretKey
requestId
string
请求链路 ID

1.4 获取用户手机号

Path: /user/getUserPhoneNumber
Method: POST
接口描述:
根据临时凭证 code 获取用户手机号

请求参数

Body
名称
类型
是否必须
备注
temporaryCode
string
临时凭证 Code
userId
string
用户匿名化 ID,由使用 SDK 的 superapp 负责生成,用于临时向superapp 的服务端请求生成匿名化的 openid。 在小程序需要获取 openid时临时使用。

响应参数

名称
类型
是否必须
备注
returnCode
string
响应 code,0表示成功
returnMessage
string
响应信息
data
string
用户手机号,基于 AES CBC (使用密钥的前16字节作为iv)加密后进行 base64 编码后的字符串,密钥参考 配置管理 中的 SecretKey
requestId
string
请求链路ID

1.5 获取用户昵称

Path: /user/getUserNick
Method: POST
接口描述:
获取用户昵称

请求参数

Body
名称
类型
是否必须
备注
userId
string
用户匿名化 ID,由使用 SDK 的 superapp 负责生成,用于临时向 superapp 的服务端请求生成匿名化的 openid。 在小程序需要获取 openid 时临时使用。

响应参数

名称
类型
是否必须
备注
returnCode
string
响应 code,0表示成功
returnMessage
string
响应信息
data
string
用户昵称
requestId
string
请求链路 ID

1.6 获取用户头像

Path: /user/getUserAvatar
Method: POST
接口描述:
获取用户头像

请求参数

Body
名称
类型
是否必须
备注
userId
string
用户匿名化 ID,由使用 SDK 的 superapp 负责生成,用于临时向 superapp 的服务端请求生成匿名化的 openid。 在小程序需要获取 openid 时临时使用。

响应参数

名称
类型
是否必须
备注
returnCode
string
响应 code,0表示成功
returnMessage
string
响应信息
data
string
用户头像地址
requestId
string
请求链路 ID

1.7 接收订阅消息

Path: /message/send
Method: POST
接口描述:
接收SAS平台侧推送的用户订阅消息内容

请求参数

Body
名称
类型
是否必须
备注
AccountId
string
消息的归属用户 ID(同 UserId)
MessageId
string
消息唯一 ID
Content
string
消息内容
DateTime
int
消息发送时间的时间戳秒
TemplateId
string
消息模板 ID
MnpId
string
小程序 ID
MnpName
string
小程序名称
TemplateTitle
string
模板 标题
State
string
跳转小程序类型:developer 为开发版;trial 为体验版;formal 为正式版;默认为正式版
Page
string
点击消息卡片后的跳转页面,仅限本小程序内的页面,
支持带参数,(示例 index?foo=bar)。该字段不填则模板无跳转。
MnpIcon
string
小程序图标

响应参数

名称
类型
是否必须
备注
returnCode
string
响应 code, 0表示成功
returnMessage
string
响应信息
data
bool
处理结果
requestId
string
请求处理链路 ID

2. 小程序支付接口

2.1 创建小程序预订单

Path: /v3/pay/transactions/jsapi
Method: POST
接口描述:
小程序创建预订单

请求参数

Headers
参数名称
描述
是否必须
备注
TC-Payment-Callback
支付成功或者失败回调地址
支付回调通知地址,POST 请求
TC-MerchantId
商户 ID
商户号 mchid 是商户在 superapp 支付侧的唯一身份标识,所有接口调用都必须包含此参数,以便superapp支付确认商户的身份。当入驻审核成功后,Superapp 支付向商户提供该商户号。
TC-TradeType
交易类型
JSAPI:小程序支付
TC-UserID
Superapp 登录用户 ID
-
Authorization
签名认证信息
Body
名称
类型
是否必须
备注
appid
string
商户小程序 ID,是商户在平台的唯一标识,需确保该 appid与【mchid】有绑定关系
description
string
商品信息描述,商户需传递能真实代表商品信息的描述,不能超过127个字符
out_trade_no
string
商户系统内部订单号,要求6-32个字符内,只能是数字、大小写字母_-|* 且在同一个商户号下唯一。
time_expire
string
支付结束时间,用户能够完成该笔订单支付的最后时限,并非订单关闭的时间。超过此时间后,用户将无法对该笔订单进行支付。
格式要求:支付结束时间需遵循 RFC3339 标准格式:yyyy-MM-DDTHH:mm:ss+TIMEZONE。yyyy-MM-DD 表示年月日;T 字符用于分隔日期和时间部分;HH:mm:ss 表示具体的时分秒;TIMEZONE 表示时区(例如,+08:00 对应东八区时间,即北京时间)。
attach
string
商户在创建订单时可传入自定义数据包,该数据对用户不可见,用于存储订单相关的商户自定义信息,其总长度限制在128字符以内。支付成功后查询订单API和支付成功回调通知均会将此字段返回给商户
amount
object
订单金额信息
amount.total
int
订单总金额,单位为分,整型。
amount.currency
string
货币类型,符合 ISO 4217 标准的三位字母代码。
payer
object
支付者信息
payer.openid
string
用户在商户 appid 下的唯一标识。下单前需获取到用户的 OpenID,详情见 小程序登录
detail
object
商品信息
detail.cost_price
int
订单原价
detail.goods_detail
array[object]
商品列表
detail.goods_detail.merchant_goods_id
string
商户侧商品编码,由半角的大小写字母、数字、中划线、下划线中的一种或几种组成。
detail.goods_detail.goods_name
string
商品的实际名称
detail.goods_detail.quantity
int
用户购买商品数量
detail.goods_detail.unit_price
int
商品单价,整型,单位为:分。

响应参数

名称
类型
是否必须
备注
returnCode
string
响应 code,0表示成功
returnMessage
string
响应信息
data
object
响应数据
data.prepayId
string
预订单 ID,商户下唯一
requestId
string
请求链路 ID

2.2 小程序预订单支付回调

用户使用普通支付功能,当用户成功支付订单后,superapp 支付会通过 POST 的请求方式,向2.1接口中请求的 header TC-Payment-Callback 参数值发送回调通知,让商户知晓用户已完成支付。
Path: 2.1接口中请求的 header TC-Payment-Callback 参数值
Method: POST
接口描述:
小程序预订单支付回调

请求参数

Headers
参数名称
描述
是否必须
备注
TC-Serial
支付成功或者失败回调地址
验签的 superapp 平台商户序列号 /superapp 平台商户支付公钥 ID【商户序列号、商户证书】
TC-Signature
验签的签名值
TC-Timestamp
验签的时间戳,单位秒
-
TC-Nonce
验签的随机字符串
-
TC-Prepay-Id
小程序预订单 ID
-
X-TC-Signature
调用超级应用服务平台服务验签的签名
X-TC-ApplicationId
超级应用服务平台服务的应用ID
创建订单时请求Header中的X-TC-ApplicationId
Body
名称
类型
是否必须
备注
id
string
【通知 ID】回调通知的唯一编号
create_time
string
【通知创建时间】格式:遵循 RFC3339 标准格式:yyyy-MM-DDTHH:mm:ss+TIMEZONE。yyyy-MM-DD 表示年月日;T 字符用于分隔日期和时间部分;HH:mm:ss 表示具体的时分秒;TIMEZONE 表示时区(例如,+08:00 对应东八区时间,即北京时间)。
示例:2015-05-20T13:29:35+08:00 表示北京时间2015年5月20日13点29分35秒。
event_type
string
【通知的类型】Superapp 支付回调通知的类型。
支付成功-TRANSACTION.SUCCESS。
支付失败-TRANSACTION.PAYERROR。
resource_type
string
【通知数据类型】通知的资源数据类型,固定为 encrypt-resource。
summary
string
【回调摘要】Superapp平台支付对回调内容的摘要备注。
resource
object
【通知数据】通知资源数据。
resource.algorithm
string
【加密算法类型】回调数据密文的加密算法类型,目前为AEAD_AES_256_GCM,开发者需要使用同样类型的数据进行解密。
resource.ciphertext
string
【数据密文】Base64编码后的回调数据密文,商户需 Base64 解码并使用 API秘钥解密。
resource.associated_data
string
【附加数据】参与解密的附加数据,该字段可能为空。
resource.original_type
string
【原始回调类型】加密前的对象类型,为 transaction。
resource.nonce
string
【随机串】参与解密的随机串。

响应参数

名称
类型
是否必须
备注
returnCode
string
响应 code,0表示成功
returnMessage
string
响应信息
data
boolean
订单是否关闭成功
requestId
string
请求链路 ID

2.3 商户订单号查询订单

Path: /v3/pay/transactions/out-trade-no/{out_trade_no}
Method: GET
接口描述:
根据商户订单号查询订单

请求参数

Headers
参数名称
描述
是否必须
备注
Authorization
签名认证信息
Path
参数名称
描述
是否必须
备注
out_trade_no
商户订单号
-
Query
参数名称
描述
是否必须
备注
mchid
商户下单时传入的商户号
-

响应参数

名称
类型
是否必须
备注
returnCode
string
响应 code,0表示成功
returnMessage
string
响应信息
data
object
响应数据
data.app_id
string
商户下单时传入的小程序 ID
data.mchid
string
商户下单时传入的商户号
data.out_trade_no
string
商户下单时传入的商户系统内部订单号
data.transaction_id
string
Superapp支付侧订单的唯一标识,订单支付成功后返回
data.trade_type
string
返回当前订单的交易类型,枚举值:
JSAPI:小程序支付
data.trade_state
string
交易状态,枚举值:
SUCCESS:支付成功
REFUND:转入退款
NOTPAY:未支付
CLOSED:已关闭
REVOKED:已撤销
USERPAYING:用户支付中
PAYERROR:支付失败
data.trade_state_desc
string
对交易状态的详细说明
data.bank_type
string
用户支付方式说明,订单支付成功后返回,格式为银行简码_具体类型(DEBIT借记卡/CREDIT信用卡)
data.success_time
string
用户完成订单支付的时间。该参数在订单支付成功后返回。
格式:遵循 RFC3339 标准格式:yyyy-MM-DDTHH:mm:ss+TIMEZONE。yyyy-MM-DD 表示年月日;T 字符用于分隔日期和时间部分;HH:mm:ss 表示具体的时分秒;TIMEZONE 表示时区(例如,+08:00 对应东八区时间,即北京时间)。
示例:2015-05-20T13:29:35+08:00 表示北京时间2015年5月20日13点29分35秒。
data.payer
object
订单的支付者信息,订单支付成功后返回,superapp 用户 ID
data.amount
object
订单金额信息
data.amount.total
string
订单总金额
data.amount.payer_total
string
用户实际支付金额
data.amount.currency
string
货币类型
data.amount.payer_currency
string
用户支付币种
requestId
string
请求链路 ID



2.4 关闭订单

未支付状态的订单,可在无需支付时调用此接口关闭订单。常见关单情况包括:
用户在商户系统提交取消订单请求,商户需执行关单操作。
订单超时未支付(超出商户系统设定的可支付时间或下单时的 time_expire 支付截止时间),商户需进行关单处理。
Path: /v3/pay/transactions/out-trade-no/{out_trade_no}/close
Method: POST
接口描述:
根据商户订单号查询订单

请求参数

Headers
参数名称
描述
是否必须
备注
Authorization
签名认证信息
Path
参数名称
描述
是否必须
备注
out_trade_no
商户订单号
-
Body
参数名称
描述
是否必须
备注
mchid
商户下单时传入的商户号
-

响应参数

204 No Content
无应答包体

3. 小游戏虚拟支付接口

3.1 小游戏创建虚拟支付订单

Path:/requestMidasPaymentGameItem
Method: POST
接口描述:
小游戏创建虚拟支付预订单

请求参数

Headers
参数名称
描述
是否必须
TC-Payment-Callback
支付成功或者失败回调地址
TC-UserID
Superapp 登录用户 ID
TC-PackageName
超级应用平台应用包名
X-TC-ApplicationId
超级应用平台应用ID
TC-MerchantId
superapp商户号ID
TC-Platform-UserId
超级应用平台用户openid
body:
参数名称
字段类型
描述
是否必须
备注
SignData
string
支付原串
具体支付参数见下面的 signData,需要将数据以 JSON 格式传递
signData 例子:
'{"mode":"goods","offerId":"123","buyQuantity":1,"env":0,"currencyType":"USD","productId":"testproductId","goodsPrice":10,"outTradeNo":"xxxxxx","attach":"testdata"}'
PaySig
string
支付签名
pay_sig 参数的签名算法,使用 superapp 中的AppKey 对支付的请求进行签名,代表请求经过开发者服务端的支付模块发起。签名算法伪代码为:
paySig = to_hex(hmac_sha256(appKey,'requestMidasPaymentGameItem' + '&' + signData))
AppId
string
超级应用平台应用 ID
应用 ID
MiniAppId
string
超级应用平台小游戏 ID
小游戏 ID
GoodsName
string
游戏道具名称
下单购买游戏道具名称
OrderSource
int
订单来源
订单来源 1 游戏内
Event
string
事件类型
OrderSource=1时固定为:
minigame_game_pay_goods_deliver_notify
SignData:
参数名称
字段类型
描述
是否必须
备注
buyQuantity
int
购买数量
购买数量
currencyType
string
币种
货币类型,符合 ISO 4217 标准的三位字母代码。
productId
string
道具 ID
道具 ID
goodsPrice
int
道具单价
道具单价,(单位:分)
outTradeNo
string
商户业务订单号
商户系统内部订单号,要求6-32个字符内,只能是数字、大小写字母_-|* 且在同一个商户号下唯一。
attach
string
透传参数
支付回调时会透传返回

响应参数

名称
类型
是否必须
备注
returnCode
string
响应 code,0表示成功
returnMessage
string
响应信息
data
object
响应数据
data.prepayId
string
预订单 ID,商户下唯一
requestId
string
请求链路 ID

3.2 小游戏支付回调

用户使用普通支付功能,当用户成功支付订单后,superapp 支付会通过 POST 的请求方式,向3.1接口中请求 header TC-Payment-Callback 参数值发送回调通知,让商户知晓用户已完成支付。
Path: 3.1接口中请求 header TC-Payment-Callback 参数值
Method: POST
接口描述:
小游戏支付回调

请求参数

header:
参数名称
描述
是否必须
X-TC-ApplicationId
超级应用平台应用ID
X-TC-Signature
调用超级应用服务平台服务验签的签名,参考超级应用平台签名验签
TC-Timestamp
验签的时间戳,单位毫秒
body:
参数名称
字段类型
描述
是否必须
EventType
string
消息类型,支付成功-TRANSACTION.SUCCESS。
支付失败-TRANSACTION.PAYERROR。
Event
string
创建订单时的event
PayModel
string
支付方式Wallet、Bankcard、Third
Payload
string
携带的具体内容,格式为 JSON,具体内容如下表格Payload(因为这里需要对消息内容统一签名,所以统一把消息内容设计成 JSON 格式)
PayEventSig
string
支付签名,详情见 虚拟支付回调签名
Payload
参数名称
字段类型
描述
是否必须
OpenId
string
openid
OutTradeNo
string
商户订单号
GoodsInfo
Object
发货道具
TransactionId
string
支付交易ID
GoodsInfo
参数名称
字段类型
描述
是否必须
ProductId
String
游戏道具 id 标识
Quantity
Number
购买道具数量
OrigPrice
Number
物品原始价格 (单位:分)
ActualPrice
Number
物品实际支付价格(单位:分)
Attach
String
透传数据
OrderSource
Number
订单来源

响应参数

名称
类型
是否必须
备注
returnCode
string
响应 code,0表示成功
returnMessage
string
响应信息
data
string
响应数据,成功时为 ok
requestId
string
请求链路 ID

4. 小程序虚拟支付接口

4.1 小程序创建虚拟支付订单

Path:/requestVirtualPayment
Method: POST
接口描述:
小程序创建虚拟支付预订单

请求参数

Headers
参数名称
描述
是否必须
TC-Payment-Callback
支付成功或者失败回调地址
TC-UserID
Superapp 登录用户 ID
TC-PackageName
超级应用平台应用包名
X-TC-ApplicationId
超级应用平台应用ID
TC-MerchantId
超级应用平台中小程序绑定superapp的商户ID
TC-Platform-UserId
超级应用平台用户openid
body
参数名称
字段类型
描述
是否必须
SignData
string
支付原串,具体支付参数见下面的 signData,需要将数据以 JSON 格式传递
signData 例子:
'{"offerId":"123","buyQuantity":1,"env":0,"currencyType":"USD","productId":"testproductId","goodsPrice":10,"outTradeNo":"xxxxxx","attach":"testdata"}'
PaySig
string
支付签名,pay_sig 参数的签名算法,使用 superapp 中的appKey 对支付的请求进行签名,代表请求经过开发者服务端的支付模块发起。签名算法伪代码为:
paySig = to_hex(hmac_sha256(appKey,'requestMidasPaymentGameItem' + '&' + signData))
AppId
string
应用 ID
MiniAppId
string
小游戏 ID
GoodsName
string
游戏道具名称
OrderSource
int
订单来源 10 小程序短剧内下单
Event
string
orderSource=10 固定为:xpay_goods_deliver_notify
SignData:
参数名称
字段类型
描述
是否必须
备注
buyQuantity
int
购买数量
购买数量
currencyType
string
币种
货币类型,符合 ISO 4217 标准的三位字母代码。
productId
string
道具 ID
道具 ID
goodsPrice
int
道具单价
道具单价,(单位:分)
outTradeNo
string
商户业务订单号
商户系统内部订单号,要求6-32个字符内,只能是数字、大小写字母_-|* 且在同一个商户号下唯一。
attach
string
透传参数
支付回调时会透传返回

响应参数

名称
类型
是否必须
备注
returnCode
string
响应 code,0表示成功
returnMessage
string
响应信息
data
object
响应数据
data.prepayId
string
预订单 ID,商户下唯一
requestId
string
请求链路 ID

4.2 小程序虚拟支付回调

用户使用普通支付功能,当用户成功支付订单后,superapp 支付会通过 POST 的请求方式,向4.1接口中请求 header TC-Payment-Callback 参数值发送回调通知,让商户知晓用户已完成支付。
Path: 4.1接口中请求 header TC-Payment-Callback 参数值
Method: POST
接口描述:
小程序虚拟支付回调

请求参数

参数名称
字段类型
描述
是否必须
EventType
string
消息类型,支付成功-TRANSACTION.SUCCESS。
支付失败-TRANSACTION.PAYERROR。
Event
string
事件类型,创建订单时的event
PayModel
string
支付方式Wallet、Bankcard、Third
Payload
string
携带的具体内容,格式为 JSON,具体内容如下表格Payload(因为这里需要对消息内容统一签名,所以统一把消息内容设计成 JSON 格式)
PayEventSig
string
支付签名,详情见 虚拟支付回调签名
Payload
参数名称
字段类型
描述
是否必须
OpenId
string
超级应用平台用户ID,下单时header中的TC-Platform-UserId
OutTradeNo
string
订单号
GoodsInfo
Object
发货道具
PayInfo
Object
支付信息
GoodsInfo
参数名称
字段类型
描述
是否必须
ProductId
String
游戏道具 id 标识
Quantity
Number
购买道具数量
OrigPrice
Number
物品原始价格 (单位:分)
ActualPrice
Number
物品实际支付价格(单位:分)
Attach
String
透传数据
OrderSource
Number
1 游戏内
PayInfo
参数名称
字段类型
描述
是否必须
MchOrderNo
String
商户下单时传入的商户号
PaidTime
Number
支付时间戳,单位秒
TransactionId
String
支付交易ID

响应参数

名称
类型
是否必须
备注
returnCode
string
响应 code,0表示成功
returnMessage
string
响应信息
data
string
响应数据,成功时为 ok
requestId
string
请求链路 ID
本页内容是否解决了您的问题?
您也可以 联系销售 提交工单 以寻求帮助。

文档反馈