헥토파이낸셜 개발자센터

Payment Void / Refund API

Cancels or refunds a completed payment. The same endpoint handles both same-day voids and post-settlement refunds.

Test Credentials

API Information

POST/v3/APIPayCancel.do
Content-Typeapplication/json; charset=UTF-8
테스트https://tbezauthapi.settlebank.co.kr/v3/APIPayCancel.do
운영https://ezauthapi.settlebank.co.kr:8081/v3/APIPayCancel.do

Request Parameters

타입 표기법
N숫자A영문H한글AN영문+숫자AHN영문+한글+숫자
예: AN(10) = 영문+숫자, 최대 10byte

Required Parameters

└hdInfoAN(50)Alphanumeric, up to 50 bytes*
Message type code.
*Fixed value
└apiVerAN(4)Alphanumeric, up to 4 bytes*
API version.
*Fixed value
└mercntIdAN(8)Alphanumeric, up to 8 bytes*
Unique merchant identifier assigned by Hecto Financial.
└oldTrNoAN(50)Alphanumeric, up to 50 bytes*
Original transaction reference number (trNo from the capture response).
└ordNoAN(100)Alphanumeric, up to 100 bytes*
Cancellation order number. A new merchant-generated unique identifier for this void/refund request.
└cancelPriceAN(13)Alphanumeric, up to 13 bytes*AES-256AES-256/ECB/PKCS5Padding + Hex
Amount to void or refund.
└reqDayN(8)Numeric, up to 8 bytes*
Request date (yyyyMMdd).
└reqTimeN(6)Numeric, up to 6 bytes*
Request time (HH24MISS).
└signatureAN(200)Alphanumeric, up to 200 bytes*SHA-256(실시간 생성)
SHA-256 hash value for tamper protection.
NOTE

Signature Composition

mercntId + oldTrNo + ordNo + cancelPrice (plaintext) + reqDay + reqTime + hashKey

Optional Parameters

└taxPriceAN(13)Alphanumeric, up to 13 bytesAES-256AES-256/ECB/PKCS5Padding + Hex
Taxable amount for the cancellation. Required for mixed-taxation transactions; omit for full cancellations.
└vatPriceAN(13)Alphanumeric, up to 13 bytesAES-256AES-256/ECB/PKCS5Padding + Hex
VAT amount for the cancellation. Required for mixed-taxation transactions; omit for full cancellations.
└dutyFreePriceAN(13)Alphanumeric, up to 13 bytesAES-256AES-256/ECB/PKCS5Padding + Hex
Tax-exempt amount for the cancellation. Required for mixed-taxation transactions; omit for full cancellations.

Response Parameters

타입 표기법
N숫자A영문H한글AN영문+숫자AHN영문+한글+숫자
예: AN(10) = 영문+숫자, 최대 10byte
└resultCdN(1)Numeric, up to 1 bytes*0
Result code.
0: Success -1: Failure
└errCdAN(5)Alphanumeric, up to 5 bytes*0000
Error code. See error code reference.
└resultMsgAN(200)Alphanumeric, up to 200 bytes*Success
Human-readable result message.
└oldTrNoAN(50)Alphanumeric, up to 50 bytes*STFP_PNPTms00001t00220922182409M1962430
Original transaction reference number.
└trNoAN(50)Alphanumeric, up to 50 bytes*STFP_PNPTms00001t00220404134307M1550602
Void/refund transaction reference number.
└cancelPriceN(13)Numeric, up to 13 bytes*9000
Voided/refunded amount.
└disntCancelPriceN(13)Numeric, up to 13 bytes*1000
Promotional discount amount reversed.
└payCancelPriceN(13)Numeric, up to 13 bytes*8000
Net settlement amount reversed (excluding discounts).
└criPriceN(13)Numeric, up to 13 bytes*7000
Cash receipt cancellation amount (cash-equivalent portion only).
└criTaxVatPriceN(13)Numeric, up to 13 bytes*5500
Cash receipt taxable cancellation amount (inclusive of VAT).
└criDutyFreePiceN(13)Numeric, up to 13 bytes*1500
Cash receipt tax-exempt cancellation amount.
└cancelDayN(8)Numeric, up to 8 bytes*20190222
Void/refund date (yyyyMMdd).

Request Example

{
  "hdInfo": "IA_CANCEL",
  "apiVer": "3.0",
  "mercntId": "ms00003t",
  "oldTrNo": "STFP_PNPTms00001t00220922182409M1962430",
  "ordNo": "OID201902210001",
  "reqDay": "20190221",
  "reqTime": "142120",
  "cancelPrice": "[AES-256 encrypted amount]",
  "signature": "[SHA-256 hash]"
}
💬

Need technical support?