动态与公告
产品简介
购买指南
快速入门
套餐管理
- 概述
- 控制台账号管理
- 存储配置
- 加速配置
- 品牌化配置
平台功能
- 控制台登录
- 用户和权限体系
- 小程序管理
- 小游戏管理
- 应用管理
- 商业化
- 平台管理
- 用户管理
- 团队管理
- 运营管理
- 安全中心
代码接入指引
- Demo 及 SDK 获取
- Android
- iOS
- Flutter
- App 服务端接入指南
- GUID 生成规则
小程序开发指南
- 小程序介绍与开发环境
- 小程序代码组成
- 指南
- 框架
- 组件
- API
- 服务端
- JS SDK
- 基础库
- IDE 使用指南
小游戏开发指南
- 指南
- API
- 服务端
实践教程
- 小程序登录实践教程
- 小程序订阅消息实践教程
- 支付相关实践教程
- 广告接入实践教程
- 小游戏订阅消息实践教程
API 文档
- 更新历史
- 简介
- API 概览
- 调用方式
- 应用相关接口
- 小程序相关接口
- 小游戏相关接口
- 敏感API相关接口
- 管理-敏感API相关接口
- 平台管理相关接口
- 控制台公共部分相关接口
- 团队管理相关接口
- 全局域名管理相关接口
- 用户管理相关接口
- 角色管理相关接口
- 运营管理相关接口
- 数据结构
- 错误码
相关协议
- 数据处理和安全协议

接口列表

下载

聚焦模式

字号

最后更新时间： 2026-08-18 10:42:38

