Konaplate logo

API 문서

전체 API

서비스


카드 상품ID로 상품 정보 조회동기

버전: v1


버전: v1

POST

/api/v1/service/info/list

카드 상품 ID로 카드 상품명 등의 상품의 정보를 조회할 수 있는 API입니다.

요청 헤더


X-KM-User-AspId

string

필수

길이 : 15

ASP ID

  • 서비스 사업자에게 부여한 ID입니다.
  • ID는 계약 시 제공됩니다.

X-KM-Correlation-Id

string

필수

길이 : 20

전문 추적을 위한 거래번호

  • 형식 : yyMMddHHmiSS-xxxxxxx
  • xxxxxxx : 7자리, Hex String

X-KM-Access-Key

string

조건부

길이 : 40

프로젝트에서 생성된 Access Key

  • Callback API 인 경우는 제외합니다.

X-KM-Crypto-Key-Id

string

옵션

길이 : 32

데이터암복호화 키 ID

  • 서비스 사업자의 프로젝트에서 생성 시 부여한 ID입니다
  • 데이터 암호화 요청 시 필수 입력값입니다. (Data Encryption = Y)

X-KM-Tran-Token

string

필수

길이 : 66

공통 Header 정보 - X-KM-Tran-Token

X-KM-Tran-Time

string

필수

길이 : 16

클라이언트 요청 시간

  • 형식 : YYYYMMDDHH24MISS

X-KM-Time-Zone

string

필수

길이 : 3

시간대 정보 (UTC, KST, ...)

요청 파라미터


serviceIdList

array of strings

필수

카드 상품 ID 목록

추가 string

응답 헤더


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

옵션

serviceInfos_item content

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

옵션

productDetailInfo_item content

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 인 경우

테스트 데이터

200 - 성공 테스트


200 - 성공 테스트
400 - 입력 파라미터 오류 - `serviceIdList` 입력 요청 정보가 null 인 경우
Loading ...

Request

Loading...

Response

Try It!을 클릭하여
입력한 Request의 Response를 확인하세요.


회원 가입회원 정보 조회회원 비밀번호 재설정 및 변경회원 정보 변경회원 탈퇴회원 로그인 ID 확인휴면 회원 해제약관 목록 조회약관 동의 및 철회CI 값으로 회원 정보 조회회원 로그인 ID 중복 확인회원 비밀번호 검증회원 인증 정보 조회금융사 목록 조회계좌 예금주 실명 검증ARS 인증 전 인증코드 생성PG를 통한 은행 계좌 등록계좌 등록 상태 조회기명화 및 한도상향(개인)회원 등록 계좌 조회회원 계좌 정보 조회자동충전 계좌 등록회원 계좌 삭제일회용 토큰 발급계좌 충전계좌 충전취소충전 및 충전취소 결과 확인거래내역 확인선불카드 발급 및 배송 신청카드 신청 취소선불카드 재발급(교체발급)만료 예정 선불카드 재발급 갱신카드 배송 상태 조회실물카드와 연결 가능한 모바일카드 신청 정보 조회실물카드 등록보유카드 조회미등록 카드 조회카드 상태 변경카드 폐기기명화 및 한도상향(개인)기명화 및 한도상향(법인)법인 기명화 여부 조회소득공제 신청카드 소득공제 신청 여부 조회카드 매핑 회원 조회카드 상품ID로 상품 정보 조회주카드 설정카드에 연결된 가상계좌 조회회원 가입회원 정보 조회회원 비밀번호 재설정 및 변경회원 정보 변경회원 탈퇴회원 로그인 ID 확인휴면 회원 해제약관 목록 조회약관 동의 및 철회CI 값으로 회원 정보 조회회원 로그인 ID 중복 확인회원 비밀번호 검증회원 인증 정보 조회금융사 목록 조회계좌 예금주 실명 검증ARS 인증 전 인증코드 생성PG를 통한 은행 계좌 등록계좌 등록 상태 조회기명화 및 한도상향(개인)회원 등록 계좌 조회회원 계좌 정보 조회자동충전 계좌 등록회원 계좌 삭제