헥토파이낸셜 개발자센터
ProductsProducts
Payment Gateway
Cards, bank & digital wallets
My Bank Pay
Open banking debit
Easy Cash Payment
Stored-account payments
White-Label Payments
White-label checkout
Cash Receipt
Firm Banking
VAN Virtual Account
Prepaid Wallet
Integrate with LLMs
MCP server & AI chatbot
API & SDKAPI & SDK
Payment Gateway
Cards, bank & digital wallets
My Bank Pay
Open banking debit
Easy Cash Payment
Stored-account payments
White-Label Payments
White-label checkout
Cash Receipt
Firm Banking
VAN Virtual Account
Prepaid Wallet
블로그Blog
Service Status
Payment Gateway
My Bank Pay
Easy Cash Payment
White-Label Payments
Cash Receipt
Firm Banking
VAN Virtual Account
Prepaid Wallet
Integrate with LLMs
MCP 서버 및 AI 챗봇
Payment Gateway
My Bank Pay
Easy Cash Payment
White-Label Payments
Cash Receipt
Firm Banking
VAN Virtual Account
Prepaid Wallet
Blog
Technical blog & news
Service Status
Incidents and scheduled maintenance
Payment Gateway
Before You BeginServers & NetworkIntegration OverviewWebhooksCancellations & RefundsGo Live
Checkout IntegrationJavaScript SDKForm-Based Checkout Integration
Credit Card CheckoutCredit Card Direct APICredit Card WebhookCredit Card Deferred CaptureRegister Card (Billkey Checkout)Charge with Payment TokenDelete Payment TokenCancel Charge
Bank Transfer CheckoutBank Transfer WebhookBank Transfer Deferred CaptureCancel Bank Transfer
Virtual Account CheckoutVirtual Account Deposit WebhookIssue Virtual AccountFixed/Unlimited Virtual AccountModify Virtual AccountCancel Virtual AccountDeposit LookupRefund Virtual AccountSimulate Deposit
010 Virtual Account Overview010 Virtual Account CheckoutPhone Ownership Verification — RequestPhone Ownership Verification — ConfirmDuplicate Amount CheckIssue 010 Virtual AccountCancel 010 Virtual AccountRefund 010 Virtual Account010 Virtual Account Deposit WebhookSimulate 010 Deposit
Mobile Payment CheckoutMobile Payment WebhookMobile Payment — Two-Step CaptureMobile Recurring PaymentCancel Mobile PaymentRefund Mobile Payment
Gift Card CheckoutGift Card WebhookCancel Gift Card Payment
T-money CheckoutT-money WebhookCancel T-money Payment
Point Damoa CheckoutPoint Damoa WebhookPoint Damoa Deferred CaptureCancel Point Damoa Payment
Digital Wallets OverviewPAYCO CheckoutPAYCO SandboxSamsung Pay CheckoutKakaoPay CheckoutNaverPay CheckoutTossPay CheckoutDigital Wallet WebhookCancel Digital Wallet PaymentWallet Recurring PaymentSubscription StatusCancel Subscription
Real-time Transaction LookupReceipt (Sales Slip) Inquiry (No Auth)Receipt (Sales Slip) Inquiry (Auth)Transaction ReconciliationSettlement ReconciliationSub-Merchant RegistrationPreferential Settlement (SME)SME Refund Adjustment
Error CodesCard Issuer CodesBank CodesPayment Method CodesVirtual Account Bank Codes
My Bank Pay
Before You BeginServers & NetworkIntegration Overview
Checkout SDK
My Bank Pay — AuthenticateMy Bank Pay — CaptureMy Bank Pay — CancelMy Bank Pay — Network Cancel
Transaction Result LookupTransaction HistoryCash Receipt Lookup
Create Recurring TokenCharge via Recurring TokenCancel Subscription
Error CodesBank CodesBank Maintenance Schedule
Easy Cash Payment
Before You BeginServers & NetworkFirm Banking Integration Flow
Mobile Identity Verification — RequestMobile Identity Verification — ConfirmAccount Holder Name Lookup IAccount Holder Name Lookup IIAccount Holder Name (with Amount)Account Ownership VerificationAccount Ownership — RequestAccount Ownership — ConfirmIVR Verification — RequestIVR Verification — ConfirmOwnership Verification HistoryPayment PIN Verification
Register AccountDeregister AccountSelf-Service Account RegistrationKFTC Deregistered Account Lookup
Capture PaymentCancel / Refund PaymentSend RemittanceRemittance Account Balance
Create Recurring TokenCharge via Recurring TokenCancel SubscriptionSubscription DetailsSubscription History
Transaction Result LookupTransaction HistoryAccount ListSupported BanksBank Maintenance CheckOwnership Verification Bank MaintenanceConnectivity Test
Before You BeginServers & NetworkOpen Banking Integration Flow
Register AccountRegister Open Banking AccountDeregister Open Banking Service
Capture PaymentCancel PaymentSend Remittance
Submit Refund ClaimRefund Claim Status
Transaction Result LookupTransaction HistoryAccount ListWithdrawal Limit
Decline Code ReferenceBank Code ReferenceBank Maintenance Schedule
White-Label Payments
Before You BeginServers & NetworkIntegration Overview
Payment CheckoutCapture PaymentCancellations & Refunds
Inquiry
Error CodesBank CodesBank Maintenance Schedule
Cash Receipt
Before You BeginServers & NetworkIntegration Overview
Issue Cash ReceiptCancel Cash Receipt
Issuance Error LookupIssuance Status Lookup
Reprocessing RegistrationReprocessing Result Lookup
Reference
Firm Banking
Before You BeginIntegration Overview
Connection Management
Interbank TransferCollection TransferCollection Account SetupReserve Transfer (SC Bank)Trust Deposit (Woori Bank)
Transfer Failure WebhookTransaction Statement WebhookBill Statement WebhookBill Statement — Missing SequenceReserve Transfer Result Webhook (SC)Transfer Failure — Missing SequenceTransaction Detail — Missing Sequence
Account Holder Name LookupTransfer Result LookupBalance LookupReserve Transfer Result (SC)Auto Transfer Result (SC)
Transfer ReconciliationCollection ReconciliationWebhook Delivery Status
Connection Management
FX RemittanceCancel FX RemittanceFX Remittance Result WebhookFX Remittance Result — Missing SequenceFX Remittance (MX)FX Remittance Result Webhook (MX)FX Remittance — Missing Sequence (MX)
FX Same-Bank Holder LookupFX Account Holder LookupExchange Rate LookupExchange Rate Lookup (KEB)FX Remittance Result LookupFX Balance Lookup
FX Remittance ReconciliationFX Auto Transfer ReconciliationFX Same-Bank Remittance Reconciliation
FX Transaction Statement WebhookFX Transaction Statement — Missing Sequence
VAN Virtual Account
Getting Started with VAVSCommunication and Message FormatCommon Header
Recipient InquiryDeposit and Cancellation
RemittanceDeposit Balance Inquiry
Reconciliation
Account Holder InquiryActual Depositor NotificationActual Depositor FileMissing Actual Depositor InquiryWithdrawal Account Registration
Bank CodesResponse CodesChannel CodesBank Operating Hours
Prepaid Wallet
Before You BeginServers & NetworkIntegration Overview
Member Registration UIMy Account UI
Spend BalanceVoid SpendSend Money GiftRevoke Points
Balance LookupBalance OptionsBalance DetailsBalance by Top-upWithdrawable BalanceTransaction ListTransaction DetailsTransaction Details by StoreMember DetailsExpiring PointsTop-up Methods
Top-upCancel Top-upWithdraw FundsPending Withdrawal
Error CodesTransaction Type Codes

