コンテンツにスキップ

クーポンの検証

これは、割引クーポンが使用できるかどうかを確認するために使用されるAPIです。

Note

Please refer to here for identifier policies.

リクエスト情報

アイテム 説明
プロダクション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) 説明
コード 整数 M レスポンスコード (103: 使用可能)
メッセージ 文字列 M レスポンスコードに応じた結果メッセージ
情報 オブジェクト O 使用可能な場合、パーセントのサブアイテムで割引クーポンの割合を返します
情報 > パーセント 整数 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 DB通信エラー クーポンの使用に失敗しました。
続けて失敗する場合は、カスタマーサービスにお問い合わせください。
501 サーバー通信失敗 クーポンの使用に失敗しました。
続けて失敗する場合は、カスタマーサービスにお問い合わせください。