Konaplate logo

API Documentation

All API

Service


PaymentSync

Version: v1


Version: v1

POST

/api/v1/payment/no-hce

Processing the payment using disposable Token. After obtaining disposable Token, make and process payment data with the card number. The "nrNumber" I received as a response will be used when canceling the payment.

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


oneTimeToken

string

Required

Length : 16

Disposable Token

  • Value received when requesting "Issuance of disposable tokens"

amount

number

Required

Min : 0 , Max : 999999999999

결제 요청금액

merchantId

string

Required

Length : 15

결제요청하는 가맹점ID

dcvv

string

Required

Length : 3

DCVV

  • Value received when requesting "Issuance of disposable tokens"

exceptAmount

number

Optional

Min : 0 , Max : 999999999999

소득공제 제외금액

  • 1회용컵 보증금 처리 등에 사용됩니다.

channel

string

Required

Min : 1 , Max : 20

서비스 구분 코드

  • 서비스를 구분하는 코드 입니다. (예; OPENAPI, KONA, JADU, PINO, HEALTH)

vat

number

Optional

Min : 1 , Max : 999999999999

부가세

transactionId

string

Required

Min : 0 , Max : 28

클라이언트 거래고유키 (모든 거래마다 고유해야 함)

  • 공백없는 문자 28자리

isOnlyCheck

boolean

Optional

true


true

false

결제가능여부 확인용도

  • true : 실결제 전 결제가능여부 확인. 실제 결제에 반영되지는 않음
  • false : (default) 실결제

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.

cardNo

string

Required

Length : 16

Card number used to issue disposable Token

balance

number

Required

Min : 0 , Max : 999999999999

Card Balance

approvalCode

string

Required

Length : 6

Approval Number

nrNumber

string

Required

Length : 18

Transaction unique number

Network Reference Number

approvalTime

string

Required

Length : 17

time of transaction approval

Format : yyyyMMddHHmmssSSS

Response Code

Detailed classification and addition of error for unseccessful withfrawal


200

Error code

000_000

Message

Success

Description

Success


400

Error code

006_005

Message

The entered card cannot be transacted through the POS Entry Mode.

Description

The card entered cannot be traded through that POS Entry Mode (DE 22)


400

Error code

006_006

Message

Invalid Transaction.

Description

The card terminal time is wrong


400

Error code

006_007

Message

Invalid amount.

Description

Wrong transaction amount - insufficient balance


400

Error code

006_008

Message

Invalid card number.

Description

Wrong card number


400

Error code

006_009

Message

Requeset format error.

Description

Wrong type of ISO 8583


400

Error code

006_010

Message

Over limit of the store.

Description

Request that exceeds the amount that can be paid/charged/refundable


400

Error code

006_011

Message

Expired card.

Description

Expired Card


400

Error code

006_012

Message

Transaction not permitted.

Description

When there is not enough authority to make a deal In case of cancellation of payment, there is no ledger transaction to cancel


400

Error code

006_013

Message

Transaction does not permitted to terminal.

Description

Mishandling agency code

Show All

Test Data

200 - success test


200 - success test
400 - The entered card cannot be transacted through the corresponding POS Entry Mode (DE 22)
400 - Card terminal time is incorrect
400 - Invalid Transaction Amount – Insufficient Balance
400 - wrong card number
400 - Invalid ISO 8583 format
400 - Requests that exceed the amount that can be paid/recharged/refundable
400 - expired card
400 - Insufficient authority to make a transaction (in case of payment cancellation, there is no ledger transaction to cancel)
400 - Invalid handling agency code
400 - Limited use card
400 - Wrong ATC
400 - PIN Try count exceeded
400 - Cryptogram verification failed
400 - wrong PIN
400 - Duplicate transaction request
400 - system failure
400 - Invalid Merchant
400 - Expired Temporary Token Number
400 - Already used one time token
Loading ...

Request

Loading...

Response

Click Try It!
to start a Request and see the Response here!


