Web PG 支付

网页PG支付API是一个在您想要在网站上实现PG支付时使用的API，尽管在开发Windows应用程序时不使用Hive SDK计费。网页PG支付API与在应用程序中实现PG支付的API不同。

Note

要在应用中实现PG支付，您需要使用Hive SDK Billing和通用PG支付API。

产品列表查询¶

检索产品信息。用于在应用中实现产品列表。

请求 URL¶

环境	网址
生产网址	https://store.withhive.com/external/api/product
沙盒网址	https://sandbox-store.withhive.com/external/api/product
HTTP 方法	POST
内容类型	text/html; charset=utf-8
数据格式	JSON
授权	Bearer (token)

Bearer令牌对应于Hive控制台中的Hive身份验证密钥应用中心 > 项目管理 > 选择游戏公司 > 游戏详情 > 基本信息。

请求参数¶

字段	类型	必需	描述
api	字符串	是	API标识符（`product` 固定值）
market_id	字符串	是	Hive 市场ID（PG支付：`15` 固定值）
appid	字符串	是	Hive 应用ID
hive_country	字符串	是	国家代码（ISO 3166-1 两个字母）
game_language	字符串	是	语言（ISO 639-1 两个字母）
vid	字符串	是	Hive 账户信息（玩家ID）
vid_type	字符串	是	账户类型（对于新游戏，v4）
market_pid_type	字符串	是	产品类型（可消耗：消耗品）

响应元素¶

字段	类型	必需	描述
result	整数	是	响应代码（0表示成功，其他任何值表示错误）
result_msg	字符串	是	响应消息
product_list	对象	是	产品信息列表
product_list > market_pid	字符串	是	产品PID
product_list > price	整数	是	产品价格（数值）
product_list > currency	字符串	是	产品价格的货币
product_list > display_price	字符串	是	产品价格（包括货币符号）
product_list > title	字符串	是	产品名称
product_list > description	字符串	是	产品描述
product_list > product_type	字符串	是	产品类型（可消耗）
update_date	字符串	是	产品PID信息的最后更新时间

请求示例¶

curl -L -v \
    -d '{"api": "product","market_id": 15,"appid": "com.com2us.hivesdk.windows.microsoftstore.global.normal","hive_country": "KR","game_language": "ko","vid": "100000000000","vid_type": "v4","market_pid_type": "consumable"}' \
    -H "Content-Type: text/html" \
    -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJIaXZlIiwiaWF0IjoxNjAyMDU2NzI2LCJqdGkiOiIxODczMTExMzIwIn0.3soFiHTPlObCoqR5xX9ZeOQTSvnHrHDHWmopP3QfWtY" \
    https://sandbox-store.withhive.com/external/api/product

响应示例¶

{
    "result": 0,
    "result_msg": "success",
    "product_list": [
        {
            "market_pid": "com.com2us.hivesdk.windows.microsoftstore.global.normal.item01",
            "price": 1200,
            "currency": "KRW",
            "display_price": "₩1,200",
            "title": "크리스탈 한 줌",
            "description": "크리스탈 한 줌",
            "product_type": "consumable"
        }, {
            "market_pid": "com.com2us.hivesdk.windows.microsoftstore.global.normal.item02",
            "price": 2500,
            "currency": "KRW",
            "display_price": "₩2,500",
            "title": "크리스탈 묶음",
            "description": "크리스탈 묶음",
            "product_type": "consumable"
        }, {
            "market_pid": "com.com2us.hivesdk.windows.microsoftstore.global.normal.item03",
            "price": 3900,
            "currency": "KRW",
            "display_price": "₩3,900",
            "title": "크리스탈 더미",
            "description": "크리스탈 더미",
            "product_type": "consumable"
        }
    ],
    "update_date": "2022-10-28 16:11:23"
}

产品订单请求¶

使用从产品列表中选择的 PID（产品ID）信息请求产品订单。

请求 URL¶

环境	网址
生产网址	https://store.withhive.com/external/api/order
沙盒网址	https://sandbox-store.withhive.com/external/api/order
HTTP 方法	POST
内容类型	text/html; charset=utf-8
数据格式	JSON
授权	Bearer (token)

