지급처(게임/모바일빌링/온라인빌링)에서 결제 유효성 여부를 체크할 때 사용됩니다.
표준 결제창을 이용한 빌링 연동시 member_no와 트랜잭션 번호로 해당 결제의 상세 정보를 조회하는데 사용됩니다.
기본정보
GET /bill-cpm/v1.0/payment/{service_id}/detail
Host:
https://api.onstove.com (LIVE)
https://api.gate8.com (SB)
Content-Type: application/json
C++
복사
Request
Header
Name | Type | Required | Default Value | Example | Description |
authorization | String | Y | - | Bearer {user access_token} | 사용자의 인증을 통해 발급 되는 user access token |
caller-id | String | Y | - | {GAME_ID}_SERVER | API 호출자 정보 |
Path Variable
Name | Type | Required | Default Value | Example | Description |
service_id | String | Y | - | STOVE_GAME | 게임코드 (game_id) |
Parameter (Query String)
Name | Type | Required | Default Value | Example | Description |
bill_platform_type | string(16) | Y | - | SHOP | 결제처
- MOBILE : 모바일 빌링
- SHOP: 상점(온라인 빌링) |
noti_type | string(32) | N | - | SHOP_PURCHASE | notification 구분
-ONLINE_PURCHASE : 온라인일반상품 구매
-IAP_PURCHASE : 모바일 일반상품 구매
-IAP_SUBSCRIPT : 모바일 구독상품 구매
-IAP_OOAP : 모바일 OOAP 상품 구매
-ONLINE_CART_PURCHASE: 온라인장바구니상품 구매 |
member_no | long | Y | - | - | 회원 번호 |
tid | string(20) | Y | - | T202202103125 | 스토브 빌링에서 발급한 주문번호 (PC_SDK연동 시 TransactionDetailNo 값) |
Response
Body
Name | Type | Required | Default Value | Example | Description |
code | Integer | Y | - | 0 | 응답 코드 |
message | String | Y | - | OK | 응답 메시지 |
data | Object | N | - | - | 응답 값 |
data(온라인 상품, 모바일 상품)
Name | Type | Required | Default Value | Example | Description |
tid | string(20) | Y | - | T202202103125 | 스토브 빌링에서 발급한 주문번호 |
product_id | string(20) | Y | - | p1002 | 스토브 플랫폼에 등록한 상품 코드 |
quantity | Integer | N | 1 | 20 | 개별 상품 수량 |
product_price | decimal | Y | - | 1100, 0.99 | 거래 금액 |
product_currency | string(3) | Y | - | KRW, USD | 해당 금액의 통화 |
txn_time | long | Y | - | 1644489139000 | 결제 시각(Unix Timestamp UTC-0) |
inservice_item_id | string(30) | Y | - | cp7892 | 게임내 아이템ID |
data(온라인 상품, 모바일 상품)
Name | Type | Required | Default Value | Example | Description |
tid | string(20) | Y | - | T202202103125 | 스토브 빌링에서 발급한 주문번호 |
products | Array | Y | - | - | 상품정보
-장바구니 지원을 위해 Array로 구현 |
products
Name | Type | Required | Default Value | Example | Description |
tid | string(20) | Y | - | T202202103125 | 스토브 빌링에서 발급한 주문번호 |
product_id | string(20) | Y | - | p1002 | 스토브 플랫폼에 등록한 상품 코드 |
quantity | Integer | Y | - | 1 | 개별 상품 수량 |
product_price | decimal | Y | - | 1100, 0.99 | 거래 금액 |
product_currency | string(3) | Y | - | KRW, USD | 해당 금액의 통화 |
txn_time | long | Y | - | 1644489139000 | 결제 시각(Unix Timestamp UTC+0) |
inservice_item_id | string(30) | Y | - | cp7892 | 게임내 아이템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}}'
Plain Text
복사
Response
{
"code":0,
"message":"OK",
"data":
온라인 일반 상품 / 모바일 일반 상품
{
"tid": "T202202103125",
"product_id": "p1002",
"product_price": 5000.00,
"product_currency": "KRW",
"txn_time": 1644489139000,
"inservice_item_id": "cp7892"
}
온라인 장바구니 상품
{
"tid": "T202202103125",
"products": [
{
"product_id": "123456",
"quantity": 1,
"product_price": 5000.00,
"product_currency": "KRW",
"txn_time": 1644489139000,
"inservice_item_id": "cp7892"
}
]
}
}
Plain Text
복사
Return Code
HTTP Status code | response_code | response_message | Description |
200 | 0 | OK | Success |
200 | 2004 | 존재하지 않는 플랫폼 정보 입니다. | 플랫폼 URL 정보 없음 |
200 | 404 | 결제가 원활하지 않습니다. | 각 플랫폼 - 해당 주문건이 없는 경우 |
200 | 99999 | 결제가 원활하지 않습니다. | 각 플랫폼 - 시스템 에러 발생 시 |
500 | 500 | [Internal Error] | 스토브 담당자에게 문의 부탁드립니다. |