Payment Capture API

Executes the direct debit using the authentication number (authNo) received from the checkout.

Authentication Expiry

The capture API must be called within 10 minutes of checkout authentication. Authentication data expires after 10 minutes.

Test Credentials


API Information

POST/v3/APIPayApprov.do
Content-Typeapplication/json; charset=UTF-8
테스트https://tbezauthapi.settlebank.co.kr/v3/APIPayApprov.do
운영https://ezauthapi.settlebank.co.kr:8081/v3/APIPayApprov.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.
authNoAN(20)Alphanumeric, up to 20 bytes*
Authentication number received from the checkout callback.
reqDayN(8)Numeric, up to 8 bytes*
Request date (yyyyMMdd).
reqTimeN(6)Numeric, up to 6 bytes*
Request time (HH24MISS).
custParam1AN(128)Alphanumeric, up to 128 bytes
Merchant-defined data field 1. Echoed back in transaction history.
custParam2AN(128)Alphanumeric, up to 128 bytes
Merchant-defined data field 2. Echoed back in transaction history.
custParam3AN(128)Alphanumeric, up to 128 bytes
Merchant-defined data field 3. Echoed back in transaction history.
custParam4AN(128)Alphanumeric, up to 128 bytes
Merchant-defined data field 4. Echoed back in transaction history.
signatureAN(200)Alphanumeric, up to 200 bytes*SHA-256(실시간 생성)
SHA-256 hash value for tamper protection.
NOTE

Signature Composition

mercntId + authNo + reqDay + reqTime + hashKey

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.
mercntIdAN(8)Alphanumeric, up to 8 bytes*ms00003t
Merchant ID assigned by Hecto Financial.
ordNoAN(100)Alphanumeric, up to 100 bytes*ORDER20260107143000
Merchant order number.
trNoAN(50)Alphanumeric, up to 50 bytes*STFP_PNPTms00001t00220922182409M1962430
Hecto Financial transaction reference number.
trPriceN(13)Numeric, up to 13 bytes*15000
Original requested transaction amount.
discntPriceN(13)Numeric, up to 13 bytes*1000
Promotional discount amount applied.
payPriceN(13)Numeric, up to 13 bytes*14000
Final settlement amount (after discounts).
criPriceN(13)Numeric, up to 13 bytes*13000
Cash receipt issuance amount (cash-equivalent portion only).
criTaxVatPriceN(13)Numeric, up to 13 bytes*11000
Cash receipt taxable amount (inclusive of VAT).
criDutyFreePriceN(13)Numeric, up to 13 bytes*2000
Cash receipt tax-exempt amount.
trDayN(8)Numeric, up to 8 bytes*20190221
Capture date (yyyyMMdd).
trTimeN(6)Numeric, up to 6 bytes*142120
Capture time (HH24MISS).
regularpayKeyAN(32)Alphanumeric, up to 32 bytes
Recurring billing key issued when regularpayYn=Y was set at checkout.
bankAcctNoAN(20)Alphanumeric, up to 20 bytes123*****789
Masked bank account number.
bankCdAN(3)Alphanumeric, up to 3 bytes011
Bank code.

Request Example

{
  "hdInfo": "IA_APPROV",
  "apiVer": "3.0",
  "mercntId": "ms00003t",
  "authNo": "PAR20190220000000001",
  "reqDay": "20260107",
  "reqTime": "143000",
  "custParam1": "",
  "custParam2": "",
  "custParam3": "",
  "custParam4": "",
  "signature": "6b86b273ff34fce19d6b804eff5a3f5747ada4eaa22f1d49c01e52ddb7875b4b"
}

Response Examples

Success

{
  "resultCd": "0",
  "errCd": "0000",
  "resultMsg": "Success",
  "mercntId": "ms00003t",
  "ordNo": "ORDER20260107143000",
  "trNo": "STFP_PNPTms00001t00220922182409M1962430",
  "trPrice": "15000",
  "discntPrice": "1000",
  "payPrice": "14000",
  "criPrice": "13000",
  "criTaxVatPrice": "11000",
  "criDutyFreePrice": "2000",
  "trDay": "20260107",
  "trTime": "143025",
  "bankCd": "011",
  "bankAcctNo": "123*****789"
}

Failure

{
  "resultCd": "-1",
  "errCd": "E1001",
  "resultMsg": "Invalid authentication number."
}
💬

Need technical support?