Bearer令牌对应于在Hive控制台中找到的Hive身份验证密钥应用中心 > 项目管理 > 选择游戏公司 > 游戏详情 > 基本信息。

请求参数¶

字段	类型	必需	描述
market_id	字符串	是	Hive 市场 ID
appid	字符串	是	Hive Appid
hive_country	字符串	是	国家代码（ISO 3166-1 两个字母）
game_language	字符串	是	语言（ISO 639-1 两个字母）
vid	字符串	是	Hive 账户信息（玩家 ID）
vid_type	字符串	是	账户类型（对于新游戏，v4）
market_pid	字符串	是	产品 PID
server_id	字符串	是	服务器 ID
os	字符串	是	Windows: W, MAC: M, Android: A
quantity	整数	否	购买数量（如果未发送，默认值为 1）
iap_payload	字符串	否	由应用开发者定义的购买元信息在这里

请求示例¶

curl -L -v \
    -d '{"market_id": 15,"appid": "com.com2us.hivesdk.windows.microsoftstore.global.normal","hive_country": "KR","game_language": "ko","vid": "100000000000","vid_type": "v4","market_pid": "com.com2us.hivesdk.windows.microsoftstore.global.normal.item01","server_id": "KR1","os": "A","quantity": 1,"iap_payload": "{\"character_id\":\"hivesdk01\"}"}' \
    -H "Content-Type: text/html" \
    -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJIaXZlIiwiaWF0IjoxNjAyMDU2NzI2LCJqdGkiOiIxODczMTExMzIwIn0.3soFiHTPlObCoqR5xX9ZeOQTSvnHrHDHWmopP3QfWtY" \
    https://sandbox-store.withhive.com/external/api/order

响应示例¶

当产品订单请求成功处理时，它会返回一个弹出窗口以选择支付方式。以下是构成弹出窗口的HTML页面。

付款完成详情查询¶

当支付完成后，支付机构（PG）直接将支付结果传输到 Hive IAP v4 服务器。此方法弥补了网络的不稳定性，并防止支付数据被篡改。在预工作期间，通过将注册的支付信息与支付机构（PG）的信息进行比较，进行交叉验证。一旦确认支付信息的完整性，将采取额外的安全措施，并存储支付信息。存储的支付信息可以通过支付完成历史查询 API 检索。

客户端在需要用户支付完成信息的时刻请求游戏服务器的信息，游戏服务器通过 Hive IAP v4 服务器检索支付信息。如果有用户支付的记录，将使用 purchase_bypass_info 进行支付信息验证。

请求 URL¶

生产 URL	https://hiveiap.qpyou.cn/api_v4/purchases/unconsumed
沙盒 URL	https://sandbox-hiveiap.qpyou.cn/api_v4/purchases/unconsumed
HTTP 方法	POST
内容类型	application/json
数据格式	JSON
授权	Bearer (token)

Bearer令牌对应于Hive控制台中的Hive身份验证密钥应用中心 > 项目管理 > 选择游戏公司 > 游戏详情 > 基本信息。

请求参数¶

名称	类型	必需 (必需: M, 可选: O)	描述
appid	字符串	M	从 Hive 控制台 > 应用中心注册并发放的 ID
market_id	数字	M	唯一市场 ID (使用固定值 `15`)
server_id	字符串	M	发生支付的游戏服务器识别码
user_id_type	字符串	M	HIVE 用户类型 uid : 个人模块 (v0) vid : 认证 v1 (v1) player_id : 认证 v4 (v4)
user_id	数字	M	HIVE 用户 ID 根据 user_id_type 发送 uid : 个人模块 (v0) vid : 认证 v1 (v1) player_id : 认证 v4 (v4)

响应元素¶

