名称 | 类型 | 是否必须 | 备注 |
userId | string | 是 | 用户匿名化 ID,由使用 SDK 的 superapp 负责生成,用于临时向 superapp 的服务端请求生成匿名化的 openid。 在小程序需要获取 openid 时临时使用。 |
名称 | 类型 | 是否必须 | 备注 |
returnCode | string | 是 | 响应 code,0表示成功 |
returnMessage | string | 否 | 响应信息 |
data | boolean | 是 | 用户是否存在 |
requestId | string | 是 | 请求链路 ID |
名称 | 类型 | 是否必须 | 备注 |
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 |
名称 | 类型 | 是否必须 | 备注 |
temporaryCode | string | 是 | 临时凭证 Code |
userId | string | 是 | 用户匿名化 ID,由使用 SDK 的 superapp 负责生成,用于临时向superapp 的服务端请求生成匿名化的 openid。 在小程序需要获取openid 时临时使用。 |
名称 | 类型 | 是否必须 | 备注 |
returnCode | string | 是 | 响应 code,0表示成功 |
returnMessage | string | 否 | 响应信息 |
data | string | 是 | |
requestId | string | 是 | 请求链路 ID |
名称 | 类型 | 是否必须 | 备注 |
temporaryCode | string | 是 | 临时凭证 Code |
userId | string | 是 | 用户匿名化 ID,由使用 SDK 的 superapp 负责生成,用于临时向superapp 的服务端请求生成匿名化的 openid。 在小程序需要获取 openid时临时使用。 |
名称 | 类型 | 是否必须 | 备注 |
returnCode | string | 是 | 响应 code,0表示成功 |
returnMessage | string | 否 | 响应信息 |
data | string | 是 | |
requestId | string | 是 | 请求链路ID |
名称 | 类型 | 是否必须 | 备注 |
userId | string | 是 | 用户匿名化 ID,由使用 SDK 的 superapp 负责生成,用于临时向 superapp 的服务端请求生成匿名化的 openid。 在小程序需要获取 openid 时临时使用。 |
名称 | 类型 | 是否必须 | 备注 |
returnCode | string | 是 | 响应 code,0表示成功 |
returnMessage | string | 否 | 响应信息 |
data | string | 是 | 用户昵称 |
requestId | string | 是 | 请求链路 ID |
名称 | 类型 | 是否必须 | 备注 |
userId | string | 是 | 用户匿名化 ID,由使用 SDK 的 superapp 负责生成,用于临时向 superapp 的服务端请求生成匿名化的 openid。 在小程序需要获取 openid 时临时使用。 |
名称 | 类型 | 是否必须 | 备注 |
returnCode | string | 是 | 响应 code,0表示成功 |
returnMessage | string | 否 | 响应信息 |
data | string | 是 | 用户头像地址 |
requestId | string | 是 | 请求链路 ID |
名称 | 类型 | 是否必须 | 备注 |
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 |
参数名称 | 描述 | 是否必须 | 备注 |
TC-Payment-Callback | 支付成功或者失败回调地址 | 是 | 支付回调通知地址,POST 请求 |
TC-MerchantId | 商户 ID | 是 | 商户号 mchid 是商户在 superapp 支付侧的唯一身份标识,所有接口调用都必须包含此参数,以便superapp支付确认商户的身份。当入驻审核成功后,Superapp 支付向商户提供该商户号。 |
TC-TradeType | 交易类型 | 是 | JSAPI:小程序支付 |
TC-UserID | Superapp 登录用户 ID | 是 | - |
Authorization | 签名认证信息 | 是 |
名称 | 类型 | 是否必须 | 备注 |
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 | 是 | |
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 |
参数名称 | 描述 | 是否必须 | 备注 |
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 |
名称 | 类型 | 是否必须 | 备注 |
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 |
参数名称 | 描述 | 是否必须 | 备注 |
Authorization | 签名认证信息 | 是 |
参数名称 | 描述 | 是否必须 | 备注 |
out_trade_no | 商户订单号 | 是 | - |
参数名称 | 描述 | 是否必须 | 备注 |
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 |
参数名称 | 描述 | 是否必须 | 备注 |
Authorization | 签名认证信息 | 是 |
参数名称 | 描述 | 是否必须 | 备注 |
out_trade_no | 商户订单号 | 是 | - |
参数名称 | 描述 | 是否必须 | 备注 |
mchid | 商户下单时传入的商户号 | 是 | - |
参数名称 | 描述 | 是否必须 |
TC-Payment-Callback | 支付成功或者失败回调地址 | 是 |
TC-UserID | Superapp 登录用户 ID | 是 |
TC-PackageName | 超级应用平台应用包名 | 是 |
X-TC-ApplicationId | 超级应用平台应用ID | 是 |
TC-MerchantId | superapp商户号ID | 是 |
TC-Platform-UserId | 超级应用平台用户openid | 是 |
参数名称 | 字段类型 | 描述 | 是否必须 | 备注 |
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 |
参数名称 | 字段类型 | 描述 | 是否必须 | 备注 |
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 |
参数名称 | 描述 | 是否必须 |
X-TC-ApplicationId | 超级应用平台应用ID | 是 |
X-TC-Signature | 是 | |
TC-Timestamp | 验签的时间戳,单位毫秒 | 是 |
参数名称 | 字段类型 | 描述 | 是否必须 |
EventType | string | 消息类型,支付成功-TRANSACTION.SUCCESS。 支付失败-TRANSACTION.PAYERROR。 | 是 |
Event | string | 创建订单时的event | 是 |
PayModel | string | 支付方式Wallet、Bankcard、Third | 是 |
Payload | string | 携带的具体内容,格式为 JSON,具体内容如下表格Payload(因为这里需要对消息内容统一签名,所以统一把消息内容设计成 JSON 格式) | 是 |
PayEventSig | string | 是 |
参数名称 | 字段类型 | 描述 | 是否必须 |
OpenId | string | openid | 是 |
OutTradeNo | string | 商户订单号 | 是 |
GoodsInfo | Object | 发货道具 | 是 |
TransactionId | string | 支付交易ID | 是 |
参数名称 | 字段类型 | 描述 | 是否必须 |
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 |
参数名称 | 描述 | 是否必须 |
TC-Payment-Callback | 支付成功或者失败回调地址 | 是 |
TC-UserID | Superapp 登录用户 ID | 是 |
TC-PackageName | 超级应用平台应用包名 | 是 |
X-TC-ApplicationId | 超级应用平台应用ID | 是 |
TC-MerchantId | 超级应用平台中小程序绑定superapp的商户ID | 是 |
TC-Platform-UserId | 超级应用平台用户openid | 是 |
参数名称 | 字段类型 | 描述 | 是否必须 |
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 | 是 |
参数名称 | 字段类型 | 描述 | 是否必须 | 备注 |
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 |
参数名称 | 字段类型 | 描述 | 是否必须 |
EventType | string | 消息类型,支付成功-TRANSACTION.SUCCESS。 支付失败-TRANSACTION.PAYERROR。 | 是 |
Event | string | 事件类型,创建订单时的event | 是 |
PayModel | string | 支付方式Wallet、Bankcard、Third | 是 |
Payload | string | 携带的具体内容,格式为 JSON,具体内容如下表格Payload(因为这里需要对消息内容统一签名,所以统一把消息内容设计成 JSON 格式) | 是 |
PayEventSig | string | 是 |
参数名称 | 字段类型 | 描述 | 是否必须 |
OpenId | string | 超级应用平台用户ID,下单时header中的TC-Platform-UserId | 是 |
OutTradeNo | string | 订单号 | 是 |
GoodsInfo | Object | 发货道具 | 是 |
PayInfo | Object | 支付信息 | 是 |
参数名称 | 字段类型 | 描述 | 是否必须 |
ProductId | String | 游戏道具 id 标识 | 是 |
Quantity | Number | 购买道具数量 | 是 |
OrigPrice | Number | 物品原始价格 (单位:分) | 是 |
ActualPrice | Number | 物品实际支付价格(单位:分) | 是 |
Attach | String | 透传数据 | 是 |
OrderSource | Number | 1 游戏内 | 是 |
参数名称 | 字段类型 | 描述 | 是否必须 |
MchOrderNo | String | 商户下单时传入的商户号 | 是 |
PaidTime | Number | 支付时间戳,单位秒 | 是 |
TransactionId | String | 支付交易ID | 是 |
名称 | 类型 | 是否必须 | 备注 |
returnCode | string | 是 | 响应 code,0表示成功 |
returnMessage | string | 否 | 响应信息 |
data | string | 是 | 响应数据,成功时为 ok |
requestId | string | 是 | 请求链路 ID |
文档反馈