Recurring Billing Charge API
Executes a payment using a previously issued recurring billing key (BillKey).
Test Credentials
API Information
POST/v3/APIRegularPayment.do
Content-Type
application/json; charset=UTF-8테스트
https://tbezauthapi.settlebank.co.kr/v3/APIRegularPayment.do운영
https://ezauthapi.settlebank.co.kr:8081/v3/APIRegularPayment.doRequest Parameters
타입 표기법
N숫자A영문H한글AN영문+숫자AHN영문+한글+숫자예: AN(10) = 영문+숫자, 최대 10byte
└hdInfoAN(50)Alphanumeric, up to 50 bytes*Message type code.
Message type code.
*Fixed value
└apiVerAN(4)Alphanumeric, up to 4 bytes*API version.
API version.
*Fixed value
└mercntIdAN(8)Alphanumeric, up to 8 bytes*Unique merchant identifier assigned by Hecto Financial.
Unique merchant identifier assigned by Hecto Financial.
└trDayN(8)Numeric, up to 8 bytes*Transaction date generated at order time (yyyyMMdd).
Transaction date generated at order time (yyyyMMdd).
└trTimeN(6)Numeric, up to 6 bytes*Transaction time generated at order time (HH24MISS).
Transaction time generated at order time (HH24MISS).
└ordNoAN(100)Alphanumeric, up to 100 bytes*Merchant-generated order number for this billing cycle.
Merchant-generated order number for this billing cycle.
└reqDayN(8)Numeric, up to 8 bytes*Request date (yyyyMMdd).
Request date (yyyyMMdd).
└reqTimeN(6)Numeric, up to 6 bytes*Request time (HH24MISS).
Request time (HH24MISS).
└trPriceAN(13)Alphanumeric, up to 13 bytes*
AES-256AES-256/ECB/PKCS5Padding + HexTransaction amount for this billing cycle.Transaction amount for this billing cycle.
└taxPriceAN(13)Alphanumeric, up to 13 bytes
AES-256AES-256/ECB/PKCS5Padding + HexTaxable amount. Required for mixed-taxation transactions.Taxable amount. Required for mixed-taxation transactions.
└vatPriceAN(13)Alphanumeric, up to 13 bytes
AES-256AES-256/ECB/PKCS5Padding + HexVAT amount. Required for mixed-taxation transactions.VAT amount. Required for mixed-taxation transactions.
└dutyFreePriceAN(13)Alphanumeric, up to 13 bytes
AES-256AES-256/ECB/PKCS5Padding + HexTax-exempt amount. Required for mixed-taxation transactions.Tax-exempt amount. Required for mixed-taxation transactions.
└containerDepositAN(5)Alphanumeric, up to 5 bytes
AES-256AES-256/ECB/PKCS5Padding + HexContainer deposit amount. Excluded from cash receipt.Container deposit amount. Excluded from cash receipt.
└productNmAN(95)Alphanumeric, up to 95 bytes*Product or service name.
Product or service name.
└dutyFreeYnA(1)Alphabetic, up to 1 bytes*Tax exemption flag.
Tax exemption flag.
Y: Tax-exempt N: Taxable G: Mixed taxation└criPsblYnA(1)Alphabetic, up to 1 bytesCash receipt issuance eligibility. Defaults to Y if omitted.
Cash receipt issuance eligibility. Defaults to Y if omitted.
Y: Eligible N: Not eligible└addDeductionYnA(1)Alphabetic, up to 1 bytesAdditional tax deduction category.
Additional tax deduction category.
Y: Public transit C: Books/cultural events N: None└regularpayKeyAN(32)Alphanumeric, up to 32 bytes*Recurring billing key (BillKey) issued at enrollment.
Recurring billing key (BillKey) issued at enrollment.
└signatureAN(200)Alphanumeric, up to 200 bytes*
SHA-256SHA-256 hash value for tamper protection.(실시간 생성)SHA-256 hash value for tamper protection.
NOTE
Signature Composition
mercntId + ordNo + trDay + reqDay + reqTime + trPrice (plaintext) + regularpayKey + hashKey
└custParam1AN(256)Alphanumeric, up to 256 bytesMerchant-defined data field 1. Echoed back in transaction history.
Merchant-defined data field 1. Echoed back in transaction history.
└custParam2AN(256)Alphanumeric, up to 256 bytesMerchant-defined data field 2. Echoed back in transaction history.
Merchant-defined data field 2. Echoed back in transaction history.
└custParam3AN(256)Alphanumeric, up to 256 bytesMerchant-defined data field 3. Echoed back in transaction history.
Merchant-defined data field 3. Echoed back in transaction history.
└custParam4AN(256)Alphanumeric, up to 256 bytesMerchant-defined data field 4. Echoed back in transaction history.
Merchant-defined data field 4. Echoed back in transaction history.
└payLimitCdAN(1)Alphanumeric, up to 1 bytesPayment limit code.
Payment limit code.
Response Parameters
└resultCdN(1)Numeric, up to 1 bytes*Result code.
0Result code.
0: Success -1: Failure└errCdAN(5)Alphanumeric, up to 5 bytes*Error code. See error code reference.
0000Error code. See error code reference.
└resultMsgAN(200)Alphanumeric, up to 200 bytes*Human-readable result message.
SuccessHuman-readable result message.
└trNoA(50)Alphabetic, up to 50 bytes*Hecto Financial transaction reference number.
STFP_PNPTms00001t00220922182409M1962430Hecto Financial transaction reference number.
└ordNoAN(100)Alphanumeric, up to 100 bytes*Order number from the request.
OID201902210001Order number from the request.
└trPriceN(13)Numeric, up to 13 bytes*Original requested transaction amount.
15000Original requested transaction amount.
└discntPriceN(13)Numeric, up to 13 bytes*Promotional discount amount applied.
1000Promotional discount amount applied.
└payPriceN(13)Numeric, up to 13 bytes*Final settlement amount (after discounts).
14000Final settlement amount (after discounts).
└regularStatusA(1)Alphabetic, up to 1 bytesRecurring billing status flag.
RRecurring billing status flag.
R: Retry required C: Cancellation required└criPriceN(13)Numeric, up to 13 bytes*Cash receipt issuance amount.
13000Cash receipt issuance amount.
└criTaxVatPriceN(13)Numeric, up to 13 bytes*Cash receipt taxable amount (inclusive of VAT).
11000Cash receipt taxable amount (inclusive of VAT).
└criDutyFreePriceN(13)Numeric, up to 13 bytes*Cash receipt tax-exempt amount.
2000Cash receipt tax-exempt amount.
└ordDayN(8)Numeric, up to 8 bytes*Order date (yyyyMMdd).
20190221Order date (yyyyMMdd).
└ordTimeN(6)Numeric, up to 6 bytes*Order time (HH24MISS).
142120Order time (HH24MISS).
└trDayN(8)Numeric, up to 8 bytes*Transaction date (yyyyMMdd).
20190221Transaction date (yyyyMMdd).
└trTimeN(6)Numeric, up to 6 bytes*Transaction time (HH24MISS).
142122Transaction time (HH24MISS).
Need technical support?
Code Samples
HectoFinancial GitHubAPI Test