API Documentation
All API
Service
Card Product ID InquirySync
Version: v1
Version: v1
/api/v1/service/info/list
Request Headers
Request Parameters
Response Headers
X-KM-Correlation-Id
string
Required
Length : 20
Transaction number for tracking trasncription
- Form : yyMMddHHmiSS-xxxxxxx
- xxxxxxx : 7digit, Hex String
X-KM-Crypto-Key-Id
string
Optional
Length : 32
Data encryption/decryption key ID
- Given ID from creating the service provider's project
- If it is passed as a callback, the first key issued among the keys issued to the service provider is used.
Response Parameters
serviceInfos
array of objects
Required
상품 정보 리스트
serviceInfos_item
object
Optional
serviceId
string
Required
Length : 15
상품 ID
serviceName
string
Required
Min : 1 , Max : 80
상품명
cardType
string
Required
Min : 1 , Max : 6
카드 타입
- CARDSE, MOBILE, COUPON
mobilePreIssueYn
string
Required
Length : 1
모바일 선발급 가능여부
shortDescription
string
Required
Min : 0 , Max : 4000
상품 설명
cardImageUrl
string
Required
Min : 1 , Max : 500
상품 이미지 URL
thumbnailImageUrl
string
Required
Min : 1 , Max : 500
상품 썸네일 이미지 URL
registeredDate
string
Required
Length : 10
상품 등록일
status
string
Required
Min : 1 , Max : 10
상품 상태
- VOID, ACTIVE, SUSPENDED, SOLDOUT, DELETED
chargeCardCost
string
Required
Length : 1
추가카드 비용부과여부
- T: 비용부과상품, ASP 비용부과기준 준수, F: 비용 비부과 상품, A: 무조건 비용부과
chargeCardCostAmt
number
Required
Min : 1 , Max : 99999
추가카드 발급 비용
reissuanceYn
string
Required
Length : 1
재발급 가능여부
issueLimitCount
number
Required
Min : 1 , Max : 99999
상품별 발급횟수 제한 (0은 제한없음)
useLimitCount
number
Required
Min : 1 , Max : 99999
고객별 발급횟수 제한(0은 제한없음)
overseaPaymentYn
string
Required
Length : 1
해외결제가능여부
- Y, N
attributes
string
Required
Min : 1 , Max : 100
추가 속성 필드
- 해당 값에 'CASHBEE' 라는 문자열이 포함되어 있을 경우 교통카드 여부 Y
routeType
string
Required
Min : 6 , Max : 8
실물카드 배송 타입
- POSTAL - 우편 배송
- PERSONAL - 인편 배송
productDetailInfo
array of objects
Required
상품상세정보
productDetailInfo_item
object
Optional
title
string
Optional
Min : 1 , Max : 255
상품 상세 정보 제목
content
string
Optional
Min : 1 , Max : 255
상품상세정보 내용
Response Code
Detailed classification and addition of error for unseccessful withfrawal
200
Error code
000_000
Message
Success.
Description
성공
400
Error code
000_003
Message
Missing required values. serviceIdList
Description
입력 파라미터 오류 - `serviceIdList` 입력 요청 정보가 null 인 경우
Test Data
Request
Response
Click Try It!
to start a Request and see the Response here!