New Payment Platform, KONA PLATE

API Documentation

All API

Service

User Information Management
User Account Management
Bank account verification
Pre-paid Card Management
Debit Card Management
Recharge
계좌 자동 충전
Refund
Deposit recharging
Deposit Refund
신용카드 충전
편의점 충전/출금
Deposit Management
Payment
Transaction History
Point Management
Stamp Management
Mileage Management
Transfer : Card to Card
ATM withdrawal
선불카드 선물하기
Transfer of money
현금영수증
Merchants Management
신용카드 자동충전
관리자 페이지용 기능

Application for Issuance and Delivery of Debit CardSync

Version: v1

POST

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

If a member wants to select, issue and receive a debit card, delivery is processed to the requested address.

Request Headers

X-KM-User-AspId

string

Required

Length : 15

ASP ID

ID given to the service provider.
The ID is provided at the time of contract.

X-KM-Correlation-Id

string

Required

Length : 20

Transaction number for tracking trasncription

Form : yyMMddHHmiSS-xxxxxxx
xxxxxxx : 7digit, Hex String

X-KM-Access-Key

string

Conditional

Length : 40

Access Key created by Project

Excluding the case for Callback API

X-KM-Crypto-Key-Id

string

Optional

Length : 32

Data Encryption/Decryption Key ID

Given ID from creating the service provider's project
Required value when requesting data encryption.

X-KM-Tran-Token

string

Required

Length : 66

Refer to Common header information - X-KM-Tran-Token Guide page

X-KM-Tran-Time

string

Required

Length : 14

Client Request Time

Form : YYYYMMDDHHMMSS

X-KM-Time-Zone

string

Required

Length : 3

International Standard Time (UTC, KST, ...)

Request Parameters

Encrypted|

Check out

Guidelines

for more information.

userInfo

object

Required

Member information

userId

number

Required

Min : 1 , Max : 9999999999999999999

Member ID
- Member's unique ID given when registering for membership

userName

string

Required

Min : 1 , Max : 100

Member’s Name

engName

string

Required

Min : 1 , Max : 100

(Member) Name in English

socialNo

string

Required

Min : 1 , Max : 20

(Member) Resident Registration Number
The particular information is used for issuing cash IC.

mobileNumber

string

Required

Min : 1 , Max : 20

Member’s mobile phone number

existOcrFile

string

Required

Length : 1

OCR file confirmation
- Y : Confirmed
- N : Not confirmed

addressInfo

object

Required

Delivery address information

address

string

Required

Min : 1 , Max : 255

Road name address for card delivery

addressDetail

string

Required

Min : 1 , Max : 255

Road name address detail for card delivery

zipCode

string

Required

Length : 5

Zip code of card delivery address

cardInfo

object

Required

Card Information

serviceId

string

Required

Length : 15

Card product ID
- Unique ID assigned to a card product.

enableFIC

boolean

Required

true

false

Cash IC
- true : Included
- false : Not included

csn

string

Conditional

Min : 1 , Max : 256

CSN
- Card chip Serial Number
- Used as cash IC serial number.
- Cash IC issuance data
- Condition field: set when "enableFIC" is "true"

string

Conditional

Min : 1 , Max : 256

PIN
- Cash IC issuance data
- Condition field: set when "enableFIC" is "true"

expiryDate

string

Conditional

Length : 8

Cash IC expiry date
- Cash IC issuance data
- Format : yyyyMMdd
- Condition field: set when "enableFIC" is "true"

bankCode

string

Conditional

Length : 3

Bank code

Bank name	Code	Bank name	Code
Shinhan Bank	088	Kookmin Bank	004
Woori Bank	020	KEB Hana Bank	081
Industrial Bank of Korea	003	Korea Development Bank	002
Agricultural Cooperation Unit	011	NH Nonghyup	012
Standard Chartered First Bank Korea	023	KakaoBank	090
Korea Post Office	071	Saemaeul Finance firm	045
National Federation of Fisheries Cooperatives	007	National Credit Union Federation of Korea	048
Pusan Bank	032	Kyongnam Bank	039
Kwangju Bank	034	Jeonbuk Bank	037
Jeju Bank	035	Daegu Bank	031
National Forestry Cooperative Federation	064	K Bank	089
Savings Bank	050	Toss Bank	092
Citi Bank Korea	027	Samsung Securities	240
Hanhwa Investment & Securities	269	Shinhan Investment Corp	278
		Yuanta Securities Korea	261

