주카드 정보 조회

API Description

Doc. No. A3S8D15V1
API Title 카드관리 > 주카드 정보 조회
API Description 회원의 주(main)카드 정보를 아래와 같이 제공합니다.
- 카드 상품 정보
- 카드 번호
- 유효 기간
- 카드 상태
- 잔액 정보
Protocol HTTP Interface Type SYNC
HTTP METHOD POST Request URL /api/v1/card/favorite/inquiry
Data Encryption Request : YES / Response : YES

Request Parameter

Field Type Length MOC Description
userId NUMBER 1~999999999999 MANDATORY 회원 ID
- 회원가입 시 부여되는 회원의 고유 ID입니다.

Response Parameter

Field Type Length MOC Description
cardDataInfo OBJECT MANDATORY 카드 정보
└ par STRING 27 MANDATORY 카드의 PAN(Primary Account Number)을 대체하는 번호
└ serviceId STRING 15 MANDATORY 카드 상품 ID
- 카드 상품에 부여한 고유 식별 값입니다.
└ balance NUMBER 0~999999999999 MANDATORY 카드에 충전되어 있는 잔액 정보
└ expiryDate STRING 8 MANDATORY 카드 사용 유효기간
- 형식 : yyMM
└ cardNo STRING 16 MANDATORY (실물카드) 카드 번호
└ cardStatus STRING 1~7 MANDATORY (실물카드) 카드의 상태
- ACTIVE : 정상
- SUSPENDED : 중지
└ maxNonRealNameRechargeAmount NUMBER 0~999999999999 MANDATORY 무기명 카드에 충전할 수 있는 최대 금액
- 대기금 허용 상품의 경우, 대기금 충전 한도 금액
└ maxRealNameRechargeAmount NUMBER 0~999999999999 MANDATORY 기명화된 카드에 충전할 수 있는 최대 금액
- 대기금 허용 상품의 경우, 대기금 충전 한도 금액
└ isNamed BOOLEAN MANDATORY 카드 기명화 여부
- 기명화란? 무기명으로 발행된 카드를 선불전자지급수단을 법에서 정하는 '실지명의 인증' 또는 '예금계좌와 연결하는 방식'을 통하여 해당 선불전자지급수단의 이용자로 특정하는 행위를 말합니다.
└ rechargeableAmount NUMBER 0~999999999999 MANDATORY 카드에 충전 가능한 금액
- 무기명 카드의 경우 = 무기명카드 최대 충전금액(maxNonRealNameRechargeAmount) - 카드잔액(balance)
- 기명화된 카드의 경우 = 기명화카드 최대 충전금액(maxRealNameRechargeAmount) - 카드잔액(balance)

충전 가능 금액(예)
- maxNonRealNameRechargeAmount = 500000
- maxRealNameRechargeAmount = 2000000
- balance = 300000
무기명 카드인 경우 = 200000(500000 - 300000)
기명화된 카드인 경우 = 1700000(2000000 - 300000)
└ ownerKaId STRING 15 OPTIONAL 상품의 OwnerKA ID
response OBJECT MANDATORY 응답 결과 값
└ code STRING 1~7 MANDATORY 응답 결과 코드
└ description STRING 1~255 MANDATORY 응답 결과 상세 설명

Response Code

HTTP Status Error code Message Description
프로토콜 항목의 "공통 Error Message 정보"에서 추가 확인 바랍니다.
400 001_006 Wallet user not found. 회원이 아니거나 탈퇴한 회원입니다.

Example

Request


            

Response