接口列表
公共说明
公共请求头
以下请求头为所有超级应用平台调用 Superapp 服务接口公共参数，各接口的请求参数中不再重复列出：
Header 名称
说明
TC-ApplicationID
超级应用平台应用 ID
TC-BackendConfigID
超级应用平台接入 Superapp 后端配置 ID,用于区分环境
TC-PackageName
超级应用平台应用包名
TC-Signature
超级应用平台请求签名，签名参考超级应用平台签名验签﻿
TC-Timestamp
时间戳（秒）
TC-TraceID
链路追踪 ID
1. 小程序登录接口
1.1 检查用户是否存在
Path： /user/checkUser
Method： POST
接口描述：
根据 superapp 用户 ID 检查用户是否存在
请求头信息
请求头
描述
说明
示例
TC-OpenId
OpenId string，用户在小程序下唯一标识
采用 AES ECB 模式加密后进行十六进制编码，密钥为配置管理 中的 SecretKey
8d45e4881656d8fb4f97a442423093a5db9ec5691f6e8b17f895ab0fd935c0e7
TC-MiniAppID
MiniAppID string，小程序在 app 下唯一标识
采用 AES ECB 模式加密后进行十六进制编码，密钥为配置管理 中的SecretKey
8dc9708f26a1f5157e66c27892c78a88440d324a986a67fa7acb4d29511c7d18
请求参数
名称
类型
是否必须
备注
userId
string
是
用户匿名化 ID，由 superapp 通过 SDK 设置的 APP 登录用户唯一标识。
响应参数
名称
类型
是否必须
备注
returnCode
string
是
响应 code,0表示成功
returnMessage
string
否
响应信息
data
boolean
是
用户是否存在
requestId
string
是
请求链路 ID
请求示例
{"userId":"test_user_id_001"}
响应示例
{"returnCode":"0","returnMessage":"OK","requestId":"fd203616014e4ca8935f08a913ecfcb4","data":true}
1.2 获取用户临时信息 Code
Path： /user/getUserInfoTemporaryCode
Method： POST
接口描述：
根据 Type 获取用户手机号或者邮箱的临时凭证
请求参数
名称
类型
是否必须
备注
type
string
是
获取类型 有效值：email、phone
userId
string
是
用户匿名化 ID，由 superapp 通过 SDK 设置的 APP 登录用户唯一标识。
响应参数
名称
类型
是否必须
备注
returnCode
string
是
响应 code,0表示成功
returnMessage
string
否
响应信息
data
object
是
响应数据。
data.data
string
是
根据查询类型返回脱敏的手机号或者邮箱，例如 158*2850，mu*ng@tencent.com
data.code
string
是
获取手机或者邮箱的临时凭证 Code
requestId
string
是
请求链路 ID
请求示例
{"userId":"test_user_id_001","type":"phone"}
响应示例
{"returnCode":"0","returnMessage":"OK","requestId":"be25983db858414e9eac988ad3e07531","data":{"code":"6b8e77d997c146328cb7b5b7251581f6","data":"158****2850"}}
1.3 获取用户邮箱
Path： /user/getUserEmail
Method： POST
接口描述：
根据临时凭证 code 获取用户邮箱
请求参数
名称
类型
是否必须
备注
temporaryCode
string
是
临时凭证 Code
userId
string
是
用户匿名化 ID，由 superapp 通过 SDK 设置的 APP 登录用户唯一标识。
响应参数
名称
类型
是否必须
备注
returnCode
string
是
响应 code,0表示成功
returnMessage
string
否
响应信息
data
string
是
用户邮箱信息，基于 AES CBC（使用密钥的前16字节作为 iv） 加密后进行 base64 编码后的字符串，密钥为配置管理 中的SecretKey
requestId
string
是
请求链路 ID
请求示例
{"temporaryCode":"5ee7263392e441f782ec1bba85e88fbe","userId":"test_user_id_001"}
响应示例
{"returnCode":"0","returnMessage":"OK","requestId":"aa12162189324f789796a738ddf1eb0f","data":"4bhhBZj4WpfhVc0U66AAbrZi5vIajBZ7abBH96xgric="}
1.4 获取用户手机号
Path： /user/getUserPhoneNumber
Method： POST
接口描述：
根据临时凭证 code 获取用户手机号
请求参数
名称
类型
是否必须
备注
temporaryCode
string
是
临时凭证 Code
userId
string
是
用户匿名化 ID，由 superapp 通过 SDK 设置的 APP 登录用户唯一标识。
响应参数
名称
类型
是否必须
备注
returnCode
string
是
响应 code,0表示成功
returnMessage
string
否
响应信息
data
string
是
用户手机号，基于 AES CBC （使用密钥的前16字节作为 iv）加密后进行 base64 编码后的字符串，密钥为配置管理 中的SecretKey
requestId
string
是
请求链路 ID
请求示例
{"temporaryCode":"26707436c5324e79997d66698231fe4d","userId":"test_user_id_001"}
响应示例
{"returnCode":"0","returnMessage":"OK","requestId":"adadc87a140f40a2b1657a1eb996d550","data":"EOc8Hi03A4y60YkmUMNqtQ=="}
1.5 获取用户昵称
Path： /user/getUserNick
Method： POST
接口描述：
获取用户昵称
请求参数
名称
类型
是否必须
备注
userId
string
是
用户匿名化 ID，由 superapp 通过 SDK 设置的 APP 登录用户唯一标识。
响应参数
名称
类型
是否必须
备注
returnCode
string
是
响应 code,0表示成功
returnMessage
string
否
响应信息
data
string
是
用户昵称
requestId
string
是
请求链路 ID
请求示例
{"userId":"test_user_id_001"}
响应示例
{"returnCode":"0","returnMessage":"OK","requestId":"a58ffe1dc53f461fa3c5fb109781631a","data":"test nick"}
1.6 获取用户头像
Path： /user/getUserAvatar
Method： POST
接口描述：
获取用户头像
请求参数
名称
类型
是否必须
备注
userId
string
是
用户匿名化 ID，由 superapp 通过 SDK 设置的 APP 登录用户唯一标识。
响应参数
名称
类型
是否必须
备注
returnCode
string
是
响应 code,0表示成功
returnMessage
string
否
响应信息
data
string
是
用户头像地址
requestId
string
是
请求链路 ID
请求示例
{"userId":"test_user_id_001"}
响应示例
{"returnCode":"0","returnMessage":"OK","requestId":"8c7ff430d4de419ca2b0e90b3260c5b3","data":"https://example-test.com/image/avatar/test_user.jpg"}
1.7 接收订阅消息
Path： /message/send
Method： POST
接口描述：
接收 SAS 平台侧推送的用户订阅消息内容
请求参数
名称
类型
是否必须
备注
accountId
string
是
消息的归属用户 ID(同 UserId)
messageId
string
是
消息唯一 ID
content
string
是
消息内容
dataTime
int
是
消息发送时间的时间戳秒
templateId
string
是
消息模板 ID
mnpId
string
是
小程序 appid
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
请求示例
{"messageId":"a75a19fc0aa64e4171f8e856e0b16927","accountId":"test_user_id_001","templateId":"mti_test_template_001","content":"Pay time:2026-07-16 15:04:00","dataTime":1784189857,"mnpId":"mp_test_001","mnpName":"Daily Coffee","mnpIcon":"https://example-test.com/image/icon/coffee.png","templateTitle":"Order Notify","state":"formal","page":""}
响应示例
{"returnCode":"0","returnMessage":"OK","requestId":"98524a23d9ff4ed8b5e41cfec22b5ad8","data":true}
2. 小程序支付接口
2.1 创建小程序预订单
Path： /v3/pay/transactions/jsapi
Method： POST
接口描述：
小程序创建预订单
请求参数
Headers
参数名称
描述
TC-Payment-Callback
支付成功或失败回调地址
TC-MerchantID
超级应用平台中小程序绑定 superapp 的商户 ID
TC-UserID
Superapp 登录用户 ID
TC-TradeType
交易类型，JSAPI：小程序支付
TC-Platform-UserID
超级应用平台用户 openid
TC-ApplicationID
超级应用平台应用 ID
TC-Authorization
签名认证信息，签名参考标准支付签名﻿
Body
名称
类型
是否必须
备注
appid
string
是
商户小程序 appid,是商户在平台的唯一标识,需确保该 appid 与【mchid】有绑定关系。
description
string
是
商品信息描述，商户需传递能真实代表商品信息的描述，不能超过127个字符。
out_trade_no
string
是
商户系统内部订单号，要求10-64个字符内，只能是数字、大小写字母_-|* 且在同一个商户号下唯一。
time_expire
string
是
支付结束时间，用户能够完成该笔订单支付的最后时限，并非订单关闭的时间。超过此时间后，用户将无法对该笔订单进行支付。 格式要求：支付结束时间需遵循  标准格式：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
是
超级应用平台用户 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
是
商品单价，整型，单位为：分。
mchid
string
是
商户号
响应参数
名称
类型
是否必须
备注
returnCode
string
是
响应 code,0表示成功
returnMessage
string
否
响应信息
data
object
是
响应数据
data.prepayId
string
是
预订单 ID，商户下唯一
requestId
string
是
请求链路 ID
请求示例
{"appid":"mp_test_001","description":"Tropical Citrus Iced Energy","out_trade_no":"f49b3e588f1fec899b68","time_expire":"2035-10-30T18:30:00+07:00","attach":"{\\"appid\\":\\"mp_test_001\\"}","amount":{"total":1600,"currency":"USD"},"payer":{"openid":"o6bd1c45d56c17841qEDgWR88700"},"detail":{"cost_price":1600,"goods_detail":[{"merchant_goods_id":"1","goods_name":"Tropical Citrus Iced Energy","quantity":1,"unit_price":1600}]},"notify_url":"https://example-test.com/callback/pay/mp_test_001","mchid":"mi_test_merchant_001"}
响应示例
{"returnCode":"0","returnMessage":"OK","requestId":"1a89d73986dd4f889bd82fdd622b8505","data":{"prepayId":"pip_test_prepay_001"}}
2.2 小程序预订单支付回调
用户使用普通支付功能，当用户成功支付订单后，superapp 支付会通过 POST 的请求方式，向2.1接口中请求的 header TC-Payment-Callback 参数值发送回调通知，让商户知晓用户已完成支付。
Path： 2.1接口中请求的 header TC-Payment-Callback 参数值
Method： POST
接口描述：
小程序预订单支付回调
请求参数
Headers
参数名称
备注
TC-Callback-Serial
验签的 superapp 平台商户序列号 /superapp 平台商户支付公钥 ID【商户序列号、商户证书】
TC-Signature
签名参考超级应用平台签名验签﻿
TC-Timestamp
时间戳（秒）
TC-Callback-Nonce
-
TC-Callback-Signature
签名参考标准支付签名﻿
TC-ApplicationID
创建订单时请求 Header 中的 TC-ApplicationID
TC-BackendConfigID
创建订单时请求 Header 中的 TC-BackendConfigID
Body
名称
类型
是否必须
备注
id
string
是
【通知 ID】回调通知的唯一编号
create_time
string
是
【通知创建时间】格式：遵循  标准格式：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 平台支付对回调内容的摘要备注。
transaction_id
string
否
Superapp 平台支付交易流水号
pay_mode
string
否
支付方式（如 Wallet）
out_trade_no
string
是
商户系统内部订单号
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
是
【随机串】参与解密的随机串。
resource.ciphertext 解密后数据结构：
名称
类型
是否必须
备注
transaction_id
string
否
Superapp 平台支付交易流水号
mch_id
string
是
商户号
out_trade_no
string
是
商户系统内部订单号
appid
string
是
商户小程序 appid
trade_state
string
是
交易状态，枚举值： - SUCCESS：支付成功 - REFUND：转入退款 - NOTPAY：未支付 - CLOSED：已关闭 - REVOKED：已撤销 - USERPAYING：用户支付中 - PAYERROR：支付失败
trade_state_desc
string
是
交易状态描述
trade_type
string
是
交易类型，固定为 JSAPI
bank_type
string
是
用户支付方式，格式：银行简码_类型（如 ICBC_DEBIT），非银行卡支付统一为 OTHERS
success_time
string
是
支付完成时间
payer
string
是
支付用户标识
attach
string
否
下单时传入的透传数据
amount
object
是
订单金额信息，见下表
amount 字段说明：
名称
类型
是否必须
备注
total
string
是
订单总金额，单位分
payer_total
string
是
用户实际支付金额，单位分
currency
string
是
币种
payer_currency
string
是
用户支付币种
响应参数
名称
类型
是否必须
备注
returnCode
string
是
响应 code,0表示成功
returnMessage
string
否
响应信息
data
boolean
是
订单是否关闭成功
requestId
string
是
请求链路 ID
请求示例
{"id":"notify_001","create_time":"2026-07-16T17:44:53+08:00","resource_type":"encrypt-resource","event_type":"TRANSACTION.SUCCESS","transaction_id":"tx_test_001","summary":"Pay success","pay_mode":"Wallet","out_trade_no":"f49b3e588f1fec899b68","resource":{"original_type":"transaction","algorithm":"AEAD_AES_256_GCM","ciphertext":"encrypted_data_base64...","associated_data":"","nonce":"random_nonce_001"}}
响应示例
{"returnCode":"0","returnMessage":"success","requestId":"f071f8025c63482db14500b23c536577","data":"ok"}
2.3 商户订单号查询订单
Path： /v3/pay/transactions/out-trade-no/{out_trade_no}
Method： GET
接口描述：
根据商户订单号查询订单
请求参数
Headers
参数名称
描述
TC-Authorization
签名认证信息，签名参考标准支付签名﻿
Path
参数名称
描述
是否必须
备注
out_trade_no
商户系统内部订单号
是
-
Query
参数名称
描述
是否必须
备注
mchid
商户下单时传入的商户号
是
-
响应参数
名称
类型
是否必须
备注
returnCode
string
是
响应 code,0表示成功
returnMessage
string
否
响应信息
data
object
是
响应数据
data.app_id
string
是
商户下单时传入的小程序 appid
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.attach
string
否
商户在创建订单时可传入自定义数据包。
data.success_time
string
否
用户完成订单支付的时间。该参数在订单支付成功后返回。 格式：遵循  标准格式：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
请求示例
GET /v3/pay/transactions/out-trade-no/test_order_001?mchid=mi_test_merchant_001
响应示例
{"returnCode":"0","returnMessage":"OK","requestId":"f6f5b4aea35a449cb259459a0dc60d7b","data":{"app_id":"mp_test_001","mch_id":"mi_test_merchant_001","out_trade_no":"test_order_001","transaction_id":"tx_test_001","trade_type":"JSAPI","trade_state":"SUCCESS","trade_state_desc":"SUCCESS","bank_type":"Wallet","attach":"{\\"appid\\":\\"mp_test_001\\"}","success_time":"2026-07-16T17:44:53+08:00","payer":"test_user_id_001","amount":{"payer_total":"1600","total":"1600","currency":"USD","payer_currency":"USD"}}}
﻿
2.4 关闭订单
未支付状态的订单，可在无需支付时调用此接口关闭订单。常见关单情况包括：
用户在商户系统提交取消订单请求，商户需执行关单操作。
订单超时未支付（超出商户系统设定的可支付时间或下单时的 time_expire 支付截止时间），商户需进行关单处理。
Path： /v3/pay/transactions/out-trade-no/{out_trade_no}/close
Method： POST
接口描述：
根据商户订单号关闭订单
请求参数
Headers
参数名称
描述
TC-Authorization
签名认证信息，签名参考标准支付签名﻿
Path
参数名称
类型
描述
是否必须
备注
out_trade_no
string
商户系统内部订单号
是
-
Body
参数名称
类型
描述
是否必须
备注
mchid
string
商户下单时传入的商户号
是
-
响应参数
名称
类型
是否必须
备注
returnCode
string
是
响应 code，0 表示成功
returnMessage
string
否
响应信息
data
string
是
响应数据，成功时为 ok
requestId
string
是
请求链路 ID
请求示例
{"mchid":"mi_test_merchant_001"}
响应示例
{"returnCode":"0","returnMessage":"OK","requestId":"e82df47154eb40408e66f8b6a9693e68","data":"ok"}
3. 小游戏虚拟支付接口
3.1 小游戏创建虚拟支付订单
Path：/requestMidasPaymentGameItem
Method： POST
接口描述：
小游戏创建虚拟支付预订单
请求参数
Headers
参数名称
描述
TC-Payment-Callback
支付成功或失败回调地址
TC-UserID
superapp 登录用户 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
支付签名
是
虚拟支付签名,签名参考 paySig 签名,uri 取值固定为requestMidasPaymentGameItem
appId
string
超级应用平台应用 ID
是
-
miniAppId
string
超级应用平台小游戏 appid
是
-
goodsName
string
游戏道具名称
是
-
orderSource
int
订单来源
是
订单来源，固定值1
event
string
事件类型
是
固定值： minigame_game_pay_goods_deliver_notify
signData：
参数名称
字段类型
描述
是否必须
备注
model
string
支付的类型
是
固定值 goods
offerId
string
超级应用平台中小程序绑定 superapp 的商户 ID
是
-
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
请求示例
﻿
{"signData":"{\\"mode\\":\\"goods\\",\\"offerId\\":\\"mi1b105d3f77d52ccb87e84561f452a7\\",\\"buyQuantity\\":1,\\"currencyType\\":\\"USD\\",\\"productId\\":\\"5\\",\\"outTradeNo\\":\\"8d41176a-66cd-40a2-9772-b4824f2b610b\\",\\"goodsPrice\\":180,\\"attach\\":\\"1234...\\"}","paySig":"2c4d07267bf6ee0db3605f631f62dac148f45916b71ce041b520814002190d0d","appId":"app-59dkvj9ybo","miniAppId":"mgbg212tfnbir19g","goodsName":"Conventional missile","orderSource":1,"event":"minigame_game_pay_goods_deliver_notify"}
响应示例
{"returnCode":"0","returnMessage":"OK","requestId":"616e28f0bcbe4f13b9dca405f05a7aa1","data":{"prepayId":"pim_test_prepay_game_001"}}
3.2 小游戏支付回调
用户使用普通支付功能，当用户成功支付订单后，superapp 支付会通过 POST 的请求方式，向3.1接口中请求 header TC-Payment-Callback 参数值发送回调通知，让商户知晓用户已完成支付。
Path： 3.1接口中请求 header TC-Payment-Callback 参数值
Method： POST
接口描述：
小游戏支付回调
请求参数
header:
参数名称
描述
TC-ApplicationID
超级应用平台应用 ID
TC-BackendConfigID
超级应用平台接入 Superapp 后端配置 ID,用于区分环境,创建订单时请求 Header 中的 TC-BackendConfigID
TC-Signature
调用超级应用服务平台服务验签的签名，签名参考超级应用平台签名验签﻿
TC-Timestamp
时间戳（秒）
body:
参数名称
字段类型
是否必须
描述
eventType
string
是
消息类型，支付成功-TRANSACTION.SUCCESS。 支付失败-TRANSACTION.PAYERROR。
event
string
是
创建订单时的 event
payModel
string
否
支付方式 Wallet、Bankcard、third party
payload
string
是
携带的具体内容，格式为 JSON，具体内容如下表格 Payload（因为这里需要对消息内容统一签名，所以统一把消息内容设计成 JSON 格式）
payEventSig
string
是
签名参考payEventSig 签名，eevent 取为3.1创建订单接口 event
transactionId
string
否
Superapp 平台支付交易流水号
outTradeNo
string
是
商户订单号
Payload
参数名称
字段类型
描述
是否必须
OpenId
string
openid
是
OutTradeNo
string
商户订单号
是
GoodsInfo
object
发货道具
是
PayInfo
object
支付信息
是
GoodsInfo
参数名称
字段类型
描述
是否必须
ProductId
string
游戏道具 id 标识
是
Quantity
number
购买道具数量
是
OrigPrice
number
物品原始价格 （单位：分）
是
ActualPrice
string
物品实际支付价格（单位：分）
是
Attach
string
透传数据
是
OrderSource
number
订单来源
是
PayInfo
参数名称
字段类型
描述
是否必须
MchOrderNo
string
商户下单时传入的商户号
是
PaidTime
number
支付时间戳，单位秒
否
TransactionId
string
Superapp 平台支付交易流水号
否
响应参数
名称
类型
是否必须
备注
returnCode
string
是
响应 code,0表示成功
returnMessage
string
否
响应信息
data
string
是
响应数据，成功时为 OK
requestId
string
是
请求链路 ID
请求示例
﻿
{"eventType":"TRANSACTION.SUCCESS","event":"minigame_game_pay_goods_deliver_notify","transactionId":"tx202607212009049123827s9eoclex4","payMode":"Wallet","payload":"{\\"OpenId\\":\\"offc2718804217846IVfjea10186\\",\\"OutTradeNo\\":\\"c8ec5d52-7231-406c-a97f-7b839ebb0b7e\\",\\"GoodsInfo\\":{\\"ProductId\\":\\"7\\",\\"Quantity\\":1,\\"OrigPrice\\":300,\\"ActualPrice\\":\\"300\\",\\"Attach\\":\\"1234...\\",\\"OrderSource\\":1},\\"MchOrderNo\\":\\"pim1784635740007lfbkvvn6e0vjyfc6wfj3\\",\\"TransactionId\\":\\"tx202607212009049123827s9eoclex4\\"}","payEventSig":"e5c8efa45983997e8ac375c6fbade15dc29c6bc58a0dd41ca93fbe9feaf781ba","outTradeNo":"c8ec5d52-7231-406c-a97f-7b839ebb0b7e"}
响应示例
{"returnCode":"0","returnMessage":"success","requestId":"ee3d604b988545fd951db7360bedc93e","data":"ok"}
4. 小程序虚拟支付接口
4.1 小程序创建虚拟支付订单
Path：/requestVirtualPayment
Method： POST
接口描述：
小程序创建虚拟支付预订单
请求参数
Headers
参数名称
描述
TC-Payment-Callback
支付成功或者失败回调地址
TC-UserID
superapp 登录用户 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
虚拟支付签名,签名参考 paySig 签名,uri 取值固定为 requestVirtualPayment
是
appId
string
超级应用平台应用 ID
是
miniAppId
string
超级应用平台小程序 appid
是
goodsName
string
游戏道具名称
是
orderSource
int
订单来源，固定值10，小程序短剧内下单
是
event
string
orderSource=10 固定为：xpay_goods_deliver_notify
是
signData：
参数名称
字段类型
描述
是否必须
备注
model
string
支付的类型
是
固定值 goods
offerId
string
超级应用平台中小程序绑定 superapp 的商户 ID
是
-
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
请求示例
﻿
{"signData":"{\\"mode\\":\\"goods\\",\\"offerId\\":\\"mi1b105d3f77d52ccb87e84561f452a7\\",\\"buyQuantity\\":1,\\"currencyType\\":\\"USD\\",\\"productId\\":\\"1\\",\\"goodsPrice\\":250,\\"outTradeNo\\":\\"231a2ffe-93b3-4679-a7b8-46c2e75d2bb1\\",\\"attach\\":\\"\\"}","paySig":"60f0254ff7fe96a20c27aa385412badc967c7dfdf2b7f062752763bab36d750f","appId":"app-59dkvj9ybo","miniAppId":"mp9sq1zu3lgiwqkd","goodsName":"Doraemon","orderSource":10,"event":"xpay_goods_deliver_notify"}
响应示例
{"returnCode":"0","returnMessage":"OK","requestId":"29004d42c5cd49819047fa95133183e0","data":{"prepayId":"pim_test_prepay_mnp_001"}}
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
是
payMode
string
支付方式 Wallet、Bankcard、third party
否
payload
string
携带的具体内容，格式为 JSON，具体内容如下表格 Payload（因为这里需要对消息内容统一签名，所以统一把消息内容设计成 JSON 格式）
是
payEventSig
string
签名参考payEventSig 签名，event 取为4.1创建订单时的 event
是
transactionId
string
Superapp 平台支付交易流水号
否
outTradeNo
string
商户订单号
是
payload
参数名称
字段类型
描述
是否必须
OpenId
string
超级应用平台用户 ID，下单时 header 中的 TC-Platform-UserID
是
OutTradeNo
string
订单号
是
GoodsInfo
object
发货道具
是
PayInfo
object
支付信息
是
GoodsInfo
参数名称
字段类型
描述
是否必须
ProductId
string
游戏道具 id 标识
是
Quantity
number
购买道具数量
是
OrigPrice
number
物品原始价格 （单位：分）
是
ActualPrice
string
物品实际支付价格（单位：分）
是
Attach
string
透传数据
是
OrderSource
number
1 游戏内
是
PayInfo
参数名称
字段类型
描述
是否必须
MchOrderNo
string
商户下单时传入的商户号
是
PaidTime
number
支付时间戳，单位秒
否
TransactionId
string
Superapp 平台支付交易流水号
否
响应参数
名称
类型
是否必须
备注
returnCode
string
是
响应 code,0表示成功
returnMessage
string
否
响应信息
data
string
是
响应数据，成功时为 OK
requestId
string
是
请求链路 ID
请求示例
﻿
{"eventType":"TRANSACTION.SUCCESS","event":"xpay_goods_deliver_notify","transactionId":"tx20260721200041158935ihgcnxynly","payMode":"Wallet","payload":"{\\"OpenId\\":\\"o6bd1c45d56c17841qEDgWR88700\\",\\"OutTradeNo\\":\\"28f7a5cc-4427-4b0c-bf26-228e7de19d76\\",\\"GoodsInfo\\":{\\"ProductId\\":\\"1\\",\\"Quantity\\":25,\\"OrigPrice\\":6250,\\"ActualPrice\\":\\"6250\\",\\"attach\\":\\"\\",\\"OrderSource\\":10},\\"PayInfo\\":{\\"MchOrderNo\\":\\"pim1784635237083gn2uin6pm4ai87adyk83\\",\\"TransactionId\\":\\"tx20260721200041158935ihgcnxynly\\",\\"PaidTime\\":1784635241}}","payEventSig":"a1df35b720a4f09d44eb540a222c195ce1e4b784b987e153b9b55679f41755a1","outTradeNo":"28f7a5cc-4427-4b0c-bf26-228e7de19d76"}
响应示例
{"returnCode":"0","returnMessage":"success","requestId":"6a0f4155fdb041fbb0f08381424d3966","data":"ok"}
5. 退款接口
5.1 标准支付退款
5.1.1 申请退款
Path： /spay/refund/refunds
Method： POST
接口描述： 对已完成支付的标准支付订单发起退款申请。
请求参数
Headers
参数名称
类型
描述
TC-Payment-Callback
string
退款结果回调地址
TC-Authorization
string
签名认证信息，签名参考标准支付签名﻿
Body
参数名称
类型
是否必须
备注
transaction_id
string
否
Superapp 平台支付交易流水号，与 out_trade_no 二选一
out_trade_no
string
否
商户订单号，与 transaction_id 二选一
out_refund_no
string
是
商户退款单号，同一商户下唯一
reason
string
否
退款原因
refund_method
string
否
退款方式：ORIGINAL-原路退回 / BANKCARD-银行卡 / WALLET-钱包
channel
string
否
退款渠道：ORIGINAL-原路退款 / BALANCE-退回到余额
refund_source
string
否
退款来源： 1.人工客服 2.用户自己发起 3.其它
amount
object
是
退款金额信息
amount.refund
int64
是
退款金额，单位分
amount.total
int64
是
订单总金额，单位分
amount.currency
string
是
币种，例如 USD
goods_detail
array
否
退款商品明细
goods_detail[].merchant_goods_id
string
是
商户侧商品编码
goods_detail[].goods_name
string
否
商品名称
goods_detail[].unit_price
int64
是
商品单价，单位分
goods_detail[].refund_amount
int64
是
商品退款金额，单位分
goods_detail[].refund_quantity
int
是
退款数量
notify_url
string
是
退款结果通知 URL
merchant_id
string
是
商户号
响应参数
名称
类型
是否必须
备注
returnCode
string
是
响应 code，0 表示成功
returnMessage
string
否
响应信息
data
object
是
退款响应数据
data.refund_id
string
是
平台退款单号
data.out_refund_no
string
是
商户退款单号
data.transaction_id
string
是
Superapp 平台支付交易流水号
data.out_trade_no
string
是
商户订单号
data.channel
string
是
退款渠道
data.user_received_account
string
是
退款入账账户
data.success_time
string
否
退款成功时间
data.create_time
string
是
退款创建时间
data.status
string
是
退款状态：PROCESSING-处理中 / SUCCESS-退款成功 / CLOSED-退款关闭 / ABNORMAL-退款异常
data.amount
object
是
退款金额信息
data.amount.total
int64
是
订单总金额，单位分
data.amount.refund
int64
是
退款金额，单位分
data.amount.payer_total
int64
是
用户支付金额，单位分
data.amount.payer_refund
int64
是
用户退款金额，单位分
data.amount.currency
string
是
币种
data.amount.refund_fee
int64
是
退款手续费，单位分
requestId
string
是
请求链路 ID
请求示例
{"out_trade_no":"test_order_001","out_refund_no":"test_order_001-REF001","reason":"","notify_url":"https://example-test.com/callback/refund/mp_test_001","amount":{"refund":1600,"total":1600,"currency":"USD"},"goods_detail":[{"merchant_goods_id":"1","goods_name":"Tropical Citrus Iced Energy","unit_price":1600,"refund_amount":1600,"refund_quantity":1}],"merchant_id":"mi_test_merchant_001"}
响应示例
{"returnCode":"0","returnMessage":"OK","requestId":"6be7f9b106fe476c9be1ded444bf41ed","data":{"refund_id":"rn_test_refund_001","out_refund_no":"test_order_001-REF001","transaction_id":"tx_test_001","out_trade_no":"test_order_001","channel":"ORIGINAL","user_received_account":"","create_time":"2026-07-21T15:28:05+08:00","status":"PROCESSING","amount":{"total":1600,"refund":1600,"payer_total":1600,"payer_refund":1600,"currency":"USD","refund_fee":0}}}
5.1.2 查询退款
Path： /spay/refund/refunds/{out_refund_no}
Method： GET
接口描述： 通过商户退款单号查询退款详情。
请求参数
Headers
参数名称
描述
TC-Authorization
签名认证信息，签名参考标准支付签名﻿
Path
参数名称
类型
描述
是否必须
备注
out_refund_no
string
商户退款单号
是
-
响应参数
名称
类型
是否必须
备注
returnCode
string
是
响应 code，0 表示成功
returnMessage
string
否
响应信息
data
object
是
退款详情数据
data.refund_id
string
是
平台退款单号
data.out_refund_no
string
是
商户退款单号
data.transaction_id
string
是
Superapp 平台支付交易流水号
data.out_trade_no
string
是
商户订单号
data.channel
string
是
退款渠道
data.user_received_account
string
是
退款入账账户
data.success_time
string
否
退款成功时间
data.create_time
string
是
退款创建时间
data.status
string
是
退款状态：PROCESSING-处理中 / SUCCESS-退款成功 / CLOSED-退款关闭 / ABNORMAL-退款异常
data.amount
object
是
退款金额信息
data.amount.total
int64
是
订单总金额，单位分
data.amount.refund
int64
是
退款金额，单位分
data.amount.payer_total
int64
是
用户支付金额，单位分
data.amount.payer_refund
int64
是
用户退款金额，单位分
data.amount.currency
string
是
币种
data.amount.refund_fee
int64
是
退款手续费，单位分
requestId
string
是
请求链路 ID
请求示例
GET /spay/refund/refunds/test_order_001-REF001
响应示例
{"returnCode":"0","returnMessage":"OK","requestId":"7a3a18df41594da98e46ad9d70e918a1","data":{"refund_id":"rn_test_refund_001","out_refund_no":"test_order_001-REF001","transaction_id":"tx_test_001","out_trade_no":"test_order_001","channel":"ORIGINAL","user_received_account":"","success_time":"2026-07-21T20:12:56+08:00","create_time":"2026-07-21T20:11:25+08:00","status":"SUCCESS","amount":{"total":1600,"refund":1600,"payer_total":1600,"payer_refund":1600,"currency":"USD","refund_fee":0}}}
5.1.3 标准支付退款回调
退款审核完成后，平台通过 POST 方式向5.1.1接口申请退款时 TC-Payment-Callback Header 指定的地址推送通知。
Path： 申请退款时请求 Header TC-Payment-Callback 的值
Method： POST
请求参数
Headers
参数名称
描述
TC-Callback-Serial
superapp 平台商户序列号
TC-Callback-Signature
验签的签名值
TC-Timestamp
时间戳（秒）
TC-Callback-Nonce
验签的随机字符串
TC-Signature
调用超级应用服务平台服务验签的签名，签名参考超级应用平台签名验签﻿
TC-ApplicationID
超级应用服务平台服务的应用 ID
TC-BackendConfigID
超级应用平台接入 Superapp 后端配置 ID,用于区分环境,创建订单时请求 Header 中的 TC-BackendConfigID
Body
名称
类型
是否必须
备注
id
string
是
通知唯一编号
create_time
string
是
通知创建时间，RFC3339 格式
event_type
string
是
REFUND.SUCCESS / REFUND.CLOSED / REFUND.ABNORMAL
resource_type
string
是
固定为 encrypt-resource
summary
string
是
通知摘要
out_refund_no
string
是
商户退款单号
resource
object
是
加密通知数据
resource.algorithm
string
是
固定为 AEAD_AES_256_GCM
resource.original_type
string
是
固定为 refund
resource.ciphertext
string
是
Base64 编码的加密数据，使用 SymmetryKey 解密
resource.associated_data
string
否
参与解密的附加数据
resource.nonce
string
是
参与解密的随机串
resource.ciphertext 解密后数据结构：
名称
类型
是否必须
备注
mch_id
string
是
商户号
transaction_id
string
是
Superapp 平台支付交易流水号
out_trade_no
string
是
商户订单号
refund_id
string
是
平台退款单号
out_refund_no
string
是
商户退款单号
refund_status
string
是
退款状态：SUCCESS / CLOSED / ABNORMAL
success_time
string
否
退款成功时间（仅 SUCCESS 时返回）
user_received_account
string
是
退款入账账户
amount
object
是
退款金额信息
amount.total
string
是
订单总金额，单位分
amount.refund
string
是
退款金额，单位分
amount.payer_total
string
是
用户支付金额，单位分
amount.payer_refund
string
是
用户退款金额，单位分
amount.currency
string
是
币种
响应参数
名称
类型
是否必须
备注
returnCode
string
是
响应 code，0 表示成功
returnMessage
string
否
响应信息
data
string
是
响应数据，成功时为 OK
requestId
string
是
请求链路 ID
请求示例
﻿
{"id":"xot956537fkiaem2","create_time":"2026-07-21T20:12:57+08:00","resource_type":"encrypt-resource","event_type":"REFUND.SUCCESS","summary":"REFUND.SUCCESS","out_refund_no":"796be7e45d47b27b23e7-REF1416","resource":{"original_type":"refund","algorithm":"AEAD_AES_256_GCM","ciphertext":"N9v6vk+uRTppTbAxXYdZktZqfga8pA4OzoNukU0+wbHzhl7NWtQzDQs/F3G/xVvBCzW3koZZ2JUKkVKnF+v7+lUSEC11NEAltrdQk9AcSjR9IXnsLaTw8wT1t1R0NhU1hyBgR+bdA4J68kHEkva/WrhFhCG0OiBbabORJ/KUXO4OV4E936J3X+ecY7w+yos5wgWVgTdU/HAVJLyfkfzqzkY+DoP6BoPTJwA+Q0lMbUf+KQpeF0AYvyzvR+Jarzvs+7ehHlobdKUigKAjz2UhQfqUVmDgldMYVa1I5FFYHDkTmbI9MnZZTOW22f62TvotBwTNPhdDNCFJ13b8rAA6EWdAn4MQoqz4HpghYP2IRVJHs3Xl3NSEu5l3r2YtrvEQIUOYH73cGVUMngUyMR8B/105PkaetReNCl4BHL275sh0c1NhHv7Cy5CyeiTgDgz8bKcmMlyLl/Fm4geqdDBqILRCDSjTzmVDByPFZPDrcmkr53BiwPKWsU8CF5k4g/alr4rgnzaCyPtxF5mXDpQK59LrLMG+JsUKsESN6cXMoRTn0vEzzgQeo360A2w58g6Ni7NRBT6x4s7LYpUPC2CC9AVZtUI=","associated_data":"","nonce":"FdFteTZt9T8b"}
响应示例
﻿
{"returnCode":"0","returnMessage":"success","requestId":"6974f497beb2418b8707d6036cac589f","data":"ok"}
5.2 虚拟支付退款
5.2.1 申请退款
Path： /vpay/refund/refunds
Method： POST
接口描述： 对已完成支付的小程序/小游戏虚拟支付订单发起退款申请。
请求参数
Headers
参数名称
描述
TC-Payment-Callback
退款完成后退款结果回调地址
TC-MerchantID
超级应用平台中小程序绑定 superapp 的商户 ID
Query Parameters
参数名称
类型
描述
是否必须
备注
pay_sig
string
虚拟支付签名
是
虚拟支付签名,签名参考 paySig 签名，uri=/vpay/refund/refunds
Body
参数名称
类型
是否必须
备注
openid
string
否
下单用户 openid
transaction_id
string
否
Superapp 平台支付交易流水号，与 out_trade_no 二选一
out_trade_no
string
否
商户订单号，与 transaction_id 二选一
out_refund_no
string
是
商户退款单号
reason
string
否
退款原因
req_from
string
否
退款来源： 1.人工客服 2.用户自己发起 3.其它
amount
object
是
退款金额信息
amount.refund
int64
是
退款金额，单位分
amount.total
int64
是
订单总金额，单位分
amount.currency
string
是
币种
notify_url
string
是
退款结果通知 URL
merchant_id
string
是
商户号
响应参数
名称
类型
是否必须
备注
returnCode
string
是
响应 code，0 表示成功
returnMessage
string
否
响应信息
data
object
是
退款响应数据
data.refund_id
string
是
平台退款单号
data.out_refund_no
string
是
商户退款单号
data.transaction_id
string
是
Superapp 平台支付交易流水号
data.out_trade_no
string
是
商户订单号
data.channel
string
是
退款渠道
data.user_received_account
string
是
退款入账账户
data.success_time
string
否
退款成功时间
data.create_time
string
是
退款创建时间
data.status
string
是
退款状态：PROCESSING-处理中 / SUCCESS-退款成功 / CLOSED-退款关闭 / ABNORMAL-退款异常
data.amount
object
是
退款金额信息
data.amount.total
int64
是
订单总金额，单位分
data.amount.refund
int64
是
退款金额，单位分
data.amount.payer_total
int64
是
用户支付金额，单位分
data.amount.payer_refund
int64
是
用户退款金额，单位分
data.amount.currency
string
是
币种
data.amount.refund_fee
int64
是
退款手续费，单位分
requestId
string
是
请求链路 ID
请求示例
{"out_trade_no":"test-mnp-order-001","out_refund_no":"test-mnp-order-001-REF001","reason":"","notify_url":"https://example-test.com/callback/refund/mp_test_001","amount":{"refund":250,"total":6250,"currency":"USD"},"req_from":"2","openid":"test_openid_001","merchant_id":"mi_test_merchant_001"}
响应示例
{"returnCode":"0","returnMessage":"OK","requestId":"901f09e3f88c4af8a016bde5df5f7f14","data":{"refund_id":"rn_test_vrefund_001","out_refund_no":"test-mnp-order-001-REF001","transaction_id":"tx_test_mnp_001","out_trade_no":"test-mnp-order-001","channel":"ORIGINAL","user_received_account":"","create_time":"2026-07-21T13:13:17+08:00","status":"PROCESSING","amount":{"total":250,"refund":250,"payer_total":250,"payer_refund":250,"currency":"USD","refund_fee":0}}}
5.2.2 虚拟支付退款回调
Path： 申请退款时接口5.2.1 请求 Header TC-Payment-Callback 的值
Method： POST
请求参数
Headers
参数名称
描述
TC-Timestamp
时间戳（秒）
TC-Signature
调用超级应用服务平台服务验签的签名，签名参考超级应用平台签名验签﻿
TC-ApplicationID
超级应用服务平台服务的应用 ID
TC-BackendConfigID
超级应用平台接入 Superapp 后端配置 ID,用于区分环境,创建订单时请求 Header 中的 TC-BackendConfigID
Body
名称
类型
是否必须
备注
eventType
string
是
REFUND.{{退款状态}}  退款状态 SUCCESS / CLOSED / ABNORMAL
event
string
是
事件标识，同 eventType
payload
string
是
JSON 字符串，解析后为退款通知数据
payEventSig
string
是
支付签名，签名算法伪代码为： pay_event_sig = to_hex(hmac_sha256(app_key, event + '&' + payload))
outRefundNo
string
是
商户退款单号
payload 解析后数据结构：
名称
类型
是否必须
备注
mch_id
string
是
商户号
transaction_id
string
是
Superapp 平台支付交易流水号
out_trade_no
string
是
商户订单号
refund_id
string
是
平台退款单号
out_refund_no
string
是
商户退款单号
refund_status
string
是
退款状态：SUCCESS / CLOSED / ABNORMAL
success_time
string
否
退款成功时间
user_received_account
string
是
退款入账账户
amount
object
是
退款金额信息
响应参数
名称
类型
是否必须
备注
returnCode
string
是
响应 code，0 表示成功
returnMessage
string
否
响应信息
data
string
是
响应数据，成功时为 OK
requestId
string
是
请求链路 ID
5.2.3 查询虚拟支付退款
Path： /vpay/refund/refunds/query
Method： POST
接口描述：
查询虚拟支付退款状态。
请求参数
Query Parameters
参数名称
类型
描述
是否必须
备注
pay_sig
string
虚拟支付签名,签名参考 paySig 签名，uri=/vpay/refund/refunds/query
是
-
Body
参数名称
类型
是否必须
备注
out_refund_no
string
是
商户退款单号
响应参数
名称
类型
是否必须
备注
returnCode
string
是
响应 code，0 表示成功
returnMessage
string
否
响应信息
data
object
是
退款详情数据
data.refund_id
string
是
平台退款单号
data.out_refund_no
string
是
商户退款单号
data.transaction_id
string
是
Superapp 平台支付交易流水号
data.out_trade_no
string
是
原商户订单号
data.channel
string
是
退款渠道
data.user_received_account
string
是
退款入账账户
data.success_time
string
否
退款成功时间
data.create_time
string
是
退款创建时间
data.status
string
是
退款状态：PROCESSING / SUCCESS / CLOSED / ABNORMAL
data.amount
object
是
退款金额信息
data.amount.total
int64
是
订单总金额，单位分
data.amount.refund
int64
是
退款金额，单位分
data.amount.payer_total
int64
是
用户支付金额，单位分
data.amount.payer_refund
int64
是
用户退款金额，单位分
data.amount.currency
string
是
币种
data.amount.refund_fee
int64
是
退款手续费，单位分
requestId
string
是
请求链路 ID
请求示例
POST /vpay/refund/refunds/query?pay_sig=test_sig_value
{"out_refund_no":"test-mnp-order-001-REF001"}
响应示例
{"returnCode":"0","returnMessage":"OK","requestId":"3f07346621694d01b246a545a5c77a00","data":{"refund_id":"rn_test_vrefund_001","out_refund_no":"test-mnp-order-001-REF001","transaction_id":"tx_test_mnp_001","out_trade_no":"test-mnp-order-001","channel":"ORIGINAL","user_received_account":"","success_time":"2026-07-21T20:16:25+08:00","create_time":"2026-07-21T20:14:29+08:00","status":"SUCCESS","amount":{"total":6250,"refund":250,"payer_total":6250,"payer_refund":250,"currency":"USD","refund_fee":0}}}
﻿
﻿

帮助和支持

本页内容是否解决了您的问题？

您也可以联系销售或提交工单以寻求帮助。

填写满意度调查问卷，共创更好文档体验。

文档反馈

Header 名称	说明
TC-ApplicationID	超级应用平台应用 ID
TC-BackendConfigID	超级应用平台接入 Superapp 后端配置 ID,用于区分环境
TC-PackageName	超级应用平台应用包名
TC-Signature	超级应用平台请求签名，签名参考超级应用平台签名验签
TC-Timestamp	时间戳（秒）
TC-TraceID	链路追踪 ID

请求头	描述	说明	示例
TC-OpenId	OpenId string，用户在小程序下唯一标识	采用 AES ECB 模式加密后进行十六进制编码，密钥为配置管理中的 SecretKey	8d45e4881656d8fb4f97a442423093a5db9ec5691f6e8b17f895ab0fd935c0e7
TC-MiniAppID	MiniAppID string，小程序在 app 下唯一标识	采用 AES ECB 模式加密后进行十六进制编码，密钥为配置管理中的SecretKey	8dc9708f26a1f5157e66c27892c78a88440d324a986a67fa7acb4d29511c7d18

名称	类型	是否必须	备注
userId	string	是	用户匿名化 ID，由 superapp 通过 SDK 设置的 APP 登录用户唯一标识。

参数名称	描述
TC-Payment-Callback	支付成功或失败回调地址
TC-MerchantID	超级应用平台中小程序绑定 superapp 的商户 ID
TC-UserID	Superapp 登录用户 ID
TC-TradeType	交易类型，JSAPI：小程序支付
TC-Platform-UserID	超级应用平台用户 openid
TC-ApplicationID	超级应用平台应用 ID
TC-Authorization	签名认证信息，签名参考标准支付签名

参数名称	备注
TC-Callback-Serial	验签的 superapp 平台商户序列号 /superapp 平台商户支付公钥 ID【商户序列号、商户证书】
TC-Signature	签名参考超级应用平台签名验签
TC-Timestamp	时间戳（秒）
TC-Callback-Nonce	-
TC-Callback-Signature	签名参考标准支付签名
TC-ApplicationID	创建订单时请求 Header 中的 TC-ApplicationID
TC-BackendConfigID	创建订单时请求 Header 中的 TC-BackendConfigID

参数名称	字段类型	描述	是否必须	备注
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	支付签名	是	虚拟支付签名,签名参考 paySig 签名,uri 取值固定为requestMidasPaymentGameItem
appId	string	超级应用平台应用 ID	是	-
miniAppId	string	超级应用平台小游戏 appid	是	-
goodsName	string	游戏道具名称	是	-
orderSource	int	订单来源	是	订单来源，固定值1
event	string	事件类型	是	固定值： minigame_game_pay_goods_deliver_notify

tencent cloud

腾讯云超级应用服务

接口列表

接口列表

公共说明

公共请求头

1. 小程序登录接口

1.1 检查用户是否存在

请求头信息

请求参数

响应参数

请求示例

响应示例

1.2 获取用户临时信息 Code

请求参数

响应参数

请求示例

响应示例

1.3 获取用户邮箱

请求参数

响应参数

请求示例

响应示例

1.4 获取用户手机号

请求参数

响应参数

请求示例

响应示例

1.5 获取用户昵称

请求参数

响应参数

请求示例

响应示例

1.6 获取用户头像

请求参数

响应参数

请求示例

响应示例

1.7 接收订阅消息

请求参数

响应参数

请求示例

响应示例

2. 小程序支付接口

2.1 创建小程序预订单

请求参数

响应参数

请求示例

响应示例

2.2 小程序预订单支付回调

请求参数

响应参数

请求示例

响应示例

2.3 商户订单号查询订单

请求参数

响应参数

请求示例

响应示例

﻿

2.4 关闭订单

请求参数

响应参数

请求示例

响应示例

3. 小游戏虚拟支付接口

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

请求参数

响应参数

请求示例

响应示例

3.2 小游戏支付回调

请求参数

响应参数

请求示例

响应示例

4. 小程序虚拟支付接口

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

请求参数

响应参数