New Payment Platform, KONA PLATE

API Documentation

All API

Service

Pre-paid Card
Debit Card

Bank account registration via PGAsync

Version: v1

POST

/api/v1/bankaccounts/ars/register

A member's account is registered via PG An account will be registered or an account already registered will be changed to a new account. ARS authentication It is verified that a member correctly enters the authentication code displayed on a mobile screen according to the guidance of ARS. ARS authentication voice files are recorded and used as data for consent to withdrawal and transfer Account registration A member must register a withdrawal account to charge the card. To do this, the following two steps are needed. 1. Verification of the real name of the account holder 2. ARS authentication The account will be registered and the prepaid card will be charged from your account PG receives the ARS authentication code from the member, verifies the authentication code (ARS authentication), delivers the response code to the core system, and requests account registration information from the PG. If the ARS authentication is valid, after answering ("000"), ARS certification call will be made to the member’s phone number and the withdrawal transfer account will be registered. (Asynchronous)

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

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

bankAccount

string

Required

Min : 1 , Max : 20

Bank account number

bankCode

string

Required

Length : 3

Bank Code

Bank name	Code	Bank name	Code
Shinhand Bank	088	KB Kookmin Bank	004
Woori Bank	020	Hana Bank	081
IBK Industrial Bank of Korea	003	The Korea Development Bank	002
NH Nonghyup Bank	011	Local Agricultural Cooperatives	012
SC Bank	023	Kakao Bank	090
Post Office	071	Community Credit Cooperatives	045
Suhyup Bank	007	Shinhyup	048
Busan Bank	032	Kyongnam Bank	039
Kwangju Bank	034	Jeonbuk Bank	037
Jeju Bank	035	Daegu Bank	031

bankName

string

Required

Min : 1 , Max : 10

Bank Name

userName

string

Required

Min : 1 , Max : 100

Member’s name

birthDate

string

Required

Length : 8

Member’s date of birth
- Format : yyyyMMdd

userType

string

Optional

Min : 1 , Max : 8

Account Input Type
- Default: Normal
- Normal: When the user inputs the bank account in the app.
- EXTERNAL: When the user inputs the bank account in the third party merchant's app.

creationType

string

Optional

Min : 1 , Max : 30

Open Account Type
- Default: FACE
- NON_FACE: (Non-face-to-face) For bank account registration opened in KONA app.
- FACE: (Face-to-face): For bank account registration not opened in KONA app.

langCode

string

Optional

Min : 1 , Max : 3

ARS authentication voice code
- Default: ko

Language code
- ko : Korean
- en : English
- fil : Filipino
- id : Indonesian
- km : Cambodian
- ne : Nepali
- vi : Vietnamese
- ru : Russian
- mn : Mongolian
- bn : Bengali
- si : Sinhalese
- uz : Uzbeck language
- ja : Japanese
- zh : Chinese

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

bankAccRegNo

string

Required

Min : 1 , Max : 22

Account registration processing number
After ARS phone authentication, the number is used as an input value to check account registration.

Response Code

Detailed classification and addition of error for unseccessful withfrawal

200

Error code

000_000

Message

Success.

Description

After the member's ARS authentication, the bank account is successfully registered.

400

Error code

002_013

Message

Ars auth and bank account register is still in progress.

Description

The registration process is in progress. This error occurs when a duplicate request is made with the same member ID while the ARS authentication and account registration process is in progress. After ARS authentication, a member's account registration process cannot proceed more than one time at the same time.

Test Data

200 - Test succeeded

200 - Test succeeded – Request without OPTIONAL parameter

400 - The registration process with the same member ID is in progress.

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