# 订单
# 接口说明
查询订单状态
# 接口地址
POST https://cloud-miniapp.tapapis.cn/order/v1/detail?access_token=ACCESS_TOKEN&sig_method=hmac_sha256&pay_sig=PAY_SIGNATURE
# 请求参数
# Query 参数
| 属性 | 类型 | 必填 | 说明 |
|---|---|---|---|
| access_token | string | 是 | 接口调用凭证。 access_token 见 auth.getStableAccessToken |
| sig_method | string | 是 | 用户登录态签名的哈希方法,只支持 hmac_sha256,请传入 "hmac_sha256" |
| pay_sig | string | 是 | 支付请求签名 |
- 支付请求签名的生成方式为:pay_sig = hmac_sha256(paymentKey, rawData)
- rawData 为 URL 的 Path 和请求接口时携带的 Body 参数,用 & 连接。rawData 示例:
/order/v1/detail&{ "openid": "openid", "ts": 1765957030, "env": 0, "out_trade_no": "test_out_trade_no", "offer_id":"offer_id", "biz_id":2 } - paymentKey 在开发者后台「商店」-「游戏包体管理」-「小游戏管理」-「开放能力」-「小游戏内购」-「基础配置」,沙箱支付 key或者线上支付 key
- rawData 为 URL 的 Path 和请求接口时携带的 Body 参数,用 & 连接。rawData 示例:
# Body 参数
| 属性 | 类型 | 必填 | 说明 |
|---|---|---|---|
| openid | string | 是 | 接收商品的玩家 openid |
| offer_id | string | 是 | 小游戏 Client ID |
| ts | int | 是 | 秒级时间戳(Unix Timestamp) |
| env | int | 是 | 环境配置: - 0: 正式环境 - 1: 沙箱环境 |
| out_trade_no | string | 是 | 业务订单号,需保证唯一性 |
| biz_id | int | 是 | 业务类型:2:直购 |
# 返回参数
# 返回对象
返回的 JSON 数据包:
| 属性 | 类型 | 说明 |
|---|---|---|
| errcode | int | 错误码,见下表 |
| errmsg | string | 错误信息 |
| product_id | string | 道具 ID |
| pay_state | int | 支付状态: - 1:未支付- 2:已支付 |
| deliver_state | int | 发货状态: - 1:未发货- 2:已发货 |
| pay_finish_time | int | 支付完成时间 |
| out_trade_no | string | 业务订单号,需保证唯一性 |
# 错误码说明
| 值 | 说明 |
|---|---|
| 0 | 请求成功 |
| -1 | 通用错误,具体见 errmsg 描述 |
| 1090011 | pay_sig 支付签名错误 |
| 1040001 | 无效或过期的 access_token,需要重走登录流程 |
| 1090019 | out_trade_no 订单未找到 |
# 请求示例
# cURL 请求
curl -d '{
"openid": "openid",
"ts": 1765957030,
"env": 0,
"out_trade_no": "test_out_trade_no",
"offer_id":"offer_id",
"biz_id":2
}' \
-H "Content-Type: application/json" \
-X POST \
'https://cloud-miniapp.tapapis.cn/order/v1/detail?access_token=ACCESS_TOKEN&sig_method=hmac_sha256&pay_sig=PAY_SIGNATURE'
# 返回示例
# 成功返回
{
"errcode": 0,
"errmsg": "ok",
"out_trade_no": "test_out_trade_no",
"pay_finish_time": 1765957000,
"product_id": "product_id",
"deliver_state": 1,
"pay_state": 1
}
# 错误返回
{
"errcode": -1,
"errmsg": "无效的 openid"
}
