Konaplate logo

API 문서

전체 API

서비스


직불카드 발급 및 배송 신청동기

버전: v1


버전: v1

POST

/api/v1/direct-card/issue/delivery

회원이 선택한 직불카드를 발급하고 배송을 원할 경우 신청된 주소로 배송을 처리합니다.

요청 헤더


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, ...)

요청 파라미터

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

userInfo

object

필수

회원 정보

userId

number

필수

최소 : 1 , 최대 : 9999999999999999999

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

userName

string

필수

최소 : 1 , 최대 : 100

회원 이름

engName

string

필수

최소 : 1 , 최대 : 100

(회원) 영문 이름

socialNo

string

필수

최소 : 1 , 최대 : 20

(회원) 주민등록번호
해당 정보는 현금IC 발급에 사용됩니다.

mobileNumber

string

필수

최소 : 1 , 최대 : 20

회원 휴대 전화번호

existOcrFile

string

필수

길이 : 1

OCR 파일 확인 유무
- Y : 확인함
- N : 확인하지 않음

addressInfo

object

필수

배송지 정보

address

string

필수

최소 : 1 , 최대 : 255

카드 배송지 도로명 주소

addressDetail

string

필수

최소 : 1 , 최대 : 255

카드 배송지 도로명 상세주소

zipCode

string

필수

길이 : 5

카드 배송지 우편번호

cardInfo

object

필수

카드 정보

serviceId

string

필수

길이 : 15

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

enableFIC

boolean

필수

true


true

false

현금IC 포함 여부
- true : 포함
- false : 미포함

csn

string

조건부

최소 : 1 , 최대 : 256

CSN
- Card chip Serial Number
- 현금IC 일련번호로 사용됩니다.
- 현금IC 발급데이터
- 조건 필드 : "enableFIC"가 "true" 값일 경우 설정

pin

string

조건부

최소 : 1 , 최대 : 256

PIN
- 현금IC 발급데이터
- 조건 필드 : "enableFIC"가 "true" 값일 경우 설정

expiryDate

string

조건부

길이 : 8

현금IC 만료일
- 현금IC 발급데이터
- 형식 : yyyyMMdd
- 조건 필드 : "enableFIC"가 "true" 값일 경우 설정

bankCode

string

조건부

길이 : 3

은행 코드

Bank name Code   Bank name Code
신한은행 088 KB국민은행 004
우리은행 020 하나은행 081
IBK기업은행 003 산업은행 002
NH농협은행 011 지역농축협 012
SC은행 023 카카오뱅크 090
우체국 071 새마을금고 045
수협은행 007 신협 048
부산은행 032 경남은행 039
광주은행 034 전북은행 037
제주은행 035 대구은행 031
산림조합 064 케이뱅크 089
저축은행 050 토스뱅크 092
씨티은행 027 삼성증권 240
한화투자 269 신한투자 278
교보증권 261    

 

 

- 현금IC 발급데이터
- 조건 필드 : "enableFIC"가 "true" 값일 경우 설정

accountNoStartIndex

number

조건부

최소 : 1 , 최대 : 9999999999

계좌 시작 위치
- 현금IC 발급데이터
- Track3 데이터의 주계좌번호 내 계좌 번호의 첫 번째 자리가 기준 위치 입니다.
- 조건 필드 : "enableFIC"가 "true" 값일 경우 설정

accountNoSize

number

조건부

최소 : 1 , 최대 : 9999999999

계좌 길이
- 현금IC 발급데이터
- Track3 데이터 내의 계좌 번호 길이
- 조건 필드 : "enableFIC"가 "true" 값일 경우 설정

track3

string

조건부

최소 : 1 , 최대 : 1024

Track3 데이터
- 현금IC 발급데이터
- 형식 : 108 길이(54byte)의 텍스트
- 조건 필드 : "enableFIC"가 "true" 값일 경우 설정

bankInfo

object

필수

은행 정보

bankName

string

필수

최소 : 1 , 최대 : 10

은행 이름

bankAccount

string

필수

최소 : 1 , 최대 : 20

은행 계좌번호

limits

object

필수

결제 한도 정보

once

number

필수

최소 : 1 , 최대 : 9999999999

1회 한도

day

number

필수

최소 : 1 , 최대 : 9999999999

일일 한도

month

number

필수

최소 : 1 , 최대 : 9999999999

월간 한도

응답 헤더


X-KM-Correlation-Id

string

필수

길이 : 20

전문 추적을 위한 거래번호

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

X-KM-Crypto-Key-Id

string

옵션

길이 : 32

데이터암복호화 키 ID

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

응답 파라미터

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

cardApplyNo

string

필수

길이 : 22

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

mobileCardNo

string

옵션

길이 : 16

(모바일카드) 카드 번호

mobileCardCVC

string

옵션

길이 : 3

(모바일카드) 카드 인증 코드
- Card Verification Code

physicalCardNo

string

필수

길이 : 16

(실물카드) 카드 번호

expiryDate

string

필수

길이 : 8

카드 사용 유효기간

응답 코드

Detailed classification and addition of error for unseccessful withfrawal


200

에러 코드

000_000

메시지

Success.

설명

성공


200

에러 코드

000_000

메시지

Success.

설명

성공 테스트_현금IC 미포함


400

에러 코드

000_002

메시지

Invalid input parameter. userId

설명

    입력 파라미터 오류입니다


400

에러 코드

001_006

메시지

Wallet user not found.

설명

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


400

에러 코드

003_060

메시지

Service is not related to the request bank.

설명

신청한 카드 상품이 신청한 금융사 상품이 아닌 경우.


400

에러 코드

003_061

메시지

Not valid card issue type with the service.

설명

신청한 카드 상품의 타입이 유효하지 않을 경우


