跳轉至

驗證優惠券

這是一個用於驗證折扣券是否可以使用的API。

Note

请参考这里以获取标识符政策。

請求資訊

項目 描述
生產 URL https://coupon.withhive.com/tp/coupon/discount_coupon_verify
沙盒 URL https://sandbox-coupon.withhive.com/tp/coupon/discount_coupon_verify
方法 POST
回應格式 JSON

請求標頭

項目 描述 類型 必需 備註
Content-Type application/json 字串 Y
Authorization Bearer 字串 Y 如何檢查 Hive 認證金鑰:應用中心 > 專案管理 > 遊戲詳情 > 基本資訊 > Hive 認證金鑰

請求參數

名稱 類型 必需 (必需: M, 選擇性: O) 描述
game_index 整數 M 應用中心遊戲索引
coupon 字串 M 優惠券號碼
cs_code 字串 M 遊戲內用戶 CS 代碼
language 字串 O 回應訊息顯示 語言代碼
(預設為英語) 直接在螢幕上顯示訊息時使用
discount_type 字串 O 折扣類型 (固定為 'percent')

回應

名稱 類型 必需 (必需: M, 可選: O) 描述
code 整數 M 回應代碼 (103: 可用)
message 字串 M 根據回應代碼的結果訊息
info 物件 O 如果可用,則回應折扣券百分比於 percent 子項中
info > percent 整數 O 折扣券百分比

請求範例

curl -L -v
 -d '{"game_index": 539,"coupon": "HIVESDKTEST","cs_code": "123456789","language": "ko","discount_type":"percent"}'
 -H "Content-Type: text/html"
 -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJIaXZlIiwiaWF0IjoxNjAyMDU2NzI2LCJqdGkiOiIxODczMTExMzIwIn0.3soFiHTPlObCoqR5xX9ZeOQTSvnHrHDHWmopP3QfWtY"
 https://sandbox-coupon.withhive.com/tp/coupon/api
>> POST /tp/coupon/discount_coupon_verify HTTP/2
> Host: sandbox-coupon.withhive.com 
> user-agent: curl/7.68.0 
> Content-Type: application/json
> Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJIaXZlIiwiaWF0IjoxNjAyMDU2NzI2LCJqdGkiOiIxODczMTExMzIwIn0.3soFiHTPlObCoqR5xX9ZeOQTSvnHrHDHWmopP3QfWtY
> Accept: */*
> Content-Length: 105

回應範例

< HTTP/2 200
< server: nginx
< date: Wed, 27 Aug 2025 12:22:34 GMT
< content-type: application/json; charset=utf-8
{"code":103,"message":"The coupon will not be used until payment is completed.","info": {"percent": 30}}

回應代碼

代碼 描述 訊息
103 可用於使用 直到付款完成之前,優惠券不會被使用。
200 請求參數錯誤 一些參數缺失或參數名稱不正確。
202 帳戶使用限制超過 您已超過可用的優惠券使用限制。
203 團體優惠券使用限制超過 您已超過可用的優惠券使用限制!
204 發放的優惠券與遊戲資訊不匹配 此優惠券僅可用於對應遊戲的事件優惠券兌換。
205 無法使用的優惠券 此優惠券無法使用。
206 優惠券兌換中無法使用折扣券 輸入的優惠券可以在網路商店使用。
300 優惠券號碼長度不正確 優惠券號碼不正確。請重新輸入。
302 不存在的優惠券 這是一個不存在的優惠券號碼。請再檢查一次。
303 優惠券目前正在使用中 此優惠券已經被使用。
304 優惠券已經使用 此優惠券已經被使用。
305 優惠券使用限制超過(所有唯一優惠券已使用) 所有發放的優惠券均已使用。
306 已過期的優惠券 此優惠券已過期。
311 停止發放的優惠券 此優惠券已停止發放。
312 使用前期間的優惠券 尚未進入優惠券使用期間。(測試優惠券不在驗證範圍內)
400 項目傳輸錯誤(完全失敗) 優惠券使用失敗。
如果持續失敗,請聯繫客服。
401 項目傳輸錯誤(部分失敗) 優惠券使用部分失敗。
請聯繫客服。
500 數據庫通信錯誤 優惠券使用失敗。
如果持續失敗,請聯繫客服。
501 伺服器通信失敗 優惠券使用失敗。
如果持續失敗,請聯繫客服。