Check payment validity

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

GET /bill-cpm/v1.0/payment/{service_id}/detail
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	-	Bearer {user access_token}	user access token issued through the user's authentication
caller-id	String	Y	-	{GAME_ID}_SERVER	API caller information

Path Variable

Name	Type	Required	Default Value	Example	Description
service_id	String	Y	-	STOVE_GAME	Game code (issued by STOVE - game_id)

Parameter (Query String)

Name	Type	Required	Default Value	Example	Description
bill_platform_type	string(16)	Y	-	SHOP	Payment place -MOBILE: Mobile billing - SHOP: Store (online billing)
noti_type	string(32)	Y	-	ONLINE_PURCHASE	notification classification -ONLINE_PURCHASE: Purchase of online general products -IAP_PURCHASE: Purchase of mobile general products -IAP_SUBSCRIPT: Purchase of mobile subscription products -IAP_OOAP: Purchase of mobile OOAP products -ONLINE_CART_PURCHASE: Purchase online shopping cart products
guid	string(50)	Y	-	-	Stove member GUID (game-specific user unique ID).Required except for games that don't have a GUID (Single play games).
member_no	long	Y	-	-	Membership number
tid	string(20)	Y	-	T202202103125	Order number issued by Stove Billing (TransactionDetailNo value when linking 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 Stove 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 products, mobile products)

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 Stove 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 GET'https://api.onstove.com/bill-cpm/v1.0/payment/STOVE_GAME/detail?bill_platform_type=SHOP&guid=1003243&tid=T202202103125&member_no=123456' \
--header 'Authorization: Bearer {{access_token}}'
--header 'caller-id: {{caller-id}}'

Response

{
     "code":0,
     "message":"OK",
     "data":
       Online General Merchandise / Mobile General Merchandise
        {
            "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"
                }
            ]
        }
  }

Return Code

HTTP Status code	response_code	response_message	Description
200	0	OK	Success
200	2004	Platform information does not exist.	No platform URL information
200	404	Checkout is not working	Each platform - if the order does not exist
200	99999	Payment is not successful.	Each platform - when a system error occurs.
500	500	[Internal Error]	Internal error: please contact billing