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

관리자 포인트 지급Sync

Version: v1

POST

/api/v1/point/admin/reward

예치금 계좌를 활용한 포인트 지급 방식으로, 예치금 계좌의 잔액을 차감하여 회원 카드에 포인트를 지급합니다.

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.

adminPointMessageInfo

object

Required

지급 사유 정보 입니다.

reason

string

Required

Min : 1 , Max : 255

지급 사유 입니다.

affiliateId

string

Conditional

Length : 15

카드 포인트 지급에 필요한 제휴사 ID 입니다.

"pointType"값이 "CARD"값이면서 "isRewardByToken" 이 ture인 경우 필수값입니다.

pointRewardInfoList

array of objects

Required

포인트 발급 정보 리스트 입니다.

Add object

pointType

string

Required

Length : 4

지급할 포인트 타입

USER : 유저 포인트 사용
CARD : 카드 포인트 사용

policyId

string

Conditional

Length : 15

포인트 정책 ID

조건 필드 : "pointType"값이 "CARD"값일 경우 설정

policyLimitMonthIgnored

boolean

Optional

true

false

유저당 캐시정책 월 지급 제한 무시 여부입니다.

default : false

policyLimitYearIgnored

boolean

Optional

true

false

유저당 캐시정책 년 지급 제한 무시 여부입니다.

default : false

validMonthLength

number

Conditional

Min : 1 , Max : 99

포인트가 유효한 개월 수 입니다.

expiryDate이 null인 경우 필수값.

expiryDate

string

Conditional

Length : 8

포인트 지정 만료일입니다.

형식 : yyyyMMdd
validMonthLength이 null인 경우 필수값

isRewardByToken

boolean

Optional

true

false

카드 번호를 이용한 카드 포인트 지급 여부입니다.

default: false

pointProviderGroupId

string

Optional

Length : 2

포인트 지급 시 분담 그룹 정보

기본값: "01"

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.

policyId

string

Conditional

Length : 15

포인트 정책 ID

"pointType"값이 "CARD"값일 경우 필수값

pointType

string

Required

Length : 4

지급한 포인트 타입

USER : 유저 포인트 사용
CARD : 카드 포인트 사용

policyName

string

Conditional

Min : 1 , Max : 255

포인트 정책명 입니다.

"pointType"값이 "CARD"값일 경우 필수값

completedCount

number

Required

Value : 0

지급 완료 건수 입니다

failedCount

number

Required

Value : 0

지급 실패 건수 입니다.

totalPointAmount

number

Required

Value : 0

총 지급된 포인트 입니다.

pointRewardInfoList

array of objects

Required

포인트 지급 정보 리스트 입니다.

pointRewardInfoList_item

object

Optional

pointRewardInfoList_item content

userId

number

Required

Min : 1 , Max : 9999999999999999999

회원 ID

회원가입 시 부여되는 회원의 고유 ID입니다.
포인트를 지급받은 회원의 ID입니다.

par

string

Conditional

Length : 27

카드 포인트를 지급받은 카드의 par 입니다.

"pointType"값이 "CARD"값일 경우 필수값

cardNo

string

Conditional

Length : 16

지급 대상 카드

"pointType"값이 "CARD"값이면서 "isRewardByToken" 이 ture인 경우 필수값입니다.

amount

number

Required

Min : 0 , Max : 999999999999

지급할 포인트 입니다.

fixedAmount

number

Required

Min : 0 , Max : 999999999999

실제 지급 받은 포인트 입니다.

status

string

Required

Min : 6 , Max : 9

지급 성공 여부 입니다.

COMPLETED : 지급 완료
FAILED : 지급 실패

reason

string

Required

Length : 0

지급 결과 사유 입니다

transactionId

string

Optional

Length : 50

외부 연동 거래 코드 값입니다.

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.

Description

필수값 누락 테스트

400

Error code

000_008

Message

Internal service error.

Description

내부 서비스 오류.

Test Data

200 - 성공 테스트

400 - 입력 파라미터 오류 테스트

400 - 필수값 누락 테스트

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)회원 등록 계좌 조회 회원 계좌 정보 조회 자동충전 계좌 등록 회원 계좌 삭제 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 (관리자용)카드 선물 내역 조회 (관리자용)