회원의 CI값과 가맹점ID 정보로 결제 가능한 회원의 보유 카드 목록 조회

API Description

Doc. No. A3S13V1
API Title 카드관리 > 회원의 CI값과 가맹점ID 정보로 결제 가능한 회원의 보유 카드 목록 조회
API Description CI로 회원을 특정하여 회원이 보유한 카드 중, 입력 받은 가맹점에서 결제 가능한 카드 리스트를 조회하는 API 입니다.
회원이 보유한 카드의 목록과 카드 정보를 아래와 같이 제공합니다.
- 카드 상품 정보
- 잔액 정보
- 유효 기간
- 카드 상태
- 카드 번호
- 결제 한도
- 포인트
- 연결 계좌(직불카드인 경우)
Protocol HTTP Interface Type SYNC
HTTP METHOD POST Request URL /api/v1/user/card/list/by-merchant
Data Encryption Request : YES / Response : YES

Request Parameter

Field Type Length MOC Description
ci STRING 88 MANDATORY CI
- Connection Information
- 서비스 중복 가입 또는 외부 서비스 연계 시 개인을 식별하기 위한 정보로서 통신사 본인인증 등을 통해 얻을 수 있습니다.
- 외부 서비스와의 연동이 필요 없는 서비스 사업자의 경우에는 별도의 개인을 식별 값을 부여하여 사용 가능 합니다.
merchantId STRING 15 MANDATORY 결제요청하는 가맹점ID
affiliateId STRING 15 OPTIONAL 같은 ASP 내에서 제휴사를 구별하기 위한 값

Response Parameter

Field Type Length MOC Description
cardDataInfo ARRAY MANDATORY 카드 정보 목록
par STRING 27 MANDATORY 카드의 PAN(Primary Account Number)을 대체하는 번호
serviceId STRING 15 MANDATORY 카드 상품 ID
- 카드 상품에 부여한 고유 식별 값입니다.
serviceName STRING 1~255 MANDATORY 카드 상품명
serviceImageUrl STRING 1~255 MANDATORY 카드 상품의 이미지 파일 URL
affiliateId STRING 15 MANDATORY 같은 ASP 내에서 제휴사를 구별하기 위한 값
rechargeable BOOLEAN MANDATORY 카드의 충전 가능 여부
아래 항목의 충전 가능여부를 설정합니다.
- OFFLINE 단말기 충전
- 개인계좌 충전
- 포탈을 통한 ADMIN 충전
refundable BOOLEAN MANDATORY 카드의 환불 가능 여부
remittable BOOLEAN MANDATORY 카드의 송금 가능 여부
아래 항목에 대한 잔액 송금 가능 여부를 설정합니다.
- 휴대 전화번호로 송금
- 카드번호로 송금
personalRechargeable BOOLEAN MANDATORY 카드의 개인계좌를 통한 충전 가능 여부
autoReloadStatus STRING 1~8 OPTIONAL 카드의 자동충전 상태
- ACTIVE : 활성화
- INACTIVE : 비활성화
- NONE : 설정 안함
balance NUMBER 0~999999999999 MANDATORY 카드에 충전되어 있는 잔액 정보
pendingAmount NUMBER 0~999999999999 MANDATORY 충전 대기금 금액
- 카드의 한도를 초과하는 충전 요청이 접수되어, 아직 처리되지 않고 충전 대기 중인 금액.
expiryDate STRING 8 MANDATORY 카드 사용 유효기간
- 형식 : yyyyMMdd
physicalCardNo STRING 16 OPTIONAL (실물카드) 카드 번호
physicalCardStatus STRING 1~7 OPTIONAL (실물카드) 카드의 상태
- ACTIVE : 정상
- SUSPENDED : 중지
mobileExpiryDate STRING 8 MANDATORY (모바일카드) 카드 사용 유효기간
- 형식 : yyyyMMdd
mobileCardNo STRING 16 OPTIONAL (모바일카드) 카드 번호
mobileCardStatus STRING 1~7 OPTIONAL (모바일카드) 카드의 상태
- ACTIVE : 정상
- SUSPENDED : 중지
mobileCardCvc STRING 3 OPTIONAL (모바일카드) 카드 인증 코드
- Card Verification Code
maxNonRealNameRechargeAmount NUMBER 0~999999999999 MANDATORY 무기명 카드에 충전할 수 있는 최대 금액
maxRealNameRechargeAmount NUMBER 0~999999999999 MANDATORY 기명화된 카드에 충전할 수 있는 최대 금액
minRechargeAmount NUMBER 0~999999999999 MANDATORY 카드에 충전 시 최소 충전금액
rechargeableAmount NUMBER 0~999999999999 MANDATORY 카드에 충전 가능한 금액
- 무기명 카드의 경우 = 무기명카드 최대 충전금액(maxNonRealNameRechargeAmount) - 카드잔액(balance)
- 기명화된 카드의 경우 = 기명화카드 최대 충전금액(maxRealNameRechargeAmount) - 카드잔액(balance)

