- Last Updated
Game Coupon Registration API
Introduction
Registers a game coupon.
Basic Information
text
POST /coupon/v3.0/{user_token_type}/game/coupon/use
Host:
https://api.onstove.com (LIVE)
https://api.gate8.com (SB)
Content-Type: application/json
Request
Header
| Name | Type | Required | Default Value | Example | Description |
|---|---|---|---|---|---|
| Authorization | String | Y | - | Access token issued through user authentication. |
Path Variable
| Name | Type | Required | Default Value | Example | Description |
|---|---|---|---|---|---|
| user_token_type | string | Y | - | web | User token type; all token types are supported. |
Parameter
| Name | Type | Required | Default Value | Example | Description |
|---|---|---|---|---|---|
| game_code | string | Y | - | STOVE_QA_ALPHA | Game ID assigned by the platform. |
| coupon_no | string | Y | - | H370Y300R2M02YV0 | Coupon box serial number |
| client_ipaddr | String | Y | - | 10.5.24.52 | Member's access IP address |
| world_no | String | N | - | 1 | Game world number |
| character_no | String | N | - | 52345642 | Member character number |
| game_coupon_id | Int64 | N | - | 15451 | Game coupon ID. If provided, a mismatch is treated as an invalid coupon code. |
| lang_code | String | Y | - | ko | Language code |
Response
Body
| Name | Type | Required | Default Value | Example | Description |
|---|---|---|---|---|---|
| result | String | Y | - | 000 | Response code |
| message | String | Y | - | OK | Response message |
| value | Object | N | - | - | Response value |
value
| Name | Type | Required | Default Value | Example | Description |
|---|---|---|---|---|---|
| coupon_box_id | Int64 | Y | - | 6449393 | Coupon box serial number |
| cbox_save_flag | Boolean | Y | - | ture | Whether to save in the coupon box |
Sample
Request
text
curl --location --request POST '/coupon/v3.0/web/game/coupon/use' \
--header 'Authorization: Bearer {{access_token}}'
{
"game_code":"STOVE_QA_ALPHA",
"coupon_no":"AMH0G4E0A110VBM8",
"client_ipaddr":"211.34.57.2",
"world_no":"1",
"character_no":"98175593",
"lang_code":"ko"
}
Response
text
{
"value":
{
"coupon_box_id":4010326,
"cbox_save_flag":false
},
"result": "000",
"message": "OK"
}
Failed response example
text
{
"result": "5105",
"message": "Invalid coupon code. Please check the coupon code. (1 failed attempt)"
}
Return Code
| HTTP Status code | Code | Message | Description |
|---|---|---|---|
| 200 | 5031 | The daily verification limit has been exceeded. | |
| 200 | 5105 | Invalid coupon code. Please check the coupon code. | Actual error message: Invalid coupon code. ({0} failed attempts) Please check the coupon code. |
| 200 | 5165 | This coupon can only be redeemed from the coupon box. | The code belongs to an account-issued coupon. |
| 200 | 5450 | This coupon is already registered in the coupon box. | The code can be redeemed only once and is already registered in the coupon box. |
| 200 | 5125 | This coupon has already been redeemed. | |
| 200 | 5130 | This coupon has been disabled. | Coupon was invalidated through Partners or withdrawal of consent to the game's terms of use. |
| 200 | 5135 | This coupon has expired. | Redemption period has ended. |
| 200 | 5161 | The coupon registration period has expired. | Registration period has ended. |
| 200 | 6055 | The registration period has not started. | |
| 200 | 5162 | This coupon cannot be redeemed in this country. | |
| 200 | 2605 | This membership account cannot be used. | |
| 200 | 5202 | You have already redeemed this group coupon. | Group coupon |
| 200 | 5033 | This coupon code can no longer be redeemed. | Applies to codes that allow multiple redemptions (shared and group coupons). |
| 200 | 5155 | The coupon redemption limit has been exceeded. | |
| 200 | 5200 | You are not eligible for this coupon. | Targeted coupon: account is not an eligible recipient. |
| 200 | 6033 | You have already redeemed a coupon from this group. | Another coupon in the same coupon group was redeemed. |
| 200 | 6026 | The redemption limit has been exceeded. | 24-hour limit |
| 200 | 100 | This coupon can only be redeemed at a PC cafe. | Previous message: PC cafe-only coupon. |
| 200 | 7014 | Please select a character. | Coupon is redeemed immediately upon registration and requires character information. |
| 200 | 5164 | This coupon cannot be redeemed in this world. | |
| 200 | Other | Internal Error | Internal error: Contact the STOVE technical PM team. |
| 401 | 999 | Authorization has been denied for this request |
Contact Us
If you have any questions, please contact us on Discord or by email at store.support@smilegate.com.