New Payment Platform, KONA PLATE

API Documentation

All API

Service

Search for CardSync

Version: v1

POST

/api/v1/user/card/list

The list of cards held by a member and card information are provided as follows. • Card product information • Balance information • Expiry date • Card status • Card number • Payment limits • Point • Linked accounts (for debit card)

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.

cardDataInfo

array of objects

Required

카드 정보 목록

cardDataInfo_item

object

Optional

cardDataInfo_item content

par

string

Required

Length : 27

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

limits

object

Optional

결제 한도 정보

직불카드인 경우에만 응답데이터에 포함됩니다.

day

number

Optional

Min : 0 , Max : 9999999999

일 결제 한도

once

number

Optional

Min : 0 , Max : 9999999999

1회 결제 한도

month

number

Optional

Min : 0 , Max : 9999999999

월 결제 한도

balance

number

Required

Min : 0 , Max : 9999999999

카드에 충전되어 있는 잔액 정보

pendingAmount

number

Required

Min : 0 , Max : 9999999999

충전 대기금 금액

카드의 한도를 초과하는 충전 요청이 접수되어, 아직 처리되지 않고 충전 대기 중인 금액.

isNamed

boolean

Required

카드 기명화 여부

기명화란? 무기명으로 발행된 카드를 선불전자지급수단을 법에서 정하는 '실지명의 인증' 또는 '예금계좌와 연결하는 방식'을 통하여 해당 선불전자지급수단의 이용자로 특정하는 행위를 말합니다.

bankInfo

object

Optional

직불카드에 연결된 계좌 정보

직불카드인 경우에만 응답데이터에 포함됩니다.

bankName

string

Required

Min : 1 , Max : 10

은행 이름

accountNo

string

Required

Min : 1 , Max : 20

은행 계좌 번호

enableFIC

boolean

Required

현금IC 포함 여부

true : 현금IC 포함
false : 현금IC 미포함

직불카드인 경우에만 응답데이터에 포함됩니다.

serviceId

string

Required

Length : 15

카드 상품 ID

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

expiryDate

string

Required

Length : 8

카드 사용 유효기간

형식 : yyyyMMdd

refundable

boolean

Required

카드의 환불 가능 여부

remittable

boolean

Required

카드의 송금 가능 여부

아래 항목에 대한 잔액 송금 가능 여부를 설정합니다.

휴대 전화번호로 송금
카드번호로 송금

cardApplyNo

string

Optional

Length : 22

카드 신청 번호

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

serviceName

string

Required

Min : 1 , Max : 255

카드 상품명

mobileCardNo

string

Optional

Length : 16

(모바일카드) 카드 번호

rechargeable

boolean

Required

카드의 충전 가능 여부

아래 항목의 충전 가능여부를 설정합니다.

OFFLINE 단말기 충전
개인계좌 충전
포탈을 통한 ADMIN 충전

cardPointInfo

array of objects

Optional

카드 포인트 정보

cardPointInfo_item

object

Optional

cardPointInfo_item content

autoUse

boolean

Required

포인트 자동사용 여부

포인트 정책에 설정된 값

pointName

string

Required

Min : 1 , Max : 255

포인트 정책명

pointPolicyId

string

Required

Length : 15

포인트 정책 ID

remainingPoint

number

Optional

Min : 0 , Max : 9999999999

(회원) 포인트 잔액

회원이 가지고 있는 포인트의 잔액

physicalCardNo

string

Optional

Length : 16

(실물카드) 카드 번호

serviceImageUrl

string

Required

Min : 1 , Max : 255

카드 상품의 이미지 파일 URL

autoReloadStatus

string

Optional

Min : 1 , Max : 8

카드의 자동충전 상태

ACTIVE : 활성화
INACTIVE : 비활성화
NONE : 설정안함

mobileCardStatus

string

Required

Min : 1 , Max : 7

(모바일카드) 카드의 상태

ACTIVE : 정상
SUSPENDED : 중지

minRechargeAmount

number

Required

Min : 0 , Max : 9999999999

카드에 충전시 최소 충전금액

physicalCardStatus

string

Optional

Min : 1 , Max : 7

(실물카드) 카드의 상태

ACTIVE : 정상
SUSPENDED : 중지

rechargeableAmount

number

Required

Min : 0 , Max : 9999999999

카드에 충전 가능한 금액

무기명 카드의 경우 = 무기명카드 최대 충전금액(maxNonRealNameRechargeAmount) - 카드잔액(balance)
기명화된 카드의 경우 = 기명화카드 최대 충전금액(maxRealNameRechargeAmount) - 카드잔액(balance)

충전 가능 금액(예)

maxNonRealNameRechargeAmount = 500000
maxRealNameRechargeAmount = 2000000
balance = 300000

무기명 카드인 경우 = 200000(500000 - 300000)

기명화된 카드인 경우 = 1700000(2000000 - 300000)

personalRechargeable

boolean

Required

카드의 개인계좌를 통한 충전 가능 여부

maxRealNameRechargeAmount

number

Required

Min : 0 , Max : 9999999999

기명화된 카드에 충전할 수 있는 최대 금액

maxNonRealNameRechargeAmount

number

Required

Min : 0 , Max : 9999999999

무기명 카드에 충전할 수 있는 최대 금액

rechargeUnitAmt

number

Optional

Min : 0 , Max : 9999999999

충전 단위 설정

cardLifeStatus

string

Required

Length : 2

카드 원장 상태 구분값

30 : 정지
60 : 활성화
90 : 삭제

cardBizStatus

string

Required

Length : 2

카드상태 코드

31: 카드 분실로 인한 정지　
36: 카드 수령 전 정지
3A: 카드 재발급으로 인한 중지
60: 정상
61: 카드 분실 신고 해지
35: 카드 유효 기간 만료로 인한 중지

accTransferStatus

string

Required

Length : 1

모든 이체 진행상태 (충전취소, 환불이체 진행 상태)

0 : 해당 없음
1 : 이체 진행중

enableVirtualAccountPendingAmount

boolean

Required

가상계좌 충전 대기금 사용 여부

virtualAccountMaxPendingAmount

number

Required

Min : 0 , Max : 9999999999

가상계좌 충전 대기금 최대 금액

카드 잔액 + 충전 대기금 잔액의 최대 허용 금액

Response Code

Detailed classification and addition of error for unseccessful withfrawal

200

Error code

000_000

Message

Success.

Description

Success

400

Error code

000_002

Message

Invalid input parameter. userId

Description

Invalid input parameter

400

Error code

000_003

Message

Missing required values. userId

Description

Missing required parameter

400

Error code

001_006

Message

Wallet user not found.

Description

Non-member or a member who has canceled membership

Test Data

200 - Test succeeded

200 - Test succeeded _no card owned by a member

400 - Invalid input parameter

400 - Missing required parameter

400 - Non-member or a member who has canceled membership

200 - 성공 테스트_PAR 파라미터 사용 케이스

200 - 성공 테스트_cardNo 파라미터 사용 케이스

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)회원 등록 계좌 조회 회원 계좌 정보 조회 자동충전 계좌 등록 회원 계좌 삭제 Issuance of Disposable Token Charge Cancellation of Charge Checking Result of Charge & Cancellation of Charge Checking Transaction History 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 주카드 설정 카드에 연결된 가상계좌 조회 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)회원 등록 계좌 조회 회원 계좌 정보 조회 자동충전 계좌 등록 회원 계좌 삭제