- Cash IC issuance data
- Condition field: set when "enableFIC" is "true"

accountNoStartIndex

number

Conditional

Min : 1 , Max : 9999999999

Account start digit
- Cash IC issuance data
- The first digit of the account number in the main account number of Track3 data is the reference position.
- Condition field: set when "enableFIC" is "true”

accountNoSize

number

Conditional

Min : 1 , Max : 9999999999

Length of account number
- Cash IC issuance data
- Length of account number in Track3 data
- Condition field: set when "enableFIC" is "true”

track3

string

Conditional

Min : 1 , Max : 1024

Track3 data
- Cash IC issuance data
- Format : Text length of 108 (54byte)
- Condition field: set when "enableFIC" is "true”

bankInfo

object

Required

Bank Information

bankName

string

Required

Min : 1 , Max : 10

Bank name

bankAccount

string

Required

Min : 1 , Max : 20

Bank Account Number

limits

object

Required

Payment limit information

once

number

Required

Min : 1 , Max : 9999999999

One-time payment limit

day

number

Required

Min : 1 , Max : 9999999999

Daily payment limit

month

number

Required

Min : 1 , Max : 9999999999

Monthly payment limit

Response Headers

X-KM-Correlation-Id

string

Required

Length : 20

Transaction number for tracking trasncription

Form : yyMMddHHmiSS-xxxxxxx
xxxxxxx : 7digit, Hex String

X-KM-Crypto-Key-Id

string

Optional

Length : 32

Data encryption/decryption key ID

Given ID from creating the service provider's project
If it is passed as a callback, the first key issued among the keys issued to the service provider is used.

Response Parameters

Encrypted|

Check out

Guidelines

for more information.

cardApplyNo

string

Required

Length : 22

Card application number
- (Member) A unique number generated when applying for issuance/delivery of a mobile card or physical card

mobileCardNo

string

Optional

Length : 16

(Mobile Card) Card Number

mobileCardCVC

string

Optional

Length : 3

(Mobile Card) Card Verification Code
- Card Verification Code

physicalCardNo

string

Required

Length : 16

(Physical Card) Card Number

expiryDate

string

Required

Length : 8

Card expiry date

Response Code

Detailed classification and addition of error for unseccessful withfrawal

200

Error code

000_000

Message

Success.

Description

Success

200

Error code

000_000

Message

Success.

Description

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

400

Error code

000_002

Message

Invalid input parameter. userId

Description

입력 파라미터 오류입니다

400

Error code

001_006

Message

Wallet user not found.

Description

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

400

Error code

003_060

Message

Service is not related to the request bank.

Description

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

400

Error code

003_061

Message

Not valid card issue type with the service.

Description

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

400

Error code

003_062

Message

Service does not support the applet.

Description

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

400

Error code

003_063

Message

User authentication error.

Description

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

400

Error code

003_064

Message

Download digital card error.

Description

모바일 카드 발급 실패

400

Error code

003_065

Message

Service is not digital pre-issue type.

Description

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

Show All

Test Data

200 - Success test

200 - Success Test_Without Cash IC

400 - Input parameter error

400 - He/she is not a member or an ex-member already withdrawn.

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

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

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

400 - 모바일 카드 발급 실패

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

400 - 신청한 카드 상품이 Sibling 상품을 갖고 있지 않을 경우

Loading ...

Request

Response

Click Try It!
to start a Request and see the Response here!

