Konaplate logo

API Documentation

All API

Service


โ€‹

Cancellation of ChargeSync

Version: v1


Version: v1

POST

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

Used to cancel a charging transaction from the member's account. The canceled amount will be deducted from the card balance and transferred to the member's registered account on the next day of the cancellation request.

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


sequenceId

string

Required

Length : 30

๊ด€๋ฆฌ๋ฒˆํ˜ธ

์š”์ฒญ์— ๋Œ€ํ•ด ์‘๋‹ต์„ ๋ฐ›์ง€ ๋ชปํ–ˆ์„ ๊ฒฝ์šฐ, ํ•ด๋‹น ๊ด€๋ฆฌ๋ฒˆํ˜ธ๋กœ ๊ฒฐ๊ณผ๋ฅผ ํ™•์ธํ•˜๊ธฐ ์œ„ํ•œ ์ž…๋ ฅ ๊ฐ’์œผ๋กœ ์‚ฌ์šฉ๋ฉ๋‹ˆ๋‹ค.

ํ•ด๋‹น ๋ฒˆํ˜ธ๋Š” Unique ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค.

userId

number

Required

Min : 1 , Max : 9999999999999999999

ํšŒ์› ID

  • ํšŒ์›๊ฐ€์ž… ์‹œ ๋ถ€์—ฌ๋˜๋Š” ํšŒ์›์˜ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค.

nrNumber

string

Required

Min : 1 , Max : 50

๊ฑฐ๋ž˜ ๊ณ ์œ  ๋ฒˆํ˜ธ.

(์ถฉ์ „) ๊ฑฐ๋ž˜ ์š”์ฒญ ์‹œ ์‘๋‹ต์œผ๋กœ ๋ฐ›์€ ๊ฐ’์ž…๋‹ˆ๋‹ค.

oneTimeToken

string

Required

Length : 16

์ผํšŒ์šฉ Token

์ผํšŒ์šฉ Token ๋ฐœ๊ธ‰ ์š”์ฒญ์‹œ ์‘๋‹ต๋ฐ›์€ ๊ฐ’์ž…๋‹ˆ๋‹ค.

dcvv

string

Required

Length : 3

DCVV

์ผํšŒ์šฉ Token ๋ฐœ๊ธ‰ ์š”์ฒญ์‹œ ์‘๋‹ต๋ฐ›์€ ๊ฐ’์ž…๋‹ˆ๋‹ค.

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.

isPending

boolean

Required

Waiting for charging transaction

(Cancellation of charge) 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 cancellation transaction is completed, and if it fails, it is processed as a charge cancellation failure.

On the day of the request, charge cancellation 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_030

Message

Cancellation not possible for this transaction.

Description

์ถฉ์ „ ์ทจ์†Œ๊ฐ€ ๋ถˆ๊ฐ€๋Šฅํ•œ ๊ฑฐ๋ž˜.


400

Error code

007_040

Message

Cancel request for another method.

Description

์ถฉ์ „ ์ทจ์†Œํ•  ์ถฉ์ „ ๊ฑด์˜ ์ถฉ์ „ ๊ธˆ์•ก ์ง€๋ถˆ ๋ฐฉ์‹์ด ๋‹ค๋ฅธ ๊ฒฝ์šฐ.


400

Error code

007_043

Message

Cancellation request denied due to name mismatch.

Description

์‹œ์Šคํ…œ์— ๋“ฑ๋ก๋œ ํšŒ์› ์ด๋ฆ„๊ณผ ์€ํ–‰๊ณ„์ขŒ ์†Œ์œ ์ž๋ช…์ด ๋‹ค๋ฅธ ์ƒํƒœ์—์„œ ์ทจ์†Œ ์š”์ฒญ์ด ๋“ค์–ด์˜จ ๊ฒฝ์šฐ ๋ฐœ์ƒํ•œ ์—๋Ÿฌ.

Test Data

200 - Success Test


200 - Success Test
400 - Input parameter error
400 - No account registered
400 - ์ถฉ์ „ ์ทจ์†Œ๊ฐ€ ๋ถˆ๊ฐ€๋Šฅํ•œ ๊ฑฐ๋ž˜.
400 - ์ถฉ์ „ ์ทจ์†Œํ•  ์ถฉ์ „ ๊ฑด์˜ ์ถฉ์ „ ๊ธˆ์•ก ์ง€๋ถˆ ๋ฐฉ์‹์ด ๋‹ค๋ฅธ ๊ฒฝ์šฐ.
400 - ์‹œ์Šคํ…œ์— ๋“ฑ๋ก๋œ ํšŒ์› ์ด๋ฆ„๊ณผ ์€ํ–‰๊ณ„์ขŒ ์†Œ์œ ์ž๋ช…์ด ๋‹ค๋ฅธ ์ƒํƒœ์—์„œ ์ทจ์†Œ ์š”์ฒญ์ด ๋“ค์–ด์˜จ ๊ฒฝ์šฐ ๋ฐœ์ƒํ•œ ์—๋Ÿฌ.
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 ์ค‘๋ณต ํ™•์ธํšŒ์› ๋น„๋ฐ€๋ฒˆํ˜ธ ๊ฒ€์ฆํšŒ์› ์ธ์ฆ ์ •๋ณด ์กฐํšŒCheck whether you are subject to AML activitiesFinancial 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)ํšŒ์› ๋“ฑ๋ก ๊ณ„์ขŒ ์กฐํšŒํšŒ์› ๊ณ„์ขŒ ์ •๋ณด ์กฐํšŒ์ž๋™์ถฉ์ „ ๊ณ„์ขŒ ๋“ฑ๋กํšŒ์› ๊ณ„์ขŒ ์‚ญ์ œIssuance of Disposable TokenChargeCancellation of ChargeChecking Result of Charge & Cancellation of ChargeChecking Transaction HistoryํŽธ์˜์  ์ถฉ์ „/์ถœ๊ธˆ ์š”์ฒญApplication 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์ฃผ์นด๋“œ ์„ค์ •์นด๋“œ์— ์—ฐ๊ฒฐ๋œ ๊ฐ€์ƒ๊ณ„์ขŒ ์กฐํšŒ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 ์ค‘๋ณต ํ™•์ธํšŒ์› ๋น„๋ฐ€๋ฒˆํ˜ธ ๊ฒ€์ฆํšŒ์› ์ธ์ฆ ์ •๋ณด ์กฐํšŒCheck whether you are subject to AML activitiesFinancial 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)ํšŒ์› ๋“ฑ๋ก ๊ณ„์ขŒ ์กฐํšŒํšŒ์› ๊ณ„์ขŒ ์ •๋ณด ์กฐํšŒ์ž๋™์ถฉ์ „ ๊ณ„์ขŒ ๋“ฑ๋กํšŒ์› ๊ณ„์ขŒ ์‚ญ์ œ