400

에러 코드

003_062

메시지

Service does not support the applet.

설명

신청한 카드 상품의 타입이 유효하지 않을 경우.


400

에러 코드

003_063

메시지

User authentication error.

설명

입력한 주민등록번호로 본인 인증을 실패한 경우.


400

에러 코드

003_064

메시지

Download digital card error.

설명

모바일 카드 발급 실패


400

에러 코드

003_065

메시지

Service is not digital pre-issue type.

설명

신청한 카드 상품이 모바일 선발급 타입이 아닌 경우

전체 보기

테스트 데이터

200 - 성공 테스트


200 - 성공 테스트
200 - 성공 테스트_현금IC 미포함
400 - 입력 파라미터 오류입니다
400 - 회원이 아니거나 탈퇴한 회원입니다.
400 - 신청한 카드 상품이 신청한 금융사 상품이 아닌 경우.
400 - 신청한 카드 상품의 타입이 유효하지 않을 경우.
400 - 신청한 카드 상품의 타입이 유효하지 않을 경우.
400 - 입력한 주민등록번호로 본인 인증을 실패한 경우.
400 - 모바일 카드 발급 실패
400 - 신청한 카드 상품이 모바일 선발급 타입이 아닌 경우
400 - 신청한 카드 상품이 Sibling 상품을 갖고 있지 않을 경우
Loading ...

Request

Loading...

Response

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


회원 가입회원 정보 조회회원 비밀번호 재설정 및 변경회원 정보 변경회원 탈퇴회원 로그인 ID 확인휴면 회원 해제약관 목록 조회약관 동의 및 철회CI 값으로 회원 정보 조회회원 로그인 ID 중복 확인회원 비밀번호 검증회원 인증 정보 조회금융사 목록 조회계좌 예금주 실명 검증ARS 인증 전 인증코드 생성PG를 통한 은행 계좌 등록계좌 등록 상태 조회기명화 및 한도상향(개인)회원 등록 계좌 조회회원 계좌 정보 조회자동충전 계좌 등록회원 계좌 삭제계좌 1원 인증 요청계좌 1원 인증 코드 검증선불카드 발급 및 배송 신청카드 신청 취소선불카드 재발급(교체발급)만료 예정 선불카드 재발급 갱신카드 배송 상태 조회실물카드와 연결 가능한 모바일카드 신청 정보 조회실물카드 등록보유카드 조회미등록 카드 조회카드 상태 변경카드 폐기기명화 및 한도상향(개인)기명화 및 한도상향(법인)법인 기명화 여부 조회소득공제 신청카드 소득공제 신청 여부 조회카드 매핑 회원 조회카드 상품ID로 상품 정보 조회주카드 설정카드에 연결된 가상계좌 조회직불카드 발급 및 배송 신청카드 신청 취소카드 배송 상태 조회실물카드 등록보유카드 조회카드 상태 변경카드 한도 변경카드 폐기소득공제 신청카드 소득공제 신청 여부 조회주카드 설정일회용 토큰 발급계좌 충전계좌 충전취소충전 및 충전취소 결과 확인거래내역 확인기준 하한 및 월정액 자동 충전 활성화기준 하한 자동 충전 등록기준 하한 및 월정액 자동 충전 목록 조회기준 하한 자동 충전 수정월 정액 자동 충전 등록월 정액 자동 충전 수정기준 하한 및 월정액 자동 충전 등록 해제결제 시 자동 충전 등록결제 시 자동 충전 등록 해제결제 시 자동 충전 목록 조회일회용 토큰 발급환불 수수료 조회환불환불 결과 확인시스템 충전(예치금)시스템 충전 취소(예치금)시스템 환불(예치금)시스템 부분환불(예치금)신용카드 충전 거래 생성신용카드 충전 취소 요청편의점 충전/출금 요청예치금 내역 조회예치금 잔액 조회일회용 토큰 발급결제결제취소결제 망취소거래내역 확인포인트 거래내역 확인보유카드 조회포인트 사용예약 및 취소포인트 거래내역 확인관리자 포인트 지급관리자 포인트 환수스탬프카드 적립이력조회보유 스탬프카드 목록 조회보유 마일리지카드 목록 조회마일리지카드 적립이력조회카드로 송금 전송카드로 송금 수신카드로 송금 거절카드로 송금 취소ATM 출금용 일회용 Token 발급ATM 출금 예약ATM 출금 예약 취소ATM 출금 정보 조회선불카드 선물하기선불카드 선물하기 취소선불카드 선물하기 유효성 검증선불카드 선물하기 수락선불카드 선물하기 거절받은 카드/쿠폰 선물 목록 조회보낸 카드/쿠폰 선물 목록 조회카드 선물 수락 V2카드 선물하기 V2카드 잔액 이관잔액 이관 카드 정보 조회현금영수증 발행 요청현금영수증 발행 취소현금영수증 국세청 승인오류 요청현금영수증 식별 정보 등록현금영수증 식별 정보 조회현금영수증 식별 정보 삭제현금영수증 가맹점 등록현금영수증 가맹점 수정가맹점 그룹 생성가맹점 그룹 수정가맹점 그룹 조회가맹점 정보 조회가맹점 그룹 내 가맹점 추가가맹점 그룹 내 가맹점 삭제신용카드 자동충전 설정(기준 하한)신용카드 자동충전 설정(월정액)신용카드 자동충전 활성화신용카드 자동충전 목록 조회신용카드 자동충전 설정 해제신용카드 자동 충전 설정 변경카드 상품 전체 조회 (관리자용)카드 상품 상세 조회 (관리자용)발급 카드 목록 조회 (관리자용)카드 상품 생성 API (관리자용)카드 선물 내역 조회 (관리자용)