New Payment Platform, KONA PLATE

API Documentation

All API

Service

Pre-paid Card
Debit Card

ChargeSync

Version: v1

POST

/api/v1/recharges/by-bank-accounts/no-hce

Charging the balance of the prepaid card using the account registered by a member. (Charging) A one-time token for transaction data should be issued.

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

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

nrNumber

string

Required

Min : 1 , Max : 50

Transaction number

isPending

boolean

Required

Waiting for charging transaction

(Charging) If a normal response is not received from the PG due to network instability, etc. during the transaction, the value is returned as "true".

Such transaction may take some time depending on the network conditions of the bank or PG, and the PG continuously checks success of withdrawal transfer.

If it succeeds, the card charge transaction is completed, and if it fails, it is processed as a charging failure.

On the day of the request, charging transaction will be checked continuously every 5 minutes.

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

007_001

Message

Bank account not found.

Description

No account registered

400

Error code

007_002

Message

Inconsistent requested benefit.

Description

The requested benefit information (incentive) and the benefit information to be applied at the time of charging are different.

400

Error code

007_003

Message

Credit limit exceeded.

Description

Refusal of approval due to exceeding the amount (limit) from Kona Card's approval server

400

Error code

007_004

Message

Withdraw failure from PG.

Description

Failed to withdraw money from PG

400

Error code

007_005

Message

Account charge request while proceeding.

Description

A request to charge the account is received while a charging transaction to the account is in progress.

400

Error code

007_006

Message

Account charge request while proceeding auto charge.

Description

A request to charge the account is received while an auto charging transaction is in progress at the time of payment.

400

Error code

007_007

Message

Recharge amount should be more than zero.

Description

The amount requested to be charged is less than 0 won

400

Error code

007_008

Message

Same sequenceId already exists.

Description

A request was already made for the same seqId.

Show All

Test Data

200 - Test succeeded

400 - Invalid input parameter

400 - No account registered

400 - The requested benefit information (incentive) and the benefit information to be applied at the time of charging are different

400 - Refusal of approval due to exceeding the amount (limit) from Kona Card's approval server

400 - Failed to withdraw money from PG

400 - A request to charge the account is received while a charging transaction to the account is in progress.

400 - A request to charge the account is received while an auto charging transaction is in progress at the time of payment.

400 - The amount requested to be charged is less than 0 won

400 - A request was already made for the same seqId.

400 - Franchise error

400 - Attempt to change with invalid one-time token

400 - 은행 계좌에 문제가 있음. 은행에 문의

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