API 문서
전체 API
서비스
카드 상품ID로 상품 정보 조회동기
버전: v1
버전: v1
/api/v1/service/info/list
요청 헤더
요청 파라미터
응답 헤더
X-KM-Correlation-Id
string
필수
길이 : 20
전문 추적을 위한 거래번호
- 형식 : yyMMddHHmiSS-xxxxxxx
- xxxxxxx : 7자리, Hex String
X-KM-Crypto-Key-Id
string
옵션
길이 : 32
데이터암복호화 키 ID
- 서비스 사업자의 프로젝트에서 생성 시 부여한 ID입니다
- Callback으로 전달될 경우 서비스 사업자에게 발급된 키 중 가장 먼저 발급된 키를 사용 합니다.
응답 파라미터
serviceInfos
array of objects
필수
상품 정보 리스트
serviceInfos_item
object
옵션
serviceId
string
필수
길이 : 15
상품 ID
serviceName
string
필수
최소 : 1 , 최대 : 80
상품명
cardType
string
필수
최소 : 1 , 최대 : 6
카드 타입
- CARDSE, MOBILE, COUPON
mobilePreIssueYn
string
필수
길이 : 1
모바일 선발급 가능여부
shortDescription
string
필수
최소 : 0 , 최대 : 4000
상품 설명
cardImageUrl
string
필수
최소 : 1 , 최대 : 500
상품 이미지 URL
thumbnailImageUrl
string
필수
최소 : 1 , 최대 : 500
상품 썸네일 이미지 URL
registeredDate
string
필수
길이 : 10
상품 등록일
status
string
필수
최소 : 1 , 최대 : 10
상품 상태
- VOID, ACTIVE, SUSPENDED, SOLDOUT, DELETED
chargeCardCost
string
필수
길이 : 1
추가카드 비용부과여부
- T: 비용부과상품, ASP 비용부과기준 준수, F: 비용 비부과 상품, A: 무조건 비용부과
chargeCardCostAmt
number
필수
최소 : 1 , 최대 : 99999
추가카드 발급 비용
reissuanceYn
string
필수
길이 : 1
재발급 가능여부
issueLimitCount
number
필수
최소 : 1 , 최대 : 99999
상품별 발급횟수 제한 (0은 제한없음)
useLimitCount
number
필수
최소 : 1 , 최대 : 99999
고객별 발급횟수 제한(0은 제한없음)
overseaPaymentYn
string
필수
길이 : 1
해외결제가능여부
- Y, N
attributes
string
필수
최소 : 1 , 최대 : 100
추가 속성 필드
- 해당 값에 'CASHBEE' 라는 문자열이 포함되어 있을 경우 교통카드 여부 Y
routeType
string
필수
최소 : 6 , 최대 : 8
실물카드 배송 타입
- POSTAL - 우편 배송
- PERSONAL - 인편 배송
productDetailInfo
array of objects
필수
상품상세정보
productDetailInfo_item
object
옵션
title
string
옵션
최소 : 1 , 최대 : 255
상품 상세 정보 제목
content
string
옵션
최소 : 1 , 최대 : 255
상품상세정보 내용
응답 코드
Detailed classification and addition of error for unseccessful withfrawal
200
에러 코드
000_000
메시지
Success.
설명
성공
400
에러 코드
000_003
메시지
Missing required values. serviceIdList
설명
입력 파라미터 오류 - `serviceIdList` 입력 요청 정보가 null 인 경우
테스트 데이터
Request
Response
Try It!을 클릭하여
입력한 Request의 Response를 확인하세요.