Tools

Encryption Test
Payment Gateway
Before You BeginServers & NetworkIntegration OverviewWebhooksCancellations & RefundsGo Live
Checkout IntegrationJavaScript SDKForm-Based Checkout Integration
Credit Card CheckoutCredit Card Direct APICredit Card WebhookCredit Card Deferred CaptureRegister Card (Billkey Checkout)Charge with Payment TokenDelete Payment TokenCancel Charge
Bank Transfer CheckoutBank Transfer WebhookBank Transfer Deferred CaptureCancel Bank Transfer
Virtual Account CheckoutVirtual Account Deposit WebhookIssue Virtual AccountFixed/Unlimited Virtual AccountModify Virtual AccountCancel Virtual AccountDeposit LookupRefund Virtual AccountSimulate Deposit
010 Virtual Account Overview010 Virtual Account CheckoutPhone Ownership Verification — RequestPhone Ownership Verification — ConfirmDuplicate Amount CheckIssue 010 Virtual AccountCancel 010 Virtual AccountRefund 010 Virtual Account010 Virtual Account Deposit WebhookSimulate 010 Deposit
Mobile Payment CheckoutMobile Payment WebhookMobile Payment — Two-Step CaptureMobile Recurring PaymentCancel Mobile PaymentRefund Mobile Payment
Gift Card CheckoutGift Card WebhookCancel Gift Card Payment
T-money CheckoutT-money WebhookCancel T-money Payment
Point Damoa CheckoutPoint Damoa WebhookPoint Damoa Deferred CaptureCancel Point Damoa Payment
Digital Wallets OverviewPAYCO CheckoutPAYCO SandboxSamsung Pay CheckoutKakaoPay CheckoutNaverPay CheckoutTossPay CheckoutDigital Wallet WebhookCancel Digital Wallet PaymentWallet Recurring PaymentSubscription StatusCancel Subscription
Real-time Transaction LookupReceipt (Sales Slip) Inquiry (No Auth)Receipt (Sales Slip) Inquiry (Auth)Transaction ReconciliationSettlement ReconciliationSub-Merchant RegistrationPreferential Settlement (SME)SME Refund Adjustment
Error CodesCard Issuer CodesBank CodesPayment Method CodesVirtual Account Bank Codes
My Bank Pay
Before You BeginServers & NetworkIntegration Overview
Checkout SDK
My Bank Pay — AuthenticateMy Bank Pay — CaptureMy Bank Pay — CancelMy Bank Pay — Network Cancel
Transaction Result LookupTransaction HistoryCash Receipt Lookup
Create Recurring TokenCharge via Recurring TokenCancel Subscription
Error CodesBank CodesBank Maintenance Schedule
Easy Cash Payment
Before You BeginServers & NetworkFirm Banking Integration Flow
Mobile Identity Verification — RequestMobile Identity Verification — ConfirmAccount Holder Name Lookup IAccount Holder Name Lookup IIAccount Holder Name (with Amount)Account Ownership VerificationAccount Ownership — RequestAccount Ownership — ConfirmIVR Verification — RequestIVR Verification — ConfirmOwnership Verification HistoryPayment PIN Verification
Register AccountDeregister AccountSelf-Service Account RegistrationKFTC Deregistered Account Lookup
Capture PaymentCancel / Refund PaymentSend RemittanceRemittance Account Balance
Create Recurring TokenCharge via Recurring TokenCancel SubscriptionSubscription DetailsSubscription History
Transaction Result LookupTransaction HistoryAccount ListSupported BanksBank Maintenance CheckOwnership Verification Bank MaintenanceConnectivity Test
Before You BeginServers & NetworkOpen Banking Integration Flow
Register AccountRegister Open Banking AccountDeregister Open Banking Service
Capture PaymentCancel PaymentSend Remittance
Submit Refund ClaimRefund Claim Status
Transaction Result LookupTransaction HistoryAccount ListWithdrawal Limit
Decline Code ReferenceBank Code ReferenceBank Maintenance Schedule
White-Label Payments
Before You BeginServers & NetworkIntegration Overview
Payment CheckoutCapture PaymentCancellations & Refunds
Inquiry
Error CodesBank CodesBank Maintenance Schedule
Cash Receipt
Before You BeginServers & NetworkIntegration Overview
Issue Cash ReceiptCancel Cash Receipt
Issuance Error LookupIssuance Status Lookup
Reprocessing RegistrationReprocessing Result Lookup
Reference
Firm Banking
Before You BeginIntegration Overview
Connection Management
Interbank TransferCollection TransferCollection Account SetupReserve Transfer (SC Bank)Trust Deposit (Woori Bank)
Transfer Failure WebhookTransaction Statement WebhookBill Statement WebhookBill Statement — Missing SequenceReserve Transfer Result Webhook (SC)Transfer Failure — Missing SequenceTransaction Detail — Missing Sequence
Account Holder Name LookupTransfer Result LookupBalance LookupReserve Transfer Result (SC)Auto Transfer Result (SC)
Transfer ReconciliationCollection ReconciliationWebhook Delivery Status
Connection Management
FX RemittanceCancel FX RemittanceFX Remittance Result WebhookFX Remittance Result — Missing SequenceFX Remittance (MX)FX Remittance Result Webhook (MX)FX Remittance — Missing Sequence (MX)
FX Same-Bank Holder LookupFX Account Holder LookupExchange Rate LookupExchange Rate Lookup (KEB)FX Remittance Result LookupFX Balance Lookup
FX Remittance ReconciliationFX Auto Transfer ReconciliationFX Same-Bank Remittance Reconciliation
FX Transaction Statement WebhookFX Transaction Statement — Missing Sequence
VAN Virtual Account
Getting Started with VAVSCommunication and Message FormatCommon Header
Recipient InquiryDeposit and Cancellation
RemittanceDeposit Balance Inquiry
Reconciliation
Account Holder InquiryActual Depositor NotificationActual Depositor FileMissing Actual Depositor InquiryWithdrawal Account Registration
Bank CodesResponse CodesChannel CodesBank Operating Hours
Prepaid Wallet
Before You BeginServers & NetworkIntegration Overview
Member Registration UIMy Account UI
Spend BalanceVoid SpendSend Money GiftRevoke Points
Balance LookupBalance OptionsBalance DetailsBalance by Top-upWithdrawable BalanceTransaction ListTransaction DetailsTransaction Details by StoreMember DetailsExpiring PointsTop-up Methods
Top-upCancel Top-upWithdraw FundsPending Withdrawal
Error CodesTransaction Type Codes

