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

下载
聚焦模式
字号
最后更新时间： 2026-10-21 11:41:11
接口列表
公共说明
公共请求头
以下请求头为所有超级应用平台调用 Superapp 服务接口公共参数，各接口的请求参数中不再重复列出：
参数名称
必选
类型
描述
示例值
TC-ApplicationID
是
string
超级应用平台应用 ID
app-abo181jy4f
TC-BackendConfigID
是
string
超级应用平台接入 Superapp 后端配置 ID,用于区分环境
appserver-1
TC-PackageName
是
string
超级应用平台应用包名
com.tencent.demo
TC-Signature
是
string
超级应用平台请求签名，基于 TC-Timestamp 计算生成签名，签名参考超级应用平台签名验签﻿
8ce14c68e234e1581fee873c478897c7
TC-Timestamp
是
string
时间戳（毫秒）
1787375938382
TC-TraceID
是
string
链路追踪 ID
eae6bf0943eb463d9120ac0d54366e4b]
说明：
超级应用平台 > Superapp 的请求头中 TC-Timestamp 是毫秒，因为我们为了遵循客户的标准，目前我们的客户都是使用的毫秒。
Superapp > 超级应用平台的回调请求 TC-Timestamp 是秒，因为我们为了兼容从微信小程序迁移过来的情况，这个参数会透传给小程序方的 Pay-Timestamp，所以遵循了微信的标准，但是超级应用平台验签同样支持毫秒，如果 Superapp 坚持使用毫秒，那么需要小程序方同时修改。
1. 小程序登录接口
1.1 检查用户是否存在
Path： /user/checkUser
Method： POST
接口描述：
根据 superapp 用户 ID 检查用户是否存在
请求参数
Header 参数：
参数名称
必选
类型
描述
示例值
TC-OpenId
是
string
OpenId string，用户在小程序下唯一标识，采用 AES ECB 模式加密后进行十六进制编码，密钥为配置管理 中的SecretKey
8d45e4881656d8fb4f97a442423093a5db9ec5691f6e8b17f895ab0fd935c0e7
TC-MiniAppID
是
string
MiniAppID string，小程序在 app 下唯一标识，采用 AES ECB 模式加密后进行十六进制编码，密钥为配置管理 中的SecretKey
8dc9708f26a1f5157e66c27892c78a88440d324a986a67fa7acb4d29511c7d18
Body 参数：
参数名称
必选
类型
说明
示例值
userId
是
string
用户匿名化 ID，由 superapp 通过 SDK 设置的 APP 登录用户唯一标识。
test_user_id_001
响应参数
参数名称
必选
类型
描述
示例值
returnCode
是
string
响应 code,0表示成功
0
returnMessage
否
string
响应信息
OK
data
是
boolean
用户是否存在
true
requestId
是
string
请求链路 ID
fd203616014e4ca8935f08a913ecfcb4
请求示例
{"userId":"test_user_id_001"}
响应示例
{"returnCode":"0","returnMessage":"OK","requestId":"fd203616014e4ca8935f08a913ecfcb4","data":true}
1.2 获取用户临时信息 Code
Path： /user/getUserInfoTemporaryCode
Method： POST
接口描述：
根据 Type 获取用户手机号或者邮箱的临时凭证
请求参数
Body 参数：
参数名称
必选
类型
描述
示例值
type
是
string
获取类型 有效值：email、phone
phone
userId
是
string
用户匿名化 ID，由 superapp 通过 SDK 设置的 APP 登录用户唯一标识。
test_user_id_001
响应参数
参数名称
必选
类型
描述
示例值
returnCode
是
string
响应 code,0表示成功
0
returnMessage
否
string
响应信息
OK
data
是
object
响应数据。
-
data.data
是
string
根据查询类型返回脱敏的手机号或者邮箱，例如158****82850
158****82850/mur****g@tencent.com
data.code
是
string
获取手机或者邮箱的临时凭证 Code
d3fc1f12b00b439491082a5fad20c45f
requestId
是
string
请求链路 ID
fd203616014e4ca8935f08a913ecfcb4
请求示例
{"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 获取用户邮箱
请求参数
Body 参数：
参数名称
必选
类型
描述
示例值
temporaryCode
是
string
临时凭证 Code
5ee7263392e441f782ec1bba85e88fbe
userId
是
string
用户匿名化 ID，由 superapp 通过 SDK 设置的 APP 登录用户唯一标识。
test_user_id_001
响应参数
参数名称
必选
类型
说明
示例值
returnCode
是
string
响应 code,0表示成功
0
returnMessage
否
string
响应信息
OK
data
是
string
用户邮箱信息，基于 AES CBC（使用密钥的前16字节作为 iv） 加密后进行 base64 编码后的字符串，密钥为配置管理 中的SecretKey
4bhhBZj4WpfhVc0U66AAbrZi5vIajBZ7abBH96xgric
requestId
是
string
请求链路 ID
fd203616014e4ca8935f08a913ecfcb4
请求示例
{"temporaryCode":"5ee7263392e441f782ec1bba85e88fbe","userId":"test_user_id_001"}
响应示例
{"returnCode":"0","returnMessage":"OK","requestId":"aa12162189324f789796a738ddf1eb0f","data":"4bhhBZj4WpfhVc0U66AAbrZi5vIajBZ7abBH96xgric="}
1.4 获取用户手机号
Path： /user/getUserPhoneNumber
Method： POST
接口描述：
根据临时凭证 code 获取用户手机号
请求参数
Body 参数：
参数名称
必选
类型
描述
示例值
temporaryCode
是
string
临时凭证 Code
5ee7263392e441f782ec1bba85e88fbe
userId
是
string
用户匿名化 ID，由 superapp 通过 SDK 设置的 APP 登录用户唯一标识。
test_user_id_001
响应参数
参数名称
必选
类型
描述
示例值
returnCode
是
string
响应 code,0表示成功
0
returnMessage
否
string
响应信息
OK
data
是
string
用户手机号对象 json 字符串加密，基于 AES CBC （使用密钥的前16字节作为 iv）加密后进行 base64 编码后的字符串，密钥为配置管理 中的SecretKey
EOc8Hi03A4y60YkmUMNqtQ
requestId
是
string
请求链路 ID
fd203616014e4ca8935f08a913ecfcb4
手机号对象：
参数名称
必选
类型
描述
示例值
countryCode
是
string
国家/地区电话区号（纯数字，不带 + 号，1~3位）
86
purePhoneNumber
是
string
去除国家/地区电话区号后的纯数字号码，长度4-15位字符串
13820080808
phoneNumber
是
string
UI 渲染展示号码，小程序/前端直接绑定渲染。长度4-40位字符串，纯数字数量长度4-15位
+86 138 2008 0808
﻿
请求示例
{"temporaryCode":"26707436c5324e79997d66698231fe4d","userId":"test_user_id_001"}
响应示例
{"returnCode":"0","returnMessage":"OK","requestId":"adadc87a140f40a2b1657a1eb996d550","data":"EOc8Hi03A4y60YkmUMNqtQ=="}
1.5 获取用户昵称
Path： /user/getUserNick
Method： POST
接口描述：
获取用户昵称
请求参数
Body 参数：
参数名称
必选
类型
描述
示例值
userId
是
string
用户匿名化 ID，由 superapp 通过 SDK 设置的 APP 登录用户唯一标识。
test_user_id_001
响应参数
参数名称
必选
类型
描述
示例值
returnCode
是
string
响应 code,0表示成功
0
returnMessage
否
string
响应信息
OK
data
是
string
用户昵称
test nick
requestId
是
string
请求链路 ID
fd203616014e4ca8935f08a913ecfcb4
请求示例
{"userId":"test_user_id_001"}
响应示例
{"returnCode":"0","returnMessage":"OK","requestId":"a58ffe1dc53f461fa3c5fb109781631a","data":"test nick"}
1.6 获取用户头像
Path： /user/getUserAvatar
Method： POST
接口描述：
获取用户头像
请求参数
Body 参数：
参数名称
必选
类型
描述
示例值
userId
是
string
用户匿名化 ID，由 superapp 通过 SDK 设置的 APP 登录用户唯一标识。
test_user_id_001
响应参数
参数名称
必选
类型
描述
示例值
returnCode
是
string
响应 code,0表示成功
0
returnMessage
否
string
响应信息
OK
data
是
string
用户头像地址
﻿https://example-test.com/image/avatar/test_user.jpg﻿
requestId
是
string
请求链路 ID
fd203616014e4ca8935f08a913ecfcb4
请求示例
{"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 平台侧推送的用户订阅消息内容
请求参数
Body 参数：
参数名称
必选
类型
描述
示例值
accountId
是
string
消息的归属用户 ID(同 userId)
test_user_id_001
messageId
是
string
消息唯一 ID
a75a19fc0aa64e4171f8e856e0b16927
content
是
string
消息内容
Pay time:2026-07-16 15:04:00
dataTime
是
int
消息发送时间的时间戳秒
1784189857
templateId
是
string
消息模板 ID
mti_test_template_001
mnpId
是
string
小程序 appid
mp_test_001
mnpName
是
string
小程序名称
Daily Coffee
templateTitle
是
string
模板 标题
Order Notify
state
是
string
跳转小程序类型：developer 为开发版；trial 为体验版；formal 为正式版；默认为正式版
formal
page
否
string
点击消息卡片后的跳转页面，仅限本小程序内的页面， 支持带参数,（示例 index?foo=bar）。该字段不填则模板无跳转。
index?foo=bar
mnpIcon
是
string
小程序图标
https://example-test.com/image/icon/coffee.png
响应参数
参数名称
必选
类型
说明
示例值
returnCode
是
string
响应 code, 0表示成功
0
returnMessage
否
string
响应信息
OK
data
是
bool
处理结果
true
requestId
是
string
请求处理链路 ID
fd203616014e4ca8935f08a913ecfcb4
请求示例
{"messageId":"a75a19fc0aa64e4171f8e856e0b16927","accountId":"test_user_id_001","templateId":"mti_test_template_001","content":"Remarks:Membership upgrade offers 30% off\\nTravel date:2026-08-08 11:00:00\\nService content:Upgrade Reminder","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
接口描述：
小程序创建预订单
请求参数
Header 参数
参数名称
必选
类型
描述
示例值
TC-Payment-Callback
是
string
支付成功或失败回调地址
https://example.com/callback
TC-MerchantID
是
string
超级应用平台中小程序绑定 superapp 的商户 ID
mi59a93ddccc
TC-UserID
是
string
Superapp 登录用户 ID
test_user_id_001
TC-TradeType
是
string
交易类型，JSAPI：小程序支付
JSAPI
TC-Platform-UserID
是
string
超级应用平台用户 openid
oe49fc39b7eb17872cctaQq28560
TC-ApplicationID
是
string
超级应用平台应用 ID
app-abo181jy4f
TC-Authorization
是
string
签名认证信息，签名参考标准支付签名﻿
WECHATPAY2-SHA256-RSA2048 mchid="mi59a93ddccc",nonce_str="e2f473eb9550bef157882dd1acdd63ed",signature="oT82oRCkZ5S/FxamuAiEKKKZRN/y0e+h7NMXg4a8pgvRm7Cy0QYBTI9chBphXc/iktDNNbZ36LrOHEidk13/td6Xij76tgor9FspZLB3Sx5393eL8A9bvYbCRuUeGFofJGkT1liW7JWdsPCyYF8HsgleW9cRfOolzKKhg7fGk3JH4/QxbWkGGQO9qP5FyrDnTj9K4xrslJsIbtC1eNG40xPA8p5P6zmSS6Q1ISLe/bm8QFcDJHAJUn/MTJWjHDxr00BbjMjUQl5oObkA+G6Q3DCaquYJlp8TDkEluG4Pffrd3inXl+98ZKlD6uiKufoJYk5dwU8Po2dIQjfXWQStWg==
Body 参数：
参数名称
必选
类型
描述
示例值
appid
是
string
商户小程序 appid,是商户在平台的唯一标识,需确保该 appid 与【mchid】有绑定关系。
mp5ip444wt995zdp
description
是
string
商品信息描述，商户需传递能真实代表商品信息的描述，不能超过127个字符。
Tropical Citrus Iced Energy
out_trade_no
是
string
商户系统内部订单号，要求6-32个字符内，只能是数字、大小写字母_-|* 且在同一个商户号下唯一。
f49b3e588f1fec899b68
time_expire
是
string
支付结束时间，用户能够完成该笔订单支付的最后时限，并非订单关闭的时间。超过此时间后，用户将无法对该笔订单进行支付。 格式要求：支付结束时间需遵循  标准格式：yyyy-MM-DDTHH:mm:ss+TIMEZONE。yyyy-MM-DD 表示年月日；T 字符用于分隔日期和时间部分；HH:mm:ss 表示具体的时分秒；TIMEZONE 表示时区（例如，+08:00 对应东八区时间，即北京时间）。
2026-10-30T18:30:00+08:00
attach
否
string
商户在创建订单时可传入自定义数据包，该数据对用户不可见，用于存储订单相关的商户自定义信息，其总长度限制在128字符以内。支付成功后查询订单 API 和支付成功回调通知均会将此字段返回给商户。
{"appid":"mp_test_001"}
amount
是
object
订单金额信息。
-
amount.total
是
string
订单总金额，最多支持 12 位整数，最多 2 位小数。仅允许数字，最多包含 1 个小数点，不支持千分位分隔符、货币符号、负数。合法示例："0.5"、"10.5"、"100.55"、"1000"、"10000.00"。
1600.00
amount.currency
是
string
货币类型，符合 ISO 4217 标准的三位字母代码。
USD
payer
是
object
支付者信息。
-
payer.openid
是
string
超级应用平台用户 openid。
o6bd1c45d56c17841qEDgWR88700
detail
是
object
商品信息。
-
detail.cost_price
否
string
订单原价，最多支持 12 位整数，最多 2 位小数。仅允许数字，最多包含 1 个小数点，不支持千分位分隔符、货币符号、负数。合法示例："0.5"、"10.5"、"100.55"、"1000"、"10000.00"。
1600.00
detail.goods_detail
是
array[object]
商品列表。
-
detail.goods_detail.merchant_goods_id
是
string
商户侧商品编码，由半角的大小写字母、数字、中划线、下划线中的一种或几种组成。
6a798208b6370b456c50fb5f
detail.goods_detail.goods_name
否
string
商品的实际名称。
Earl Grey Milk Tea
detail.goods_detail.quantity
是
int
用户购买商品数量。
1
detail.goods_detail.unit_price
是
string
商品单价，最多支持 12 位整数，最多 2 位小数。仅允许数字，最多包含 1 个小数点，不支持千分位分隔符、货币符号、负数。合法示例："0.5"、"10.5"、"100.55"、"1000"、"10000.00"。
1600.00
mchid
是
string
商户号
mp5ip444wt995zdp
响应参数
参数名称
类型
必选
说明
示例值
returnCode
string
是
响应 code,0表示成功
0
returnMessage
string
否
响应信息
OK
data
object
是
响应数据
-
data.prepayId
string
是
superapp 订单号
pip1787320103622n1mjc6qgytpith9yg9pb
requestId
string
是
请求链路 ID
fd203616014e4ca8935f08a913ecfcb4
请求示例
{"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 的请求方式，向/v3/pay/transactions/jsapi 接口中请求的 header TC-Payment-Callback 参数值发送回调通知，让商户知晓用户已完成支付。
Path： /v3/pay/transactions/jsapi 接口中请求的 header TC-Payment-Callback 参数值
Method： POST
接口描述：
小程序预订单支付回调
请求参数
Header 参数：
参数名称
必选
类型
描述
示例值
TC-Callback-Serial
是
string
验签的 superapp 平台商户序列号 /superapp 平台商户支付公钥 ID【商户序列号、商户证书】
7510596630
TC-Signature
是
string
签名参考超级应用平台签名验签﻿
5228b3d0b157a66568ada815a8d8eff2
TC-Timestamp
是
string
时间戳（秒）
1787320108
TC-Callback-Nonce
是
string
-
vnmlsv2818mgy1jv
TC-Callback-Signature
是
string
签名参考标准支付签名﻿
nPzashzhDbjJ2i6+E9yGOiV0vCGoEr54mLATaom60JKOuQSEYBHoFUQuU+IfrL1NNCUqJRNDQc7C3RxyFRJvOCJSG8uyQpDW4de+EM72KEVLC8mbv92mdlFhsC/dlwhIuWIbpUdXxXHZvpSs3ZOTBPnxQqpCNcmYOUrFlU+LqrspPfBo3DdKvoQ7AZM0Wl5rfWdwgNryPDH7Gu/HpiG6qZPbDiybZCce4fxjTFZA0DHuvw0MU+nWMQYSaQIH7FI1nmNNzqHb/1O6tODV548Rvaph2km1T6/FwJP0xj5JdiPuWUZFsQtpJDMCXUgBjA/zs1tU/Si/pk7nhf/Kg2/o8Q==
TC-ApplicationID
是
string
创建订单时请求 Header 中的 TC-ApplicationID
app-abo181jy4f
TC-BackendConfigID
是
string
创建订单时请求 Header 中的 TC-BackendConfigID
appserver-1
Body 参数：
参数名称
必选
类型
描述
示例值
id
是
string
【通知 ID】回调通知的唯一编号
ixg0t157h5kt7pjz
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秒。
2026-08-21T21:48:28+08:00
event_type
是
string
【通知的类型】Superapp 支付回调通知的类型。 支付成功-TRANSACTION.SUCCESS。 支付失败-TRANSACTION.PAYERROR。
TRANSACTION.SUCCESS
resource_type
是
string
【通知数据类型】通知的资源数据类型，固定为 encrypt-resource。
encrypt-resource
summary
是
string
【回调摘要】Superapp 平台支付对回调内容的摘要备注。
Pay success
transaction_id
否
string
Superapp 平台支付交易流水号
tx2026082121482836425181pu94tn0w
pay_mode
否
string
支付方式（如 Wallet）
Wallet
out_trade_no
是
string
商户系统内部订单号
f49b3e588f1fec899b68
resource
是
object
【通知数据】通知资源数据。
-
resource.algorithm
是
string
【加密算法类型】回调数据密文的加密算法类型，目前为 AEAD_AES_256_GCM，开发者需要使用同样类型的数据进行解密。
AEAD_AES_256_GCM
resource.ciphertext
是
string
【数据密文】Base64编码后的回调数据密文，商户需 Base64 解码并使用 APIV3 密钥解密。
dc2GfDp5+5xq8qchDN67Xfv84OBgjJ+N/X99mUo/5LdU0m8i2Ai9JFG9iIq0pIu/XLxzMjg4x3+TDJpxjwCQdDGZgO2gLlDNUFqUddP8jJGyXJ32msC3wAAwQ9bzROEi4ECJr1Y7yWnKnC372IIe0BXev7BTP6D2Iq5Trz1oNqz02Vsn8K7aW7dcX64vXoMAM/S4BBq8PRs2xxy6hCcAU+9eyiYsvvl3ZTjVw+9hVLGgS21yRrN31kwzDHsH6ALnp3Gje0ywTXxyodDilQV+XcJRDCqEq2TNIvrGmjey723cSQcarJuuA1sZSIDSKhBdOYAR/1W5LNE8tcpURqM0mLWN1yZsdMBKrw28ZSXo5f7wKLA0ScdlDJB7/7d5+NQf6x2tIFDnPirKpnIOqk7tOVgar/LQLyzxAvBOLqohzXEw4q3Dgc3wlyo4sLx8mAJtP4+744o7UW4mpQBhlSnMP92aEdHInZ1JvPYni4+XZAMyDKenjDqI5Q/ctpMhkILmBQDpxP4NBW4R82Uqm2opyYsAnNwhl/iKnqs+K19r3dy+9VDg/y/o9+MdkmQXuwMgWHuHoCFsFdZ3GJSeWYOJbfwX3d/WlOvpvs0LwGsak3k2dXhsv+v9yR1EAg8pyeQ6WLnf
resource.associated_data
否
string
【附加数据】参与解密的附加数据，该字段可能为空。
-
resource.original_type
是
string
【原始回调类型】加密前的对象类型，为 transaction。
transaction
resource.nonce
是
string
【随机串】参与解密的随机串。
yfYEe1uRgrmC
resource.ciphertext 解密后数据结构：
参数名称
类型
必选
描述
示例值
transaction_id
string
否
Superapp 平台支付交易流水号
tx2026082121482836425181pu94tn0w
mch_id
string
是
商户号
mi59a93ddccc
out_trade_no
string
是
商户系统内部订单号
f49b3e588f1fec899b68
appid
string
是
商户小程序 appid
mp5ip444wt995zdp
trade_state
string
是
交易状态，枚举值： - SUCCESS：支付成功 - REFUND：转入退款 - NOTPAY：未支付 - CLOSED：已关闭 - REVOKED：已撤销 - USERPAYING：用户支付中 - PAYERROR：支付失败
SUCCESS
trade_state_desc
string
是
交易状态描述
SUCCESS
trade_type
string
是
交易类型，固定为 JSAPI
JSAPI
bank_type
string
是
用户支付方式，格式：银行简码_类型（如 ICBC_DEBIT），非银行卡支付统一为 OTHERS
Wallet
success_time
string
是
支付完成时间
2026-07-16T17:44:53+08:00
payer
object
是
支付者信息。
-
payer.openid
string
是
超级应用平台用户 ID
o6bd1c45d56c17841qEDgWR88700
attach
string
否
下单时传入的透传数据
{"appid":"mp_test_001"}
amount
object
是
订单金额信息，见下表
-
amount：
参数名称
类型
必选
说明
示例值
total
string
是
订单总金额
1600.00
payer_total
string
是
用户实际支付金额
1600.00
currency
string
是
币种
USD
payer_currency
string
是
用户支付币种
USD
响应参数
参数名称
类型
必选
说明
示例值
returnCode
string
是
响应 code,0表示成功
0
returnMessage
string
否
响应信息
OK
data
boolean
是
是否通知商户成功
true
requestId
string
是
请求链路 ID
fd203616014e4ca8935f08a913ecfcb4
请求示例
{"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
接口描述：
根据商户订单号查询订单
请求参数
Header 参数：
参数名称
必选
类型
描述
示例值
TC-Authorization
是
string
签名认证信息，签名参考标准支付签名﻿
WECHATPAY2-SHA256-RSA2048 mchid="mi59a93ddccc",nonce_str="a60b588603",signature="D2euMbDqrigI2NwP+uADgyjyH8by4hi1Y0ze9vNBMIJs6jy98ktvXg7j7F/fyAvEM63iVTE7WRHAZ4T9n3vGaCcAakYGljL503wO4gHIYudqAeZnv/DenJjEDJysV50jeF6NV1fvFNAKsGMoq8afpKFDx08KSR5clOqpRt4FQ6aKxpNQrMIdV52ZBnnQUqbST/BqchYWeTk+ccBp/0lHqo046S0QXvkMwW6X155g4UxwCVIae9zFi/4AANBNCnvRrn6DS31zc9AXvljMdnnJ4RWDw4SuGIJATK/lQNawwPBOxbZYWhjuRIctmv8FyMS2zjyjEm2GEF4chfm8lm4Yeg==
Path 参数：
参数名称
必选
类型
描述
示例值
out_trade_no
是
string
商户订单号
f49b3e588f1fec899b68
Query 参数：
参数名称
必选
类型
描述
示例值
mchid
是
string
商户下单时传入的商户号
mi59a93ddccc
响应参数
参数名称
必选
类型
描述
示例值
returnCode
是
string
响应 code,0表示成功
0
returnMessage
否
string
响应信息
OK
data
是
object
响应数据
-
data.app_id
是
string
商户下单时传入的小程序 appid
mp5ip444wt995zdp
data.mchid
是
string
商户下单时传入的商户号
mi59a93ddccc
data.out_trade_no
是
string
商户下单时传入的商户系统内部订单号
f49b3e588f1fec899b68
data.transaction_id
是
string
Superapp 平台支付交易流水号
tx2026082121482836425181pu94tn0w
data.trade_type
否
string
返回当前订单的交易类型，枚举值： - JSAPI：小程序支付
JSAPI
data.trade_state
是
string
交易状态，枚举值： - SUCCESS：支付成功 - REFUND：转入退款 - NOTPAY：未支付 - CLOSED：已关闭 - REVOKED：已撤销 - USERPAYING：用户支付中 - PAYERROR：支付失败
SUCCESS
data.trade_state_desc
是
string
对交易状态的详细说明
SUCCESS
data.bank_type
否
string
用户支付方式说明，订单支付成功后返回，格式为银行简码_具体类型(DEBIT 借记卡/CREDIT 信用卡)
Wallet
data.attach
否
string
商户在创建订单时可传入自定义数据包。
{\\"orderId\\":\\"6a885722038b71eee0fcddd6\\"}
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秒。
2026-07-16T17:44:53+08:00
data.payer
否
object
订单的支付者信息，订单支付成功后返回，superapp 用户 ID
u7zwkxp5tz4kfa5hlz4jb53769jdkrkg
data.amount
否
object
订单金额信息
-
data.amount.total
否
string
订单总金额
1600.00
data.amount.payer_total
否
string
用户实际支付金额
1600.00
data.amount.currency
否
string
货币类型
USD
data.amount.payer_currency
否
string
用户支付币种
USD
requestId
是
string
请求链路 ID
fd203616014e4ca8935f08a913ecfcb4
请求示例
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
接口描述：
根据商户订单号关闭订单
请求参数
Header 参数：
参数名称
必选
类型
描述
示例值
TC-Authorization
是
string
签名认证信息，签名参考标准支付签名﻿
WECHATPAY2-SHA256-RSA2048 mchid="mi59a93ddccc",nonce_str="a60b588603",signature="D2euMbDqrigI2NwP+uADgyjyH8by4hi1Y0ze9vNBMIJs6jy98ktvXg7j7F/fyAvEM63iVTE7WRHAZ4T9n3vGaCcAakYGljL503wO4gHIYudqAeZnv/DenJjEDJysV50jeF6NV1fvFNAKsGMoq8afpKFDx08KSR5clOqpRt4FQ6aKxpNQrMIdV52ZBnnQUqbST/BqchYWeTk+ccBp/0lHqo046S0QXvkMwW6X155g4UxwCVIae9zFi/4AANBNCnvRrn6DS31zc9AXvljMdnnJ4RWDw4SuGIJATK/lQNawwPBOxbZYWhjuRIctmv8FyMS2zjyjEm2GEF4chfm8lm4Yeg==
Path 参数：
参数名称
必选
类型
描述
示例值
out_trade_no
是
string
商户订单号
f49b3e588f1fec899b68
Body 参数：
参数名称
类型
必选
描述
示例值
mchid
string
是
商户下单时传入的商户号
mi59a93ddccc
响应参数
参数名称
类型
必选
描述
示例值
returnCode
string
是
响应 code，0 表示成功
0
returnMessage
string
否
响应信息
OK
data
string
是
响应数据，成功时为 ok
ok
requestId
string
是
请求链路 ID
fd203616014e4ca8935f08a913ecfcb4
请求示例
{"mchid":"mi_test_merchant_001"}
响应示例
{"returnCode":"0","returnMessage":"OK","requestId":"e82df47154eb40408e66f8b6a9693e68","data":"ok"}
3. 小游戏虚拟支付接口
3.1 小游戏创建虚拟支付订单
Path：/requestMidasPaymentGameItem
Method： POST
接口描述：
小游戏创建虚拟支付预订单
请求参数
Header 参数：
参数名称
必选
类型
说明描述
示例值
TC-Payment-Callback
是
string
支付成功或失败回调地址
https://example.com/callback
TC-UserID
是
string
superapp 登录用户 ID
test_user_id_001
TC-MerchantID
是
string
超级应用平台中小程序绑定 superapp 的商户 ID
mi59a93ddccc
TC-Platform-UserID
是
string
超级应用平台用户 openid
o6bd1c45d56c17841qEDgWR88700
Body 参数：
参数名称
必选
类型
描述
示例值
signData
是
string
具体支付参数见下面的 signData，需要将数据以 JSON 格式传递
{"mode":"goods","buyQuantity":1,"currencyType":"USD","productId":"p100054665","outTradeNo":"2095e112-319a-4dda-b319-1c3ea09333a8","goodsPrice":"4.00","attach":"1234..."}
paySig
是
string
虚拟支付签名,签名参考 paySig 签名,uri 取值固定为 requestMidasPaymentGameItem
6fcdc6fe88d064b22fcf4c73f34f8076436d8343e4724769032df3363be11ac7
appId
是
string
超级应用平台应用 ID
app-abo181jy4f
miniAppId
是
string
超级应用平台小游戏 appid
mgqvdu8w5asxh9wg
goodsName
是
string
游戏道具名称
Doraemon
orderSource
是
int
订单来源，固定值1
1
event
是
string
固定值： minigame_game_pay_goods_deliver_notify
minigame_game_pay_goods_deliver_notify
signData：
参数名称
必选
类型
描述
示例值
model
是
string
固定值 goods
goods
offerId
是
string
超级应用平台中小程序绑定 superapp 的商户 ID
mi59a93ddccc
buyQuantity
是
int
购买数量
1
currencyType
是
string
货币类型，符合 ISO 4217 标准的三位字母代码。
USD
productId
是
string
道具 ID
psdsuyhds87787sds
goodsPrice
是
string
道具单价，最多支持 12 位整数，最多 2 位小数。仅允许数字，最多包含 1 个小数点，不支持千分位分隔符、货币符号、负数。合法示例："0.5"、"10.5"、"100.55"、"1000"、"10000.00"。
4.00
outTradeNo
是
string
商户系统内部订单号，要求6-64个字符内，只能是数字、大小写字母_-|* 且在同一个商户号下唯一。
2095e112-319a-4dda-b319-1c3ea09333a8
attach
否
string
支付回调时会透传返回
{"appid":"mp_test_001"}
响应参数
参数名称
类型
必选
描述
示例值
returnCode
string
是
响应 code,0表示成功
0
returnMessage
string
否
响应信息
OK
data
object
是
响应数据
-
data.prepayId
string
是
superapp 订单号
pim17873098978027ioaenena3h8pf1nmus2
requestId
string
是
请求链路 ID
fd203616014e4ca8935f08a913ecfcb4
请求示例
{"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
是
string
超级应用平台应用 ID
app-abo181jy4f
TC-BackendConfigID
是
string
超级应用平台接入 Superapp 后端配置 ID,用于区分环境,创建订单时请求 Header 中的 TC-BackendConfigID
appserver-1
TC-Signature
是
string
调用超级应用服务平台服务验签的签名，签名参考超级应用平台签名验签﻿
dc8bac73413d8c69c1bc5be856ee9cf1
TC-Timestamp
是
string
时间戳（秒）
1787320102
Body 参数：
参数名称
必选
类型
描述
示例值
eventType
是
string
消息类型，支付成功-TRANSACTION.SUCCESS。 支付失败-TRANSACTION.PAYERROR。
TRANSACTION.SUCCESS
event
是
string
创建订单时的 event
minigame_game_pay_goods_deliver_notify
payModel
否
string
支付方式 Wallet、Bankcard、third party
Wallet
payload
是
string
携带的具体内容，格式为 JSON，具体内容如下表格 payload（因为这里需要对消息内容统一签名，所以统一把消息内容设计成 JSON 格式）
{"OpenId":"o8197e6f8ac817871vxypNK57520","OutTradeNo":"2095e112-319a-4dda-b319-1c3ea09333a8","GoodsInfo":{"ProductId":"p100054665","Quantity":1,"OrigPrice":"4.00","ActualPrice":"4.00","attach":"1234...","OrderSource":1},"PayInfo":{"MchOrderNo":"miea24116372bf17c1e4f9f3b80d6690","TransactionId":"tx202608211858236904429mabkfue6y","PaidTime":0}}
payEventSig
是
string
签名参考payEventSig 签名，event 取值为 minigame_game_pay_goods_deliver_notify
minigame_game_pay_goods_deliver_notify
transactionId
否
string
Superapp 平台支付交易流水号
tx202608211858236904429mabkfue6y
outTradeNo
是
string
商户订单号
2095e112-319a-4dda-b319-1c3ea09333a8
payload：
参数名称
必选
类型
描述
示例值
OpenId
是
string
超级应用平台用户 openid
o8197e6f8ac817871vxypNK57520
OutTradeNo
是
string
商户订单号
2095e112-319a-4dda-b319-1c3ea09333a8
GoodsInfo
是
object
发货道具
-
PayInfo
是
object
支付信息
-
GoodsInfo：
参数名称
必选
类型
描述
示例值
ProductId
是
string
游戏道具 id 标识
p100054665
Quantity
是
int
购买道具数量
1
OrigPrice
是
string
物品原始价格
4.00
ActualPrice
是
string
物品实际支付价格
4.00
Attach
是
string
透传数据
{"appid":"mp_test_001"}
OrderSource
是
int
订单来源
1
PayInfo：
参数名称
类型
必选
说明
示例值
MchOrderNo
string
是
商户下单时传入的商户号
mi59a93ddccc
PaidTime
int
否
支付时间戳，单位秒
1787355501
TransactionId
string
否
Superapp 平台支付交易流水号
tx20260822073818768117gzxdrh38bs
响应参数
参数名称
必选
类型
描述
示例值
returnCode
是
string
响应 code,0表示成功
0
returnMessage
否
string
响应信息
OK
data
是
string
响应数据，成功时为 OK
OK
requestId
是
string
请求链路 ID
fd203616014e4ca8935f08a913ecfcb4
请求示例
{"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
接口描述：
小程序创建虚拟支付预订单
请求参数
Header 参数：
参数名称
必选
类型
描述
示例值
TC-Payment-Callback
是
string
支付成功或者失败回调地址
https://example.com/callback
TC-UserID
是
string
superapp 登录用户 ID
o6bd1c45d56c17841qEDgWR88700
TC-MerchantID
是
string
超级应用平台中小程序绑定 superapp 的商户 ID
mi59a93ddccc
TC-Platform-UserID
是
string
超级应用平台用户 openid
test_user_id_001
Body 参数：
参数名称
必选
类型
描述
示例值
signData
是
string
支付原串，具体支付参数见下面的 signData，需要将数据以 JSON 格式传递
{"mode":"goods","offerId":"mi59a93ddccc","buyQuantity":1,"currencyType":"USD","productId":"p1012930293","goodsPrice":"2500.00","outTradeNo":"9e9652f5-322c-403e-9074-1b28d1421ac7","attach":""}
paySig
是
string
虚拟支付签名,签名参考 paySig 签名,uri 取值固定为 requestVirtualPayment
c698ee16f162ccc6fa88154808607f6fd6c597e958cabef6ec36c861ee8c1dff
appId
是
string
超级应用平台应用 ID
app-abo181jy4f
miniAppId
是
string
超级应用平台小程序 appid
mprz285jdlprq69o
goodsName
是
string
游戏道具名称
Doraemon
orderSource
是
int
订单来源，固定值10，小程序短剧内下单
10
event
是
string
orderSource=10 固定为：xpay_goods_deliver_notify
xpay_goods_deliver_notify
signData：
参数名称
必选
类型
说明
示例值
model
是
string
固定值 goods
goods
offerId
是
string
超级应用平台中小程序绑定 superapp 的商户 ID
mi59a93ddccc
buyQuantity
是
int
购买数量
1
currencyType
是
string
货币类型，符合 ISO 4217 标准的三位字母代码。
USD
productId
是
string
道具 ID
p1012930293
goodsPrice
是
string
道具单价，最多支持 12 位整数，最多 2 位小数。仅允许数字，最多包含 1 个小数点，不支持千分位分隔符、货币符号、负数。合法示例："0.5"、"10.5"、"100.55"、"1000"、"10000.00"。
2500.00
outTradeNo
是
string
商户系统内部订单号，要求6-64个字符以内，只能是数字、大小写字母_-|* 且在同一个商户号下唯一。
9e9652f5-322c-403e-9074-1b28d1421ac7
attach
否
string
支付回调时会透传返回
{"appid":"mp_test_001"}
响应参数
参数名称
类型
必选
描述
示例值
returnCode
string
是
响应 code,0表示成功
0
returnMessage
string
否
响应信息
OK
data
object
是
响应数据
-
data.prepayId
string
是
superapp 订单号
pip1787320103622n1mjc6qgytpith9yg9pb
requestId
string
是
请求链路 ID
fd203616014e4ca8935f08a913ecfcb4
请求示例
{"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
接口描述：
小程序虚拟支付回调
请求参数
Header 参数:
参数名称
必选
类型
描述
示例值
TC-ApplicationID
是
string
超级应用平台应用 ID
app-abo181jy4f
TC-BackendConfigID
是
string
超级应用平台接入 Superapp 后端配置 ID,用于区分环境,创建订单时请求 Header 中的 TC-BackendConfigID
appserver-1
TC-Signature
是
string
调用超级应用服务平台服务验签的签名，签名参考超级应用平台签名验签﻿
dc8bac73413d8c69c1bc5be856ee9cf1
TC-Timestamp
是
string
时间戳（秒）
1787320102
Body 参数：
参数名称
必选
类型
描述
示例值
eventType
是
string
消息类型，支付成功-TRANSACTION.SUCCESS。 支付失败-TRANSACTION.PAYERROR。
TRANSACTION.SUCCESS
event
是
string
事件类型，创建订单时的 event
xpay_goods_deliver_notify
payMode
否
string
支付方式 Wallet、Bankcard、third party
Wallet
payload
是
string
携带的具体内容，格式为 JSON，具体内容如下表格 Payload（因为这里需要对消息内容统一签名，所以统一把消息内容设计成 JSON 格式）
{"OpenId":"o79a2ea7091c17872ReYfcR16301","OutTradeNo":"b2f1935d-9740-4dc0-80da-49dccfabe69d","GoodsInfo":{"ProductId":"p1012930293","Quantity":10,"OrigPrice":"2000.00","ActualPrice":"2000.00","Attach":"","OrderSource":10},"PayInfo":{"MchOrderNo":"pim1787308704013qtemk6ko0a8bpwzqvgmo","TransactionId":"tx20260821183830589477ux2dkk8p22","PaidTime":1787308710}}","payEventSig":"9404cf6615826e5ee8ffdbd4c63a388d9b323a3b288870b533f576856ba82c36","outTradeNo":"b2f1935d-9740-4dc0-80da-49dccfabe69d"}
payEventSig
是
string
签名参考
xpay_goods_deliver_notify
transactionId
否
string
Superapp 平台支付交易流水号
tx20260821183830589477ux2dkk8p22
outTradeNo
是
string
商户订单号
b2f1935d-9740-4dc0-80da-49dccfabe69d
payload：
参数名称
必选
类型
描述
示例值
OpenId
是
string
超级应用平台用户 ID，下单时 header 中的 TC-Platform-UserID
o6bd1c45d56c17841qEDgWR88700
OutTradeNo
是
string
订单号
b2f1935d-9740-4dc0-80da-49dccfabe69d
GoodsInfo
是
object
发货道具
-
PayInfo
是
object
支付信息
-
GoodsInfo：
参数名称
必选
类型
描述
示例值
ProductId
是
string
游戏道具 id 标识
p1012930293
Quantity
是
int
购买道具数量
1
OrigPrice
是
string
物品原始价格
2000.00
ActualPrice
是
string
物品实际支付价格
2000.00
Attach
是
string
透传数据
{"appid":"mp_test_001"}
OrderSource
是
int
1 游戏内
10
PayInfo：
参数名称
必选
类型
描述
示例值
MchOrderNo
是
string
商户下单时传入的商户号
b2f1935d-9740-4dc0-80da-49dccfabe69d
PaidTime
否
number
支付时间戳，单位秒
1787308710
TransactionId
否
string
Superapp 平台支付交易流水号
tx20260821183830589477ux2dkk8p22
响应参数
参数名称
类型
必选
描述
示例值
returnCode
string
是
响应 code,0表示成功
0
returnMessage
string
否
响应信息
OK
data
string
是
响应数据，成功时为 ok
ok
requestId
string
是
请求链路 ID
fd203616014e4ca8935f08a913ecfcb4
请求示例
{"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
接口描述： 对已完成支付的标准支付订单发起退款申请。
请求参数 
Header 参数：
参数名称
必选
类型
描述
示例值
TC-Payment-Callback
是
string
退款结果回调地址
https://example.com/callback
TC-Authorization
是
string
签名认证信息，签名参考标准支付签名﻿
WECHATPAY2-SHA256-RSA2048 mchid="mi59a93ddccc",nonce_str="327fd493426a3511ee5b058da5b55581",signature="cwlDykNGE4NE9xiSV7OyrHAFPWQQgiMQ0f6W0yZU6OzXXd47W+YydGIAR67mmeDRWKuW5c32qBuEIgs30Nofp8+l1Gyn48RDWBX4HI7UMZ34i8tehpamcrkrscxV2PvF2j1aEXw91SYCGyUrhnnTdFad53RVI+LXlrxGVUKjss7XGb484//CDCVh4LjaGYtlqFt2+owR5ZBxdWWfBorCEkgMDRHlRXBwgLA35qzdmPzx+6BcHADuTtrp83v2rI0i8yOuWR/k15N4gEF8PqMF2FcwN/U9JViDA9NtsiXoddtOirBChTtlFaakwIjguQYCuiUj/aJHgkeR/XPQKZjMWg==",timestamp="1787317409",serial_no="7510596630"
Body 参数：
参数名称
必选
类型
描述
示例值
transaction_id
否
string
Superapp 平台支付交易流水号，与 out_trade_no 二选一
tx20260821203742618148dhiip3n4oj
out_trade_no
否
string
商户订单号，与 transaction_id 二选一
f49b3e588f1fec899b68
out_refund_no
是
string
商户退款单号，同一商户下唯一
test_order_001-REF001
reason
否
string
退款原因
﻿
refund_method
否
string
退款方式：ORIGINAL-原路退回 / BANKCARD-银行卡 / WALLET-钱包
ORIGINAL
channel
否
string
退款渠道：ORIGINAL-原路退款 / BALANCE-退回到余额
ORIGINAL
refund_source
否
string
退款来源： 1.人工客服 2.用户自己发起 3.其它
1
amount
是
object
退款金额信息
-
amount.refund
是
string
退款金额
1600.00
amount.total
是
string
订单总金额，最多支持 12 位整数，最多 2 位小数。仅允许数字，最多包含 1 个小数点，不支持千分位分隔符、货币符号、负数。合法示例："0.5"、"10.5"、"100.55"、"1000"、"10000.00"
1600.00
amount.currency
是
string
币种，例如 USD
USD
goods_detail
否
array
退款商品明细
-
goods_detail[].merchant_goods_id
是
string
商户侧商品编码
yn48RDWBX4HI7UMZ
goods_detail[].goods_name
否
string
商品名称
Goods
goods_detail[].unit_price
是
string
商品单价，最多支持 12 位整数，最多 2 位小数。仅允许数字，最多包含 1 个小数点，不支持千分位分隔符、货币符号、负数。合法示例："0.5"、"10.5"、"100.55"、"1000"、"10000.00"。
1600.00
goods_detail[].refund_amount
是
string
商品退款金额，最多支持 12 位整数，最多 2 位小数。仅允许数字，最多包含 1 个小数点，不支持千分位分隔符、货币符号、负数。合法示例："0.5"、"10.5"、"100.55"、"1000"、"10000.00"。
1600.00
goods_detail[].refund_quantity
是
int
退款数量
1
notify_url
是
string
退款结果通知 URL
https://example-test.com/callback/pay/mp_test_001
merchant_id
是
string
商户号
mi59a93ddccc
响应参数：
参数名称
必选
类型
描述
示例值
returnCode
是
string
响应 code，0 表示成功
0
returnMessage
否
string
响应信息
OK
data
是
object
退款响应数据
-
data.refund_id
是
string
平台退款单号
rn1787317410603a5t42r5re5nf0mj7xg29
data.out_refund_no
是
string
商户退款单号
REF-20260821-130329-fcd729-0-173397
data.transaction_id
是
string
Superapp 平台支付交易流水号
tx20260821203742618148dhiip3n4oj
data.out_trade_no
是
string
商户订单号
MP17873158523768884953d
data.channel
是
string
退款渠道
ORIGINAL
data.user_received_account
否
string
退款入账账户
-
data.success_time
否
string
退款成功时间
-
data.create_time
是
string
退款创建时间
2026-08-21T21:03:30+08:00"
data.status
是
string
退款状态：PROCESSING-处理中 / SUCCESS-退款成功 / CLOSED-退款关闭 / ABNORMAL-退款异常
PROCESSING
data.amount
是
object
退款金额信息
-
data.amount.total
是
string
订单总金额
1600.00
data.amount.refund
是
string
退款金额
1600.00
data.amount.payer_total
是
string
用户支付金额
1600.00
data.amount.payer_refund
是
string
用户退款金额
1600.00
data.amount.currency
是
string
币种
USD
data.amount.refund_fee
否
string
退款手续费
0.00
requestId
是
string
请求链路 ID
fd203616014e4ca8935f08a913ecfcb4
请求示例
{"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
接口描述： 通过商户退款单号查询退款详情。
请求参数
Header 参数：
参数名称
必选
类型
描述
示例值
TC-Authorization
是
string
签名认证信息，签名参考标准支付签名﻿
WECHATPAY2-SHA256-RSA2048 mchid="mi59a93ddccc",nonce_str="c7fceaba38",signature="eG/9G6H3uFtxtnpNE+al3yHNkPZl3comAJJNJxbfvm3L3m3ESWxXgB2qO+2P1fhxjwodzd5KGNVjS0fPudT1nw0hjSofrfwfy72TkUEj+a1jfjzb95DN62ObSPt7dqPRGj0pvUF5it+pvk30zrgNxuuveAb6nzJaD1tKN+oU9f3Zw2kjj4guVYCEqAX3byGG38f0/9I873zIs55XIDhfyucUiyhGgZD9t9WxKB+do95J7P4nmS+xm3WGNFOoZ6lxj+6OPOcyCmbcTZihEFrSNKOQBcyTJh3BbWGfcBaBxk+Gbf48Cabi32Pgpxn6hHmtNyaPhRyWjgLqB+eo05o3/g==",timestamp="1787317412",serial_no="7510596630"
Path 参数：
参数名称
必选
类型
描述
示例值
out_refund_no
是
string
商户退款单号
test_order_001-REF001
响应参数
参数名称
必选
类型
描述
示例值
returnCode
是
string
响应 code，0 表示成功
0
returnMessage
否
string
响应信息
OK
data
否
object
退款详情数据
-
data.refund_id
是
string
平台退款单号
rn1787317410603a5t42r5re5nf0mj7xg29
data.out_refund_no
是
string
商户退款单号
REF-20260821-130329-fcd729-0-173397
data.transaction_id
是
string
Superapp 平台支付交易流水号
tx20260821203742618148dhiip3n4oj
data.out_trade_no
是
string
商户订单号
MP17873158523768884953d
data.channel
是
string
退款渠道
ORIGINAL
data.user_received_account
否
string
退款入账账户
-
data.success_time
否
string
退款成功时间
2026-08-21T21:03:35+08:00
data.create_time
是
string
退款创建时间
2026-08-21T21:03:30+08:00
data.status
是
string
退款状态：PROCESSING-处理中 / SUCCESS-退款成功 / CLOSED-退款关闭 / ABNORMAL-退款异常
SUCCESS
data.amount
是
object
退款金额信息
-
data.amount.total
是
string
订单总金额
1600.00
data.amount.refund
是
string
退款金额
1600.00
data.amount.payer_total
是
string
用户支付金额
1600.00
data.amount.payer_refund
否
string
用户退款金额
1600.00
data.amount.currency
是
string
币种
USD
data.amount.refund_fee
否
string
退款手续费
0.00
requestId
是
string
请求链路 ID
fd203616014e4ca8935f08a913ecfcb4
请求示例
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
请求参数
Header 参数：
参数名称
必选
类型
描述
示例值
TC-Callback-Serial
是
string
superapp 平台证书序列号
B9B3EFE9E10EC481569ACAC46C5B8B52EEA2F2CE
TC-Callback-Signature
是
string
商户验证平台签名值
SVj3Gm2AdEu2/3E0jRaHa+7G4HdvtyyuHTlv9F4jx+N+tmBdLUJCRIQQ34spT8fp3DU1oY2fUkOiYH8z4nO/vtZrhTslhNfBuaRVVxLKjFuMKNTOYDZ8IDRgJDkryxYY/7DljMuKpzR125N4+1qn+gr+Ia0maGNwlIdyg19A16qaA0jHTliKfD+prtjGYxHm/5gPIeMEskTa6TJdyfwFPTsfeXc8n6l7v5AtEJ2zqOAWXnfKK9dIwi8z4JSmdiWDgU5O5AbKxH0ycUEecyUtjipK2cDKH/2zvLlBchyrDzUyFoq5OJq9hz1U3jBL1Tc+D7lv+vK05uhYwgaU8Fyf9g==
TC-Timestamp
是
string
时间戳（秒）
1787309129
TC-Callback-Nonce
是
string
验签的随机字符串
PAWO6qFR7ILP
TC-Signature
是
string
调用超级应用服务平台服务验签的签名，签名参考超级应用平台签名验签﻿
4f7b89a2b94208e7f6903b497960eb7c
TC-ApplicationID
是
string
超级应用服务平台服务的应用 ID
app-abo181jy4f
TC-BackendConfigID
是
string
超级应用平台接入 Superapp 后端配置 ID,用于区分环境,创建订单时请求 Header 中的 TC-BackendConfigID
appserver-1
Body 参数：
参数名称
必选
类型
描述
示例值
id
是
string
通知唯一编号
youx36thyawcwqh5
create_time
是
string
通知创建时间，RFC3339 格式
2026-08-21T18:45:29+08:00
event_type
是
string
REFUND.SUCCESS / REFUND.CLOSED / REFUND.ABNORMAL
REFUND.SUCCESS
resource_type
是
string
固定为 encrypt-resource
encrypt-resource
summary
是
string
通知摘要
Pay success
out_refund_no
是
string
商户退款单号
test_order_001-REF001
resource
是
object
加密通知数据
-
resource.algorithm
是
string
固定为 AEAD_AES_256_GCM
AEAD_AES_256_GCM
resource.original_type
是
string
固定为 refund
refund
resource.ciphertext
是
string
Base64 编码的加密数据，使用 APIV3秘钥解密
bg+uF4Or3anFuYGGzZgab3AuGX5KXqO+O+SGPJpycz+V4mWPYYwhPsJ75wzxfFHQ0fOAnbKHEmV42JDFP4TZXjxmervyRH/8CZRiPAyoTdbVPGOQ3cUqfSzQwubkomhRHRti1IzjiLBoGffMMXk4qiTNXcLvhqXtbAH92vdKRW4phvNvJo/z7ABlGEd37wr7EP5eFx89pqzv0+AUx7eBMJW95NJ3DJoQ7FGeVp0AyZa8PvzJbhvr9cZBCyoZZTmesWduiry5QF6T4OzDQmlWQotMlXY7kceEqsaB9CIJE+Xbx9nuckrf+8bOA3KWSQ1hM7D6VXLKTMi0bf27mFEN0uTPh6/iq5AWMfIaS4VY8lc+V08nDXlBxkoCgpeAp9GY8muob2Cwel2Cmf/TWnlkGVmazozK3ey6/DmlqTqNA+47LxT9yB6QDGqzmXBQ3ii6IXtLg5L5CgLIJl1gOt5UIfPseXgC7s0pErbxXmq8lkbS6sOZiVcxAhPKZjY8V0TQrtYLNAMWWZt/AYbohHWCPuB/z16sA2TIg17HHglRR1tc6z0YkZaZ5DWv7X/GcZtyZ8ZZ3lTvK8TlVW7g1K3GMWZuGM0=
resource.associated_data
否
string
参与解密的附加数据
-
resource.nonce
是
string
参与解密的随机串
PAWO6qFR7ILP
resource.ciphertext 解密后数据结构：
参数名称
必选
类型
描述
示例值
mch_id
是
string
商户号
mi59a93ddccc
transaction_id
是
string
Superapp 平台支付交易流水号
tx_test_001
out_trade_no
是
string
商户订单号
f49b3e588f1fec899b68
refund_id
是
string
平台退款单号
rn_test_refund_001
out_refund_no
是
string
商户退款单号
test_order_001-REF001
refund_status
是
string
退款状态：SUCCESS / CLOSED / ABNORMAL
SUCCESS
success_time
否
string
退款成功时间（仅 SUCCESS 时返回）
2026-07-16T17:44:53+08:00
user_received_account
否
string
退款入账账户
-
amount
是
object
退款金额信息
-
amount.total
是
string
订单总金额
1600.00
amount.refund
是
string
退款金额
1600.00
amount.payer_total
是
string
用户支付金额
1600.00
amount.payer_refund
是
string
用户退款金额
1600.00
amount.currency
是
string
币种
USD
响应参数
参数名称
类型
必选
说明
示例值
returnCode
string
是
响应 code，0 表示成功
0
returnMessage
string
否
响应信息
OK
data
string
是
响应数据，成功时为 ok
ok
requestId
string
是
请求链路 ID
fd203616014e4ca8935f08a913ecfcb4
请求示例
{"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
接口描述： 对已完成支付的小程序/小游戏虚拟支付订单发起退款申请。
请求参数
Header 参数：
参数名称
必选
类型
描述
示例值
TC-Payment-Callback
是
string
退款完成后退款结果回调地址
https://example.com/callback
TC-MerchantID
是
string
超级应用平台中小程序绑定 superapp 的商户 ID
mi59a93ddccc
Query 参数：
参数名称
必选
类型
描述
示例值
pay_sig
是
string
虚拟支付签名,签名参考 paySig 签名，uri=/vpay/refund/refunds
60f0254ff7fe96a20c27aa385412badc967c7dfdf2b7f062752763bab36d
Body 参数：
参数名称
必选
类型
描述
示例值
openid
否
string
下单用户 openid
o6bd1c45d56c17841qEDgWR88700
transaction_id
否
string
Superapp 平台支付交易流水号，与 out_trade_no 二选一
tx_test_001
out_trade_no
否
string
商户订单号，与 transaction_id 二选一
f49b3e588f1fec899b68
out_refund_no
是
string
商户退款单号
test_order_001-REF001
reason
否
string
退款原因
﻿
req_from
否
string
退款来源： 1.人工客服 2.用户自己发起 3.其它
2
amount
是
object
退款金额信息
-
amount.refund
是
string
退款金额，最多支持 12 位整数，最多 2 位小数。仅允许数字，最多包含 1 个小数点，不支持千分位分隔符、货币符号、负数。合法示例："0.5"、"10.5"、"100.55"、"1000"、"10000.00"。
1600.00
amount.total
是
string
订单总金额，最多支持 12 位整数，最多 2 位小数。仅允许数字，最多包含 1 个小数点，不支持千分位分隔符、货币符号、负数。合法示例："0.5"、"10.5"、"100.55"、"1000"、"10000.00"。
1600.00
amount.currency
是
string
币种
USD
merchant_id
是
string
商户号
mi_test_merchant_001
响应参数
参数名称
必选
类型
描述
示例值
returnCode
是
string
响应 code，0 表示成功
0
returnMessage
否
string
响应信息
OK
data
是
object
退款响应数据
-
data.refund_id
是
string
平台退款单号
rn17873102825245ly856vr5s7jq5uj9kco
data.out_refund_no
是
string
商户退款单号
2095e112-319a-4dda-b319-1c3ea09333a8-REF2269
data.transaction_id
是
string
Superapp 平台支付交易流水号
tx202608211858236904429mabkfue6y
data.out_trade_no
是
string
商户订单号
2095e112
data.channel
否
string
退款渠道
ORIGINAL
data.user_received_account
否
string
退款入账账户
-
data.success_time
否
string
退款成功时间
2026-08-21T19:04:45+08:00
data.create_time
是
string
退款创建时间
2026-08-21T19:04:42+08:00
data.status
是
string
退款状态：PROCESSING-处理中 / SUCCESS-退款成功 / CLOSED-退款关闭 / ABNORMAL-退款异常
SUCCESS
data.amount
是
object
退款金额信息
-
data.amount.total
是
string
订单总金额
1600.00
data.amount.refund
是
string
退款金额
1600.00
data.amount.payer_total
是
string
用户支付金额
1600.00
data.amount.payer_refund
是
string
用户退款金额
1600.00
data.amount.currency
是
string
币种
USD
data.amount.refund_fee
否
string
退款手续费
0.00
requestId
是
string
请求链路 ID
fd203616014e4ca8935f08a913ecfcb4
请求示例
{"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.00","refund":"250.00","payer_total":"250.00","payer_refund":"250.00","currency":"USD","refund_fee":"0.00"}}}
5.2.2 虚拟支付退款回调
Path： 申请退款时接口5.2.1 请求 Header TC-Payment-Callback 的值
Method： POST
请求参数
Header 参数：
参数名称
必选
类型
描述
示例值
TC-Timestamp
是
string
时间戳（秒）
1787320108
TC-Signature
是
string
调用超级应用服务平台服务验签的签名，签名参考超级应用平台签名验签﻿
9c2c715eaad1505e05598dd48a1a2776
TC-ApplicationID
是
string
超级应用服务平台服务的应用 ID
app-abo181jy4f
TC-BackendConfigID
是
string
超级应用平台接入 Superapp 后端配置 ID,用于区分环境,创建订单时请求 Header 中的 TC-BackendConfigID
appserver-1
Body 参数：
参数名称
必选
类型
描述
示例值
eventType
是
string
REFUND.{{退款状态}}  退款状态 SUCCESS / CLOSED / ABNORMAL
REFUND.SUCCESS
event
是
string
事件标识，同 eventType
REFUND.SUCCESS
payload
是
string
JSON 字符串，解析后为退款通知数据
{"mch_id":"miea24116372bf17c1e4f9f3b80d6690","transaction_id":"tx20260821183929769285y7pgsczocb","out_trade_no":"870f6efe-ee6e-4502-9539-ec567a27e6be","refund_id":"rn1787309110345vmyihmgkjzdzackvqblf","out_refund_no":"870f6efe-ee6e-4502-9539-ec567a27e6be-REF2266","refund_status":"SUCCESS","success_time":"2026-08-21T18:45:25+08:00","user_received_account":"","amount":{"total":"2000.00","refund":"400.00","payer_total":"2000.00","payer_refund":"400.00","currency":"USD"}}
payEventSig
是
string
支付签名，签名算法伪代码为： pay_event_sig = to_hex(hmac_sha256(app_key, event + '&' + payload))
a88ea01994a13232a9de27262cc6825eb7240f97051c01852d8468ba01539c0b
outRefundNo
是
string
商户退款单号
870f6efe-ee6e-4502-9539-ec567a27e6be-REF226
payload 解析后数据结构：
参数名称
必选
类型
描述
示例值
mch_id
是
string
商户号
mi59a93ddccc
transaction_id
是
string
Superapp 平台支付交易流水号
tx_test_001
out_trade_no
是
string
商户订单号
f49b3e588f1fec899b68
refund_id
是
string
平台退款单号
rn_test_refund_001
out_refund_no
是
string
商户退款单号
test_order_001-REF001
refund_status
是
string
退款状态：SUCCESS / CLOSED / ABNORMAL
SUCCESS
success_time
否
string
退款成功时间
2026-07-16T17:44:53+08:00
user_received_account
否
string
退款入账账户
-
amount
是
object
退款金额信息
-
amount.total
是
string
退款金额
1600.00
amount.currency
是
string
币种
USD
响应参数
参数名称
必选
类型
描述
示例值
returnCode
是
string
响应 code，0 表示成功
0
returnMessage
是
string
响应信息
OK
data
是
string
响应数据，成功时为 ok
ok
requestId
是
string
请求链路 ID
fd203616014e4ca8935f08a913ecfcb4
5.2.3 查询虚拟支付退款
Path： /vpay/refund/refunds/query
Method： POST
接口描述：
查询虚拟支付退款状态。
请求参数
Query 参数：
参数名称
必选
类型
描述
示例值
pay_sig
是
string
虚拟支付签名,签名参考 paySig 签名，uri=/vpay/refund/refunds/query
60f0254ff7fe96a20c27aa385412badc967c7dfdf2b7f062752763bab36d
Body 参数：
参数名称
必选
类型
描述
示例值
out_refund_no
是
string
商户退款单号
test_order_001-REF001
响应参数
参数名称
必选
类型
描述
示例值
returnCode
是
string
响应 code，0 表示成功
0
returnMessage
否
string
响应信息
OK
data
是
object
退款详情数据
-
data.refund_id
是
string
平台退款单号
rn1787302243015e3quk4ra5hrn8n3n9y5l
data.out_refund_no
是
string
商户退款单号
REF-20260821-085040-4f76d4-0-626393
data.transaction_id
是
string
Superapp 平台支付交易流水号
tx20260819155006145828vlxcyjo81t
data.out_trade_no
是
string
原商户订单号
MP1787125797858c797c4d1
data.channel
是
string
退款渠道
ORIGINAL
data.user_received_account
否
string
退款入账账户
-
data.success_time
否
string
退款成功时间
2026-08-21T16:50:45+08:00
data.create_time
是
string
退款创建时间
2026-08-21T16:50:43+08:00
data.status
是
string
退款状态：PROCESSING / SUCCESS / CLOSED / ABNORMAL
SUCCESS
data.amount
是
object
退款金额信息
-
data.amount.total
是
string
订单总金额
1600.00
data.amount.refund
是
string
退款金额
1600.00
data.amount.payer_total
是
string
用户支付金额
1600.00
data.amount.payer_refund
是
string
用户退款金额
1600.00
data.amount.currency
是
string
币种
USD
data.amount.refund_fee
否
string
退款手续费
0.00
requestId
是
string
请求链路 ID
fd203616014e4ca8935f08a913ecfcb4
请求示例
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}}}
﻿
﻿
﻿
帮助和支持

本页内容是否解决了您的问题？
您也可以联系销售或提交工单以寻求帮助。
填写满意度调查问卷，共创更好文档体验。
文档反馈
参数名称	必选	类型	描述	示例值
TC-ApplicationID	是	string	超级应用平台应用 ID	app-abo181jy4f
TC-BackendConfigID	是	string	超级应用平台接入 Superapp 后端配置 ID,用于区分环境	appserver-1
TC-PackageName	是	string	超级应用平台应用包名	com.tencent.demo
TC-Signature	是	string	超级应用平台请求签名，基于 TC-Timestamp 计算生成签名，签名参考超级应用平台签名验签	8ce14c68e234e1581fee873c478897c7
TC-Timestamp	是	string	时间戳（毫秒）	1787375938382
TC-TraceID	是	string	链路追踪 ID	eae6bf0943eb463d9120ac0d54366e4b]
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 小程序创建虚拟支付订单

请求参数

响应参数
