Konaplate logo

API 문서

전체 API

서비스


실물카드와 연결 가능한 모바일카드 신청 정보 조회동기

버전: v1


버전: v1

POST

/api/v1/issued-cards/pre-issue/waiting/physical

(회원) 실물카드를 등록하기 전에 카드와 연결할 수 있는 (선발급 카드) 모바일 카드 정보를 조회 할 수 있습니다. 실물카드의 신청 및 재발급 신청 시 선발급된 모바일카드 정보를 확인 할 수 있습니다. 응답 값 "cardApplyNo"는 실물카드 등록 시 입력 값으로 사용됩니다. 선발급 속성의 선불카드 신청이란? (신규) 회원이 선발급 속성의 선불카드를 신청하는 경우 : 신청 시 모바일카드가 먼저 발급되고 실물카드가 배송됩니다. (재발급) 재발급되는 카드가 선발급 속성의 선불카드이 경우 : 재발급 신청 시 모바일카드가 먼저 발급되고, 잔액이 새로 발급된 모바일카드로 이관되며 실물카드가 배송됩니다. 모바일 카드는 실물카드 없이 사용 가능한 모바일 전용 카드를 말하여, 사용자는 실물카드 수령 후 모바일카드와 연결할 수 있습니다.

요청 헤더


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

필수

길이 : 14

클라이언트 요청 시간

  • 형식 : YYYYMMDDHHMMSS

X-KM-Time-Zone

string

필수

길이 : 3

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

요청 파라미터

암호화 처리|
더 자세한 정보는
가이드라인
을 참조하세요.

userId

number

필수

최소 : 1 , 최대 : 9999999999999999999

실물카드를 등록하려는 회원 ID

- 회원가입 시 부여되는 회원의 고유 ID입니다.

physicalCardNo

string

필수

길이 : 16

등록하려는 (실물카드) 카드 번호

physicalCardExpDate

string

필수

길이 : 4

등록하려는 (실물카드) 카드 사용 유효기간

- 형식 : YYMM

physicalCardCVC

string

필수

길이 : 3

등록하려는 (실물카드) 카드 인증 코드

응답 헤더


X-KM-Correlation-Id

string

필수

길이 : 20

전문 추적을 위한 거래번호

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

X-KM-Crypto-Key-Id

string

옵션

길이 : 32

데이터암복호화 키 ID

  • 서비스 사업자의 프로젝트에서 생성 시 부여한 ID입니다
  • Callback으로 전달될 경우 서비스 사업자에게 발급된 키 중 가장 먼저 발급된 키를 사용 합니다.

응답 파라미터

암호화 처리|
더 자세한 정보는
가이드라인
을 참조하세요.

issuedCardList

array of objects

필수

모바일카드 신청 정보 목록

issuedCardList_item

object

옵션

issuedCardList_item content

cardApplyNo

string

필수

길이 : 22

카드 신청 번호

- (회원) 모바일 카드 또는 실물 카드를 발급/배송 신청할때 생성되는 고유 번호

실물카드 등록 시 입력 값으로 사용됩니다.

issueType

string

필수

최소 : 1 , 최대 : 7

카드 신청 타입

- ISSUE : (신규) 회원이 카드를 신규 신청한 경우 입니다.
- REISSUE : (재발급) 회원이 기존의 카드를 분실 신고하여 발급 받을 경우 입니다.

digital

object

필수

모바일카드 정보


cardNo

string

필수

길이 : 16

(모바일카드) 카드 번호

par

string

필수

길이 : 27

PAR

- 카드의 PAN(Primary Account Number)을 대체하는 번호

serviceId

string

필수

최소 : 1 , 최대 : 15

(모바일카드) 카드 상품 ID

- 카드 상품에 부여한 고유 식별 값입니다.

serviceName

string

필수

최소 : 1 , 최대 : 255

(모바일카드) 카드 상품명

mobileCardCVC

string

필수

길이 : 3

(모바일카드) 카드 인증 코드

- Card Verification Code

status

string

필수

최소 : 1 , 최대 : 15

카드 신청 상태

- READY : 신청 진행 중
- COST_PAYING : 비용 부과 진행 중
- COST_PAID : 비용 부과 완료
- COST_PAY_FAILED : (신청 종료) 비용 부과 실패
- DIGITAL_ISSUED : 모바일 발급 완료
- PHYSICAL_ISSUED : 실물 카드 발급 완료
- SHIPPING : 배송 진행 중
- CANCEL : (신청 종료) 신청 취소
- ISSUE_FAILED : (신청 종료) 신청 실패
- RETURNED : (신청 종료) 반송된 카드
- COMPLETE : (신청 종료) 신청 완료 및 실물 카드 등록 완료

values

object

필수

카드의 잔액 및 포인트 정보


balance

number

필수

최소 : 0 , 최대 : 9999999999

(모바일카드) 잔액

points

array of objects

옵션

(모바일카드) 포인트 정보

points_item

object

옵션

points_item content

policyType

string

옵션

길이 : 2

(모바일카드) 포인트 정책 타입

- 00 : 유저포인트
- 01 : 정책수당
- 02 : 인센티브
- 03 : 복지포인트(급여성)
- 04 : 복지포인트(경비성)
- 05 : 제휴
- 06 : 법인포인트
- 07 : 기부포인트(수혜자 제공용)

policyId

string

옵션

최소 : 1 , 최대 : 15

(모바일카드) 포인트 정책 아이디

policyName

string

옵션

최소 : 1 , 최대 : 255

(모바일카드) 포인트 정책 명

amount

number

옵션

최소 : 0 , 최대 : 9999999999

(모바일카드) 보유 포인트 금액

requester

string

필수

최소 : 1 , 최대 : 3

카드 신청 유입 채널 정보

- APP : App에서 신청
- CC : 고객센터를 통한 신청

응답 코드

Detailed classification and addition of error for unseccessful withfrawal


200

에러 코드

000_000

메시지

Success.

설명

성공


400

에러 코드

000_002

메시지

Invalid input parameter.

설명

입력 파라미터 오류입니다.


400

에러 코드

001_006

메시지

Wallet user not found.

설명

회원이 아니거나 탈퇴한 회원입니다.


400

에러 코드

003_011

메시지

Invalid card info.

설명

입력한 카드정보(카드번호, 만료일, CVC)가 유효하지 않습니다.


400

에러 코드

003_049

메시지

Not found issued cards.

설명

발급된 카드를 찾을 수 없음.

테스트 데이터

200 - 성공 테스트


200 - 성공 테스트
200 - 성공 테스트 - 조회 안됨
400 - 입력 파라미터 오류입니다.
400 - 회원이 아니거나 탈퇴한 회원입니다.
400 - 입력한 카드정보(카드번호, 만료일, CVC)가 유효하지 않습니다.
400 - 발급된 카드를 찾을 수 없음.
Loading ...

Request

Loading...

Response

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


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