User RegisterSearch for Member InformationMember Password Reset and ChangeMember Information ChangeMembership CancellationChecking Log in ID checkActivation of Dormant MemberSearch for Terms and Conditions ListTerms and Conditions Agreement/WithdrawalCI 값으로 회원 정보 조회회원 로그인 ID 중복 확인회원 비밀번호 검증회원 인증 정보 조회Financial Institution List InquiryReal Name Verification for Account holderAuthentication code generation before ARS authentication.Bank account registration via PGSearch for Account Registration StatusBalance Limit Increase(Individual card)회원 등록 계좌 조회회원 계좌 정보 조회자동충전 계좌 등록회원 계좌 삭제Microdeposit Verification(1 KRW)Microdeposit Verification CheckApplication for Issuance and Delivery of Prepaid CardCancellation of Card ApplicationReissuance of Prepaid Card (Replacement Issuance)Reissuance & Renewal of Prepaid Card to be ExpiredSearch for Card Delivery StatusSearch for Mobile Card Application Information Linkable to Physical CardPhysical Card RegistrationSearch for CardUnregistered card inquiryModification of the Card’s StateDiscarding a CardBalance Limit Increase(Individual card)Balance Limit Increase(Coporate card)Inquiry of Coporate Card Identification StatusApplying For Income Tax DeductionInquiry of Card Tax Deduction StatusCard-User Mapped InquiryCard Product ID Inquiry주카드 설정카드에 연결된 가상계좌 조회Application for Issuance and Delivery of Debit CardCancellation of Card ApplicationSearch for Card Delivery StatusPhysical Card RegistrationSearch for CardModification of the Card’s StateModification of the Card’s LimitDiscarding a CardApplying For Income Tax DeductionInquiry of Card Tax Deduction Status주카드 설정Issuance of Disposable TokenChargeCancellation of ChargeChecking Result of Charge & Cancellation of ChargeChecking Transaction History기준 하한 및 월정액 자동 충전 활성화기준 하한 자동 충전 등록기준 하한 및 월정액 자동 충전 목록 조회기준 하한 자동 충전 수정월 정액 자동 충전 등록월 정액 자동 충전 수정기준 하한 및 월정액 자동 충전 등록 해제결제 시 자동 충전 등록결제 시 자동 충전 등록 해제결제 시 자동 충전 목록 조회Issuance of Disposable TokenSearch for Refund FeeRefundChecking Refund ResultSystem RechargingSystem Recharging CancelSystem RefundSystem Partial Refund신용카드 충전 거래 생성신용카드 충전 취소 요청편의점 충전/출금 요청Deposit Transaction InquiryDeposit Balance InquiryIssuance of Disposable TokenPaymentCancellation of PaymentNetwork Cancellation of Payment Checking Transaction HistoryChecking History of Point TransactionSearch for CardReservations & Cancellations of Point UseChecking History of Point Transaction관리자 포인트 지급관리자 포인트 환수Stamp card accumulation history inquiryCheck the list of stamp cards held by memberInquiry the list of mileage cards owned by member.Mileage card accumulation history inquiryTransfer to CardTransfer to Card ReceivingCard Transfer RejectionCard Transfer CancellationIssuance of Disposable Token for ATMATM Withdrawal ReservationATM Withdrawal Reservation CancelATM withdrawal information inquiry선불카드 선물하기선불카드 선물하기 취소선불카드 선물하기 유효성 검증선불카드 선물하기 수락선불카드 선물하기 거절받은 카드/쿠폰 선물 목록 조회보낸 카드/쿠폰 선물 목록 조회카드 선물 수락 V2카드 선물하기 V2Transfer card balanceBalance Transfer Card Information Inquiry현금영수증 발행 요청현금영수증 발행 취소현금영수증 국세청 승인오류 요청현금영수증 식별 정보 등록현금영수증 식별 정보 조회현금영수증 식별 정보 삭제현금영수증 가맹점 등록현금영수증 가맹점 수정Creation of merchant groupsMerchant Group ModifyMerchant Group InquiryMerchant Information InquiryAdding merchants to merchant groupsMerchant removal from merchant groups신용카드 자동충전 설정(기준 하한)신용카드 자동충전 설정(월정액)신용카드 자동충전 활성화신용카드 자동충전 목록 조회신용카드 자동충전 설정 해제신용카드 자동 충전 설정 변경카드 상품 전체 조회 (관리자용)카드 상품 상세 조회 (관리자용)발급 카드 목록 조회 (관리자용)카드 상품 생성 API (관리자용)카드 선물 내역 조회 (관리자용)