名称	类型	必需 (必需: M, 可选: O)	描述
result	数字	M	响应代码 (0: 成功)
result_msg	字符串	M	基于响应代码的结果消息
unconsumed_lists	对象数组	M
┕ market_pid	字符串	M	产品唯一ID
┕ order_id	字符串	M	订单号
┕ server_id	字符串	M	区分用户购买的游戏服务器的代码
┕ vid	字符串	M	用户的PlayerID，v1认证的VID
┕ uid	字符串	O	用户的uid
┕ amount	字符串	M	支付金额
┕ currency	字符串	M	支付货币
┕ quantity	数字	M	购买数量
┕ started_datetime	日期时间	M	支付开始时间 (Y-m-d H:i:s)
┕ paid_datetime	日期时间	M	支付完成时间 (Y-m-d H:i:s)
┕ started_datetime_ms	数字	M	支付开始时间 (Unix时间戳毫秒)
┕ paid_datetime_ms	数字	M	支付完成时间 (Unix时间戳毫秒)
┕ hiveiap_receipt	字符串	M	支付信息加密HASH
┕ purchase_bypass_info	字符串	M	收据验证请求所需的信息
┕ iap_payload	字符串	O	从客户端接收的额外信息，以发送到游戏服务器 (以JSON字符串格式) (如果没有接收到信息，则返回null)

请求示例¶

curl -L -v
 -d '{"appid" : "com.com2us.hivesdk.windows.microsoftstore.global.normal","market_id" : 15,"server_id" : "kr","user_id_type": "player_id", "user_id": 30000056996}' \
 -H "Content-Type: text/html" \
 -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJIaXZlIiwiaWF0IjoxNjAyMDU2NzI2LCJqdGkiOiIxODczMTExMzIwIn0.3soFiHTPlObCoqR5xX9ZeOQTSvnHrHDHWmopP3QfWtY" \
 https://sandbox-hiveiap.qpyou.cn/api_v4/purchases/unconsumed

响应示例¶

{
    "result": 0,
    "result_msg": "SUCCESS",
    "unconsumed_lists": [
        {
            "market_pid": "com.com2us.hivesdk.windows.microsoftstore.global.normal.item01",
            "order_id": "h2164792542890731850",
            "server_id": "kr",
            "vid": "30000056996",
            "uid": "13079",
            "amount": "1200",
            "currency": "KRW",
            "quantity": 1,            
            "started_datetime": "2022-03-22 14:03:49",
            "paid_datetime": "2022-03-22 14:04:39",
            "market_id": "15",
            "hiveiap_receipt": "2YnGzfTCGycoMjcSyYyNXBjANwmFyB6m\/c0bYazQ8VQ=",
            "purchase_bypass_info": "eyJtYXJrZXRfcGlkIjoiY29tLmNvbTJ1cy5oaXZlc2R...",
            "started_datetime_ms": 1647925429000,
            "paid_datetime_ms": 1647925479000,
            "iap_payload": null
        }
    ]
}

支付信息验证¶

支付结果验证 API 基于 IAP v4 收据验证。

支付结果验证使用之前收到的 purchase_bypass_info。 purchase_bypass_info 包含在进行支付之前通过 SDK 接收到的各种信息，并发送到 Hive Analytics。如果您需要将 销售日志 与收据验证请求一起发送，请使用 game_info。收到的 game_info 作为将日志从 Hive IAP 发送到分析服务器的中介。

请求 URL¶

生产 URL	https://hiveiap-verify.qpyou.cn/api_v4/verify
沙盒 URL	https://sandbox-hiveiap-verify.qpyou.cn/api_v4/verify
HTTP 方法	POST
内容类型	text/html
数据格式	JSON
授权	Bearer (token)

Bearer 令牌对应于 Hive 控制台中的 Hive 认证密钥 应用中心 > 项目管理 > 选择游戏公司 > 游戏详情 > 基本信息。

请求参数¶

