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
신용카드 자동충전
관리자 페이지용 기능

Reservations & Cancellations of Point UseSync

Version: v1

POST

/api/v1/payment/point

Reserving and canceling use of points owned by members. In order to use the points at the time of payment, a member should reserve use of the coupon before payment and proceed with the payment within 10 minutes.

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.

userId

number

Required

Min : 1 , Max : 999999999999999

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

pointType

string

Conditional

Min : 1 , Max : 5

Point type to be used

- USER : Using user points
- CARD : Using card points
- Condition field : Set when "reservationType" value is "RESERVE"

policyId

string

Conditional

Length : 15

Point policy ID to be used

- It can be checked in card query.
- Condition field : Set when "pointType" value is "CARD"

cardNo

string

Conditional

Length : 16

Card number for payment

- Condition field : Set when "pointType" value is "CARD"

pointAmount

number

Conditional

Min : 1 , Max : 1000000000

Point amount to be used

- Condition field : Set when "reservationType" value is "RESERVE"

reservationType

string

Required

Min : 1 , Max : 7

Reservation status of point use

- RESERVE : (Point) Usage reserved
- CANCEL : (Point) Usage reservation canceled

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

remainTime

number

Required

Min : 0 , Max : 3600000

Remaining valid time of point use

- Unit : ms

userId

number

Required

Min : 1 , Max : 999999999999999

Member ID

- Member's unique ID given when registering for membership

pointAmount

number

Required

Min : 1 , Max : 1000000000

Point amount to be used/to be canceled

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.

Description

Invalid input parameter

400

Error code

006_023

Message

Exceed the balance.

Description

Low balance

400

Error code

006_024

Message

Exceed the one time limit.

Description

Exceeding of one-time payment limit

400

Error code

006_025

Message

Exceed the day limit.

Description

Exceeding of daily payment limit

400

Error code

006_026

Message

Exceed the month limit.

Description

Exceeding of monthly payment limit

400

Error code

006_029

Message

Card is not found with the card no.

Description

No card searched with the corresponding card number

Test Data

200 - Reservation test succeeded

200 - Reservation cancellation test succeeded

400 - Low balance error

400 - Exceeding of one-time payment limit

400 - Exceeding of daily payment limit

400 - Exceeding of monthly payment limit

400 - Invalid input value

400 - No card searched with the corresponding card number

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 (관리자용)카드 선물 내역 조회 (관리자용)