충전 가능 금액(예)
- maxNonRealNameRechargeAmount = 500000
- maxRealNameRechargeAmount = 2000000
- balance = 300000
무기명 카드인 경우 = 200000(500000 - 300000)
기명화된 카드인 경우 = 1700000(2000000 - 300000)
cardApplyNo STRING 22 OPTIONAL 카드 신청 번호
- (회원) 모바일 카드 또는 실물 카드를 발급/배송 신청할 때 생성되는 고유 번호
limits OBJECT OPTIONAL 결제 한도 정보
직불카드인 경우에만 응답데이터에 포함됩니다.
once NUMBER 0~999999999999 OPTIONAL 1회 결제 한도
day NUMBER 0~999999999999 OPTIONAL 일 결제 한도
month NUMBER 0~999999999999 OPTIONAL 월 결제 한도
enableFIC BOOLEAN MANDATORY 현금IC 포함 여부
- true : 현금IC 포함
- false : 현금IC 미포함
직불카드인 경우에만 응답데이터에 포함됩니다.
bankInfo OBJECT OPTIONAL 직불카드에 연결된 계좌 정보
직불카드인 경우에만 응답데이터에 포함됩니다.
bankName STRING 1~10 MANDATORY 은행 이름
bankAccount STRING 1~20 MANDATORY 은행 계좌 번호
cardPointInfo ARRAY MANDATORY 카드 포인트 정보
pointPolicyId STRING 15 MANDATORY 포인트 정책 ID
pointName STRING 1~255 MANDATORY 포인트 정책명
remainingPoint NUMBER 0~999999999999 OPTIONAL (회원) 포인트 잔액
- 회원이 가지고 있는 포인트의 잔액
autoUse BOOLEAN MANDATORY 포인트 자동사용 여부
- 포인트 정책에 설정된 값
customAutoUse BOOLEAN MANDATORY 수동 설정 포인트 자동사용 여부
- 사용자가 수동 설정한 값
- autoUse 보다 우선 시 적용됨
policyType STRING 2 OPTIONAL 카드 포인트 정책 타입
- 00: 유저(사용자)
- 01 : 정책수당
- 02 : 인센티브
- 03 : 복지(급여성)
- 04 : 복지(경비성)
- 05 : 제휴
- 06 : 법인
- 07 : 기부
- 99 : 잔액
- null : 알 수 없음
isNamed BOOLEAN MANDATORY 카드 기명화 여부
- 기명화란? 무기명으로 발행된 카드를 선불전자지급수단을 법에서 정하는 '실지명의 인증' 또는 '예금계좌와 연결하는 방식'을 통하여 해당 선불전자지급수단의 이용자로 특정하는 행위를 말합니다.
rechargeUnitAmt NUMBER 0~999999999999 OPTIONAL 충전 단위 설정
uiccInfo OBJECT OPTIONAL UICC 카드 정보
uiccToken STRING 16 MANDATORY UICC 카드번호
cardBizStatus STRING 2 MANDATORY 카드 상태 코드
- 31: 카드 분실로 인한 정지 
- 36: 카드 수령 전 정지
- 3A: 카드 재발급으로 인한 중지
- 60: 정상
- 61: 카드 분실 신고 해지
- 35: 카드 유효 기간 만료로 인한 중지
cardLifeStatus STRING 2 MANDATORY 카드 원장 상태 코드
- 30 : 정지
- 60 : 정상
- 90 : 폐기
isFavoriteCard BOOLEAN MANDATORY 주 카드 설정 여부
accTransferStatus STRING 1 MANDATORY 모든 이체 진행상태 (충전취소, 환불이체 진행 상태)
- 0 : 해당 없음
- 1 : 이체 진행중
enableVirtualAccountPendingAmount BOOLEAN MANDATORY 가상계좌 충전 대기금 사용 여부
virtualAccountMaxPendingAmount NUMBER 0~999999999999 MANDATORY 가상계좌 충전 대기금 최대 금액
- 카드 잔액 + 충전 대기금 잔액의 최대 허용 금액
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. 회원이 아니거나 탈퇴한 회원입니다.
400 018_002 No available payment cards found. 해당 가맹점에서 결제 가능한 카드를 찾을 수 없습니다.

Example

Request


            

Response