User Register Search for Member Information Member Password Reset and Change Member Information Change Membership Cancellation Checking Log in ID check Activation of Dormant Member Search for Terms and Conditions List Terms and Conditions Agreement/Withdrawal CI 값으로 회원 정보 조회 회원 로그인 ID 중복 확인 회원 비밀번호 검증 회원 인증 정보 조회 Financial Institution List Inquiry Real Name Verification for Account holder Authentication code generation before ARS authentication.Bank account registration via PG Search for Account Registration Status Balance Limit Increase(Individual card)회원 등록 계좌 조회 회원 계좌 정보 조회 자동충전 계좌 등록 회원 계좌 삭제 Microdeposit Verification(1 KRW)Microdeposit Verification Check Application for Issuance and Delivery of Prepaid Card Cancellation of Card Application Reissuance of Prepaid Card (Replacement Issuance)Reissuance & Renewal of Prepaid Card to be Expired Search for Card Delivery Status Search for Mobile Card Application Information Linkable to Physical Card Physical Card Registration Search for Card Unregistered card inquiry Modification of the Card’s State Discarding a Card Balance Limit Increase(Individual card)Balance Limit Increase(Coporate card)Inquiry of Coporate Card Identification Status Applying For Income Tax Deduction Inquiry of Card Tax Deduction Status Card-User Mapped Inquiry Card Product ID Inquiry 주카드 설정 카드에 연결된 가상계좌 조회 Application for Issuance and Delivery of Debit Card Cancellation of Card Application Search for Card Delivery Status Physical Card Registration Search for Card Modification of the Card’s State Modification of the Card’s Limit Discarding a Card Applying For Income Tax Deduction Inquiry of Card Tax Deduction Status 주카드 설정 Issuance of Disposable Token Charge Cancellation of Charge Checking Result of Charge & Cancellation of Charge Checking Transaction History 기준 하한 및 월정액 자동 충전 활성화 기준 하한 자동 충전 등록 기준 하한 및 월정액 자동 충전 목록 조회 기준 하한 자동 충전 수정 월 정액 자동 충전 등록 월 정액 자동 충전 수정 기준 하한 및 월정액 자동 충전 등록 해제 결제 시 자동 충전 등록 결제 시 자동 충전 등록 해제 결제 시 자동 충전 목록 조회 Issuance of Disposable Token Search for Refund Fee Refund Checking Refund Result System Recharging System Recharging Cancel System Refund System Partial Refund 신용카드 충전 거래 생성 신용카드 충전 취소 요청 편의점 충전/출금 요청 Deposit Transaction Inquiry Deposit Balance Inquiry Issuance of Disposable Token Payment Cancellation of Payment Network Cancellation of Payment Checking Transaction History Checking History of Point Transaction Search for Card Reservations & Cancellations of Point Use Checking History of Point Transaction 관리자 포인트 지급 관리자 포인트 환수 Stamp card accumulation history inquiry Check the list of stamp cards held by member Inquiry the list of mileage cards owned by member.Mileage card accumulation history inquiry Transfer to Card Transfer to Card Receiving Card Transfer Rejection Card Transfer Cancellation Issuance of Disposable Token for ATM ATM Withdrawal Reservation ATM Withdrawal Reservation Cancel ATM withdrawal information inquiry 선불카드 선물하기 선불카드 선물하기 취소 선불카드 선물하기 유효성 검증 선불카드 선물하기 수락 선불카드 선물하기 거절 받은 카드/쿠폰 선물 목록 조회 보낸 카드/쿠폰 선물 목록 조회 카드 선물 수락 V2 카드 선물하기 V2 Transfer card balance Balance Transfer Card Information Inquiry 현금영수증 발행 요청 현금영수증 발행 취소 현금영수증 국세청 승인오류 요청 현금영수증 식별 정보 등록 현금영수증 식별 정보 조회 현금영수증 식별 정보 삭제 현금영수증 가맹점 등록 현금영수증 가맹점 수정 Creation of merchant groups Merchant Group Modify Merchant Group Inquiry Merchant Information Inquiry Adding merchants to merchant groups Merchant removal from merchant groups 신용카드 자동충전 설정(기준 하한)신용카드 자동충전 설정(월정액)신용카드 자동충전 활성화 신용카드 자동충전 목록 조회 신용카드 자동충전 설정 해제 신용카드 자동 충전 설정 변경 카드 상품 전체 조회 (관리자용)카드 상품 상세 조회 (관리자용)발급 카드 목록 조회 (관리자용)카드 상품 생성 API (관리자용)카드 선물 내역 조회 (관리자용)