Tools

Encryption Test

Recurring Billing Info API

Retrieve information for an active recurring billing subscription.


Recurring Billing Info

Retrieve account details and status for an active recurring billing subscription.

API Information

POST/v1/api/regular/info
Content-Typeapplication/json; charset=UTF-8
Sandboxhttps://tbnpay.settlebank.co.kr/v1/api/regular/info
Productionhttps://npay.settlebank.co.kr/v1/api/regular/info

Request Parameters

Type Notation
NNumericAAlphabeticHKoreanANAlphanumericAHNAlphanumeric + Korean
e.g. AN(10) = alphanumeric, up to 10 bytes
└hdInfoAN(50)Alphanumeric, up to 50 bytes*Message information code.
Message information code.
*Fixed value
Parameter
Type
Description
Example
hdInfoRequired
AN(50)
Message information code.
* Fixed value
SPAY_SO00_1.0
└mchtIdAN(8)Alphanumeric, up to 8 bytes*Merchant ID.
Merchant ID.
Parameter
Type
Description
Example
mchtIdRequired
AN(8)
Merchant ID.
midtest
└mchtCustIdAN(100)Alphanumeric, up to 100 bytes*AES-256AES-256/ECB/PKCS5Padding + Base64Customer ID.
Customer ID.
Parameter
Type
Description
Example
mchtCustIdRequired
AN(100)
AES-256
Customer ID.
kimhecto
└reqDtAN(8)Alphanumeric, up to 8 bytes*Request date (yyyyMMdd).
Request date (yyyyMMdd).
Parameter
Type
Description
Example
reqDtRequired
AN(8)
Request date (yyyyMMdd).
20191231
└reqTmAN(6)Alphanumeric, up to 6 bytes*Request time (HH24MISS).
Request time (HH24MISS).
Parameter
Type
Description
Example
reqTmRequired
AN(6)
Request time (HH24MISS).
120000
└rglChrgKeyAN(32)Alphanumeric, up to 32 bytes*Unique recurring billing key.
Unique recurring billing key.
Parameter
Type
Description
Example
rglChrgKeyRequired
AN(32)
Unique recurring billing key.
-
└pktHashAN(200)Alphanumeric, up to 200 bytes*SHA-256SHA-256 HMAC signature.(auto-generated)
SHA-256 HMAC signature.
Parameter
Type
Description
Example
pktHashRequired
AN(200)
SHA-256
SHA-256 HMAC signature.
-
NOTE

