# Payment validation (BULK processing)
# Introduction
It is used to check the validity of the payment from the payment source (game/mobile billing/online billing).
When integrating billing using the standard payment window, it is used to retrieve the details of the payment by member_no and transaction number.
# Basic information
POST /bill-cpm/v1.0/payment/{service_id}/details
Host:
https://api.onstove.com (LIVE)
https://api.gate8.com (SB)
Content-Type: application/json
1
2
3
4
5
2
3
4
5
# Request
# Header
| Name | Type | Required | Default Value | Example | Description |
|---|---|---|---|---|---|
| Authorization | String | Y | - | Bearer {access_token} | user access token issued through the user's authentication. |
| X-Lang | String | Y | - | en | Language code |
| X-Nation | String | Y | - | KR country code | |
| X-Timezone | String | Y | - | Asia/Seoul | Timezone |
| X-Utc-Offset | Int32 | Y | - | 540 UTC Offset | |
| caller-id | String | Y | - | {GAME_ID}_SERVER | API caller info |
# Path Variable
| Name | Type | Required | Default Value | Example | Description |
|---|---|---|---|---|---|
| service_id | String | Y | - | STOVE_GAME | Game code (issued by STOVE - game_id) |
# Body
| Name | Type | Required | Default Value | Example | Description |
|---|---|---|---|---|---|
| details | List {Json Object} | Y | - | - | Details - max 100 |
# details
| Name | Type | Required | Default Value | Example | Description |
|---|---|---|---|---|---|
| bill_platform_type | string(16) | Y | - | SHOP | Payment source -MOBILE: Mobile billing - SHOP: Shop (online billing) |
| noti_type | string(32) | Y | - | ONLINE_PURCHASE | Notification criteria -ONLINE_PURCHASE : Purchase general merchandise online -IAP_PURCHASE : Mobile general merchandise purchases -IAP_SUBSCRIPT : Purchase a mobile subscription -IAP_OOAP : Purchase mobile OOAP products -ONLINE_CART_PURCHASE: Online Shopping CartPurchase an item |
| guid | string(50) | Y | - | - | Stove member GUID (game-specific user unique ID).Required except for games that don't have a GUID (currently single play games). |
| member_no | long | Y | - | - | Member number |
| tid | string(20) | Y | - | T202202103125 | Order number issued by Stove Billing (TransactionDetailNo value when connecting PC_SDK) |
# Response
# Body
| Name | Type | Required | Default Value | Example | Description |
|---|---|---|---|---|---|
| code | Integer | Y | - | 0 | Response code |
| message | String | Y | - | OK | Response message |
| data | Object | N | - | - | Response value |
# data(Online products, mobile products)
| Name | Type | Required | Default Value | Example | Description |
|---|---|---|---|---|---|
| tid | string(20) | Y | - | T202202103125 | Order number issued by Stoves Billing |
| product_id | string(20) | Y | - | p1002 | Product code registered on the Stove platform |
| quantity | Integer | N | 1 | 20 | Individual product quantity |
| product_price | decimal | Y | - | 1100, 0.99 | Transaction amount |
| product_currency | string(3) | Y | - | KRW, USD | Currency of the amount |
| txn_time | long | Y | - | 1644489139000 | Payment time (Unix Timestamp UTC-0) |
| inservice_item_id | string(30) | Y | - | cp7892 | In-game item ID |
# data(online shopping cart items)
| Name | Type | Required | Default Value | Example | Description |
|---|---|---|---|---|---|
| tid | string(20) | Y | - | T202202103125 | Order number issued by Stove Billing |
| products | Array | Y | - | - | Products - implemented as an Array for shopping cart support |
# products
| Name | Type | Required | Default Value | Example | Description |
|---|---|---|---|---|---|
| tid | string(20) | Y | - | T202202103125 | Order number issued by Stoves Billing |
| product_id | string(20) | Y | - | p1002 | Product code registered on the Stove platform |
| quantity | Integer | Y | - | 1 | Individual product quantity |
| product_price | decimal | Y | - | 1100, 0.99 | Transaction amount |
| product_currency | string(3) | Y | - | KRW, USD | Currency of the amount |
| txn_time | long | Y | - | 1644489139000 | Payment time (Unix Timestamp UTC+0) |
| inservice_item_id | string(30) | Y | - | cp7892 | In-game item ID |
# Sample
# Request
curl --location --request POST 'https://api.onstove.com/bill-cpm/v1.0/payment/{service_id}/details' \
--header 'Authorization: Bearer {{access_token}}'
--header 'caller-id: {{caller-id}}'
{
"details" : [
{
"tid": "T20220304125",
"noti_type": "IAP_PURCHASE ",
"bill_platform_type": "MOBILE",
"guid": "120552311123",
"member_no": 123456
},
{
"tid": "T20220304127",
"noti_type": "ONLINE_PURCHASE",
"bill_platform_type": "SHOP",
"guid": "120552311150",
"member_no": 123456
}
]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
# Response
{
"code":0,
"message":"OK",
"data": [
Online Products / Mobile Products
{
"tid":"T202202103125",
"product_id":"p1002",
"product_price":5000.00,
"product_currency":"KRW",
"txn_time":1644489139000,
"inservice_item_id":"cp7892"
}
Online shopping cart items
{
"tid": "T202202103125",
"products": [
{
"product_id": "123456",
"quantity": 1,
"product_price": 5000.00,
"product_currency": "KRW",
"txn_time": 1644489139000,
"inservice_item_id": "cp7892"
}
]
}
]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
# Return Code
| HTTP Status code | response_code | response_message | Description |
|---|---|---|---|
| 200 | 2004 | Platform information does not exist. | No platform URL information |
| 200 | 404 | Checkout is not successful | Each platform - if the order does not exist |
| 401 | 99999 | Payment is not successful. | Each platform - in case of a system error. |
| 500 | 500 | [Internal Error] | Internal error: please contact billing |