New Payment Platform, KONA PLATE

API Documentation

All API

Service

Pre-paid Card
Debit Card

Card-User Mapped InquirySync

Version: v1

POST

/api/v1/user/card/info

This is an API for querying balance information and member information mapped to a card number of a mobile card or a physical card.

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 : 16

Client Request Time

Form : YYYYMMDDHH24MISS

X-KM-Time-Zone

string

Required

Length : 3

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

Request Parameters

Encrypted|

Check out

Guidelines

for more information.

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.

userId

number

Optional

Min : 0 , Max : 9999999999999999999

회원 ID

회원가입 시 부여되는 회원의 고유 ID입니다.
미등록 카드인 경우 null

balance

number

Required

Min : 0 , Max : 9999999999

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

serviceId

string

Required

Length : 15

카드 상품 ID

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

serviceName

string

Required

Min : 1 , Max : 256

카드 상품명

ownerKa

string

Optional

Length : 15

상품 소유 제휴사 ID

cashReceiptInfo

object

Optional

현금영수증 식별정보

회원이 현금영수증 식별정보를 등록한 경우에 확인 가능

approvalDiv

string

Required

Length : 1

거래구분(0: 소비자 소득공제용, 1: 사업자 지출증빙용)

idNo

string

Required

Length : 20

신분확인번호

현금영수증 카드번호
휴대폰번호
사업자번호

manYn

string

Required

Length : 1

신분확인번호구분

0 : 카드 번호
1 : 수기 (휴대폰, 사업자 번호)

cardStatus

string

Optional

Min : 1 , Max : 7

카드 상태

SUSPENDED : 정지
ACTIVE : 정상
TERMINATED : 폐기

isAutoRechargeBeforePayment

boolean

Required

결제시 잔액 부족한 경우 자동 충전 여부

Response Code

Detailed classification and addition of error for unseccessful withfrawal

200

Error code

000_000

Message

Success.

Description

성공

400

Error code

000_002

Message

Invalid input parameter.

Description

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

400

Error code

000_003

Message

Missing required values. cardNo

Description

필수 파라미터가 누락되었습니다.

Test Data

200 - Success

400 - Invalid input parameter

400 - Missing required values. 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)회원 등록 계좌 조회 회원 계좌 정보 조회 자동충전 계좌 등록 회원 계좌 삭제