Signature composition

mchtId + mchtCustId + reqDt + reqTm + rglChrgKey + hashKey

Response Parameters

└outStatCdAN(4)Alphanumeric, up to 4 bytes*Transaction status code.0021
Transaction status code.
0021: Success 0031: Failure
Parameter
Type
Description
Example
outStatCdRequired
AN(4)
Transaction status code.
0021: Success / 0031: Failure
0021
└outRsltCdAN(4)Alphanumeric, up to 4 bytes*Decline code.0000
Decline code.
*ST08: If the account is already enrolled, existing account information is returned
Parameter
Type
Description
Example
outRsltCdRequired
AN(4)
Decline code.
* ST08: If the account is already enrolled, existing account information is returned
0000
└outRsltMsgAN(100)Alphanumeric, up to 100 bytes*Result message.Processed successfully.
Result message.
Parameter
Type
Description
Example
outRsltMsgRequired
AN(100)
Result message.
Processed successfully.
└bankCdAN(3)Alphanumeric, up to 3 bytesBank code.011
Bank code.
Parameter
Type
Description
Example
bankCd
AN(3)
Bank code.
011
└bankNmAN(45)Alphanumeric, up to 45 bytesBank name (Korean: 3 bytes per character).국민은행
Bank name (Korean: 3 bytes per character).
Parameter
Type
Description
Example
bankNm
AN(45)
Bank name (Korean: 3 bytes per character).
국민은행
└custAcntNoAN(15)Alphanumeric, up to 15 bytesAccount number (masked).234*********123
Account number (masked).
Parameter
Type
Description
Example
custAcntNo
AN(15)
Account number (masked).
234*********123
└useStDtAN(8)Alphanumeric, up to 8 bytesRecurring billing start date (yyyyMMdd).20210830
Recurring billing start date (yyyyMMdd).
Parameter
Type
Description
Example
useStDt
AN(8)
Recurring billing start date (yyyyMMdd).
20210830
└useEdDtAN(8)Alphanumeric, up to 8 bytesRecurring billing end date (yyyyMMdd).20991231
Recurring billing end date (yyyyMMdd).
Parameter
Type
Description
Example
useEdDt
AN(8)
Recurring billing end date (yyyyMMdd).
20991231
└rglPmtAmtN(13)Numeric, up to 13 bytesFirst recurring billing charge amount.1000
First recurring billing charge amount.
Parameter
Type
Description
Example
rglPmtAmt
N(13)
First recurring billing charge amount.
1000
└pmtAcmAmtN(13)Numeric, up to 13 bytesCumulative successful billing amount.5000
Cumulative successful billing amount.
Parameter
Type
Description
Example
pmtAcmAmt
N(13)
Cumulative successful billing amount.
5000
└pmtAcmOrdN(13)Numeric, up to 13 bytesNumber of successful billing cycles.5
Number of successful billing cycles.
Parameter
Type
Description
Example
pmtAcmOrd
N(13)
Number of successful billing cycles.
5
└unregDtAN(14)Alphanumeric, up to 14 bytesCancellation datetime (yyyyMMddhhmmss).20210830080000
Cancellation datetime (yyyyMMddhhmmss).
Parameter
Type
Description
Example
unregDt
AN(14)
Cancellation datetime (yyyyMMddhhmmss).
20210830080000
└unregStatCdAN(10)Alphanumeric, up to 10 bytesCancellation reason code.
Cancellation reason code.
EXPORE: Subscription period ended FAIL: Payment failure CANCEL: Merchant cancellation ADMIN: Administrator cancellation
Parameter
Type
Description
Example
unregStatCd
AN(10)
Cancellation reason code.
EXPORE: Subscription period ended / FAIL: Payment failure / CANCEL: Merchant cancellation / ADMIN: Administrator cancellation
-

💬

Need technical support?

Code Samples

HectoFinancial GitHub