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/recharges/online-payment/cancel

신용카드 충전 취소를 요청하여 취소 가능여부와 신용카드 취소 거래에 필요한 정보를 받습니다. 6.1. 거래내역 확인 을 통해 충전 거래 내역 중, rcgType 이 "03(신용카드)" 일 경우, 본 API를 호출하여 충전 취소할 수 있습니다.

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.

dcvv

string

Required

Length : 3

DCVV

임시 토큰 생성 API 를 통해 응답 받은 dcvv 정보를 입력 데이터로 사용해야 한다.

userId

number

Required

Min : 1 , Max : 9999999999999999999

회원 ID

회원가입 시 부여되는 회원의 고유 ID입니다.

sequenceId

string

Required

Min : 1 , Max : 20

거래 관리번호

요청에 대해 응답을 받지 못했을 경우, 해당 관리번호로 결과를 확인하기 위한 입력 값으로 사용됩니다.

해당 번호는 제휴사에서 포멧을 정해서 unique한 값으로 입력해야 합니다.

cancelReason

string

Optional

Min : 1 , Max : 256

취소 사유

oneTimeToken

string

Required

Length : 16

임시 카드 번호

임시 토큰 생성 API 를 통해 응답 받은 oneTimeToken 정보를 입력 데이터로 사용해야 한다.

transactionId

string

Conditional

Length : 20

취소할 신용카드 충전 요청 거래 번호

transactionId, nrNumber 둘 중 하나는 필수값

nrNumber

string

Conditional

Length : 18

거래 고유 번호

transactionId, nrNumber 둘 중 하나는 필수값

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

isPending

boolean

Required

충전 거래 대기 여부

(충전취소) 거래 과정에서 네트워크 불안 등의 원인으로 PG로부터 정상 응답을 받지 못하는 경우 해당 값을 "true"로 응답합니다.

이와 같은 거래는 은행 또는 PG의 네트워크 상황에 따라 다소 시간이 걸릴 수 있으며, 지속적으로 PG에 해당 출금 이체의 성공 여부를 체크합니다.

성공할 경우, 카드 충전취소 거래를 완료하며 실패할 경우 충전취소실패로 처리합니다.

요청 당일에 한하여 5분단위로 계속 확인 합니다.

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. userId

Description

입력 파라미터 오류

400

Error code

000_003

Message

Missing required values. sequenceId

Description

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

400

Error code

007_036

Message

TransactionId or nrNumber is required.

Description

TransactionId 과 nrNumber 값이 모두 없는 경우.

400

Error code

007_037

Message

Payment denied.

Description

승인 거부됨.

400

Error code

007_030

Message

Cancellation not possible for this transaction.

Description

충전 취소가 불가능한 거래.

400

Error code

007_022

Message

Invalid one time token.

Description

충전 취소가 불가능한 거래.

400

Error code

007_038

Message

Payment delayed.

Description

코나카드의 승인서버 또는 PG로 부터 취소 거래 지연인 경우 발생.

400

Error code

007_039

Message

Payment failed.

Description

KCP로 부터 거래가 실패한 경우 발생

Test Data

200 - Success

400 - Invalid input parameter. userId

400 - Missing required values. sequenceId

400 - TransactionId 과 nrNumber 값이 모두 없는 경우.

400 - 승인 거부됨.

400 - 충전 취소가 불가능한 거래.

400 - 코나카드의 승인서버 또는 PG로 부터 취소 거래 지연인 경우 발생.

400 - KCP로 부터 거래가 실패한 경우 발생

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