名称	类型	必需（必需：M，选填：O）	描述
purchase_bypass_info	字符串	M	用于收据替代和分析传输的数据
game_info	对象数组	O	如果有日志需要发送到游戏，例如游戏日志或销售日志，请将此值添加到游戏中进行传输，Hive IAP 将作为代理将其发送到分析服务器。在收据验证阶段，无法知道物品是否已交付（itemsendok），因此此部分必须单独实现并提供额外信息。
⠀⠀server_uid	bigint	O	游戏服务器发放的用户 ID 如果没有，则为 0
⠀⠀giftee_uid	bigint	O	null：个人使用的付款 0：收件人存在但 UID 无法验证；Derby Days 客户账户没有中心客户账户，因此这里适用
⠀⠀level	int	O	用户在游戏中的等级如果没有等级，则不需要。如果没有，则为 0。
⠀⠀character_id	bigint	O	服务器内的唯一角色标识符（PK？）。如果没有角色概念，则为“0”
⠀⠀character_type_id	int	O	角色类型标识符对于没有角色概念的游戏，输入“0”
⠀⠀character_level	int	O	角色类型标识符对于没有角色概念的游戏，输入“0”
⠀⠀is_emulator	int	O	如果通过模拟器访问 PC，例如 BlueStacks，请输入“1”；否则，请输入“0”

响应元素¶

名称	类型	必需 (必需: M, 可选: O)	描述
result	数字	M	响应代码 (参考响应代码)
result_msg	字符串	M	根据响应代码的结果消息
hiveiap_transaction_id	字符串	M	为每个验证的收据生成的交易ID。此值应存储在游戏服务器上以执行重复收据检查。
hiveiap_market_id	字符串	O	市场唯一编号 (PG支付: 固定为15)
hiveiap_market_pid	字符串	O	支付产品PID
hiveiap_market_transaction_id	字符串	O	订单的唯一订单号
hiveiap_receipt	字符串	O	市场收据对象值 (PG支付: 固定为null)
hiveiap_purchase_test	字符串	O	测试支付状态 (Y: 测试支付 / N: 正常支付)

响应代码¶

代码	消息	评论
0	成功，重复收据	验证成功
1000001	没有请求的参数	当没有发送参数时
1000003	数据库连接错误	当数据库连接失败时
1000005	内部服务器错误	内部服务器错误
1000006	缺少必需的参数信息	当缺少必需的参数值时
1000503	验证收据失败	验证收据失败或是被篡改的收据（例如，欺骗攻击）
1000507	保存购买信息失败	保存购买历史失败
1000524	验证收据失败。（订单不存在）	收据验证失败（订单不存在）
1000525	验证收据失败。（参数错误）	收据验证失败（参数错误）

请求示例¶

curl -L -v \
 -d '{"purchase_bypass_info":"eyJtYXJrZXRfaWQiOiIxNSIsIm9yZGVyX2lkIjoiSDMxNjQ3OTI1NDI4OTA3MzE4NTAiLCJtYXJrZXRfcGlkIjoiY29tLmNvbTJ1cy5oaXZlc2RrLndpbmRvd3MubWljcm9zb2Z0c3RvcmUuZ2xvYmFsLm5vcm1hbC5pdGVtMDEiLCJ2aWQiOiIzMDAwMDA1Njk5NiIsInVpZCI6IjEzMDc5Iiwic2VydmVyX2lkIjoia3IiLCJhcHBpZCI6ImNvbS5jb20ydXMuaGl2ZXNkay53aW5kb3dzLm1pY3Jvc29mdHN0b3JlLmdsb2JhbC5ub3JtYWwiLCJhbW91bnQiOiIxMjAwIiwic3RhcnRlZF9kYXRldGltZSI6bnVsbCwicGFpZF9kYXRldGltZSI6bnVsbCwiY3VycmVuY3kiOiJLUlciLCJoaXZlaWFwX3JlY2VpcHQiOiIyWW5HemZUQ0d5Y29NamNTeVl5TlhCakFOd21GeUI2bVwvYzBiWWF6UThWUT0ifQ=="}' \
 -H "Content-Type: text/html" \
 -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJIaXZlIiwiaWF0IjoxNjAyMDU2NzI2LCJqdGkiOiIxODczMTExMzIwIn0.3soFiHTPlObCoqR5xX9ZeOQTSvnHrHDHWmopP3QfWtY" \
 https://sandbox-hiveiap-verify.qpyou.cn/api_v4/verify

响应示例¶

{
    "result": 0,
    "result_msg": "success",
    "hiveiap_transaction_id": "HS_13",
    "hiveiap_market_id": 15,
    "hiveiap_market_pid": "com.com2us.hivesdk.windows.microsoftstore.global.normal.item01",
    "hiveiap_market_transaction_id": "h2164792542890731850",
    "hiveiap_receipt": null,
    "hiveiap_purchase_test": "N"
}

付款结果处理¶

支付结果处理 API 基于 IAP v4 商品支付结果传输。支付结果处理 API 完成从商品购买到支付完成的支付过程。如果支付过程未完成，用户将无法购买相同的产品。在尝试购买并进入支付页面时，将显示一条消息“您已经拥有此产品。”，并且支付将不会继续。

在尝试通过打开多个支付窗口进行购买和支付时，任何未处理支付的产品将会自动取消。在处理所有支付程序后，例如检查购买限制和游戏服务器进行的物品交付，支付结果将被发送以通知Hive IAP v4服务器支付已完成。如果您希望请求取消支付，您也可以通过交付结果处理API请求取消。

请求 URL¶

生产 URL	https://hiveiap.qpyou.cn/api_v4/item_result
沙盒 URL	https://sandbox-hiveiap.qpyou.cn/api_v4/item_result
HTTP 方法	POST
内容类型	text/html
数据格式	JSON
授权	Bearer (token)

Bearer 令牌对应于 Hive 控制台中的 Hive 身份验证密钥 应用中心 > 项目管理 > 选择游戏公司 > 游戏详情 > 基本信息.

请求参数¶

名称	类型	必需 (必需: M, 可选: O)	描述
hiveiap_transaction_id	字符串	M	收据验证结果的 hiveiap_transaction_id
result_status	数字	M	物品交付成功状态 0: 交付失败 1: 交付成功 2: 付款取消退款请求（仅限 PG）
result_status_message	字符串	O	交付失败或付款取消请求的原因
user_id_type	字符串	M	Hive 用户类型 v0: 个人模块 (uid) v1: 身份验证 v1 (vid) v4: 身份验证 v4 (player_id)
user_id	数字	M	用户 ID 如果 user_id_type 是 v0，则发送 uid；如果是 v1，则发送 vid；如果是 v4，则发送 player_id
asset	对象数组	O	交付物品的信息仅在交付成功时提供值，当交付失败时响应一个空数组 ([])
asset_id	字符串	O	物品 ID
asset_name	字符串	O	物品名称
⠀⠀数量	数字	O	交付的物品数量

响应元素¶

名称	类型	必需 (必需: M, 可选: O)	描述
result	数字	M	响应代码 (0: 成功)
result_msg	字符串	M	根据响应代码的结果消息

请求示例¶

curl -L -v
 -d '{"hiveiap_transaction_id" : "HS_13","result_status": 1,"user_id_type": "vid","user_id": 30000056996,"asset": [ {"asset_id":"item_id","asset_name":"item_name","quantity":1}
,{"asset_id":"item_id","asset_name":"item_name","quantity":1}]}' \
 -H "Content-Type: text/html" \
 -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJIaXZlIiwiaWF0IjoxNjAyMDU2NzI2LCJqdGkiOiIxODczMTExMzIwIn0.3soFiHTPlObCoqR5xX9ZeOQTSvnHrHDHWmopP3QfWtY" \
 https://sandbox-hiveiap.qpyou.cn/api_v4/item_result

响应示例¶

{
    "result": 0,
    "result_msg": "success"
}

付款结果通知服务¶

支付结果通知服务在支付完成或取消时立即将结果发送到游戏服务器。此 API 以与支付完成历史查询相同的方式传输 purchase_bypass_info 值，允许游戏使用此值验证收据并将产品授予用户。只有在支付结果传输信息中的 type 为已支付时，才应执行收据验证和产品授予。

Note

要使用此 API，您必须首先在 Hive 控制台中设置 PG 公司。建议使用此 API 或支付完成历史查询 API 进行收据验证和产品交付。

关于支付结果传输的基本信息¶

HTTP 方法	POST
内容类型	application/json
数据格式	JSON

付款结果传输信息¶

名称	类型	必需 (必需: M, 可选: O)	描述
类型	字符串	M	通知类型（已支付：支付完成，已取消：支付取消或退款）
市场产品ID	字符串	M	唯一产品ID
订单ID	字符串	M	订单编号
服务器ID	字符串	M	区分购买用户访问的游戏服务器的代码
玩家ID	字符串	M	购买用户的玩家ID，VID用于v1身份验证
VID类型	字符串	O	根据SDK版本的VID类型值（默认v4）
用户ID	字符串	O	购买用户的UID
金额	字符串	M	支付金额
货币	字符串	M	支付货币
数量	数字	M	购买数量
开始时间	日期时间	M	支付开始时间（Y-m-d H:i:s）
支付时间	日期时间	M	支付完成时间（Y-m-d H:i:s）
取消时间	日期时间	O	支付被取消或退款的时间（Y-m-d H:i:s）
开始时间（毫秒）	数字	M	支付开始时间（Unix时间戳毫秒）
支付时间（毫秒）	数字	M	支付完成时间（Unix时间戳毫秒）
取消时间（毫秒）	数字	O	支付被取消或退款的时间（Unix时间戳毫秒）
取消原因	字符串	O	支付取消或退款的原因
收据	字符串	M	支付信息的加密HASH
购买绕过信息	字符串	M	收据验证请求所需的信息
iap_payload	字符串	O	从客户端接收到的附加信息，用于发送到游戏服务器。它是JSON字符串格式，如果未收到任何信息，则返回null。

支付结果传输示例（支付完成时）¶

{
    "type": "paid",
    "market_id": "15",
    "order_id": "H2168993822440686730",
    "market_pid": "com.com2us.hivesdk.windows.microsoftstore.global.normal.item01",
    "vid": "20000011337",
    "uid": "67200717",
    "vid_type": "v4",
    "server_id": "kr",
    "appid": "com.com2us.hivesdk.windows.microsoftstore.global.normal",
    "amount": "1200",
    "started_datetime": "2023-07-21 20:17:06",
    "paid_datetime": "2023-07-21 20:18:13",
    "cancelled_datetime": null,
    "cancelled_reason": null,
    "currency": "KRW",
    "quantity": 1,
    "hiveiap_receipt": "tJpwQSIlNFiCSPokHSRYTvTLmtbDiSZnkYa7+IWaMwM=",
    "started_datetime_ms": 1689938226000,
    "paid_datetime_ms": 1689938293000,
    "cancelled_datetime_ms": null,
    "iap_payload": null,
    "purchase_bypass_info": "eyJ0eXBlIjoicGFpZCIsIm1hcmtldF9pZCI6IjE1Iiwib3JkZXJfaWQiOi..."
}

付款结果传输示例（当付款被取消时）¶

{
    "type": "cancelled",
    "market_id": "15",
    "order_id": "H2168993822440686730",
    "market_pid": "com.com2us.hivesdk.windows.microsoftstore.global.normal.item01",
    "vid": "20000011337",
    "uid": "67200717",
    "vid_type": "v4",
    "server_id": "kr",
    "appid": "com.com2us.hivesdk.windows.microsoftstore.global.normal",
    "amount": "1200",
    "started_datetime": "2023-07-21 20:17:06",
    "paid_datetime": "2023-07-21 20:18:13",
    "cancelled_datetime": "2023-07-21 20:21:44",
    "cancelled_reason": "테스트 결제 취소",
    "currency": "KRW",
    "quantity": 1,
    "hiveiap_receipt": "tJpwQSIlNFiCSPokHSRYTvTLmtbDiSZnkYa7+IWaMwM=",
    "started_datetime_ms": 1689938226000,
    "paid_datetime_ms": 1689938293000,
    "cancelled_datetime_ms": 1689938504000,
    "iap_payload": null,
    "purchase_bypass_info": "eyJ0eXBlIjoiY2FuY2VsbGVkIiwibWFya2V0X2lkIjoiMT..."
}