헥토파이낸셜 개발자센터
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

Credit Card Approval API (Deferred Capture)

A credit card payment API that processes authentication and capture separately. After authentication is completed, the capture request is submitted as a separate step.

Test Key Information

Encryption Key: pgSettle30y739r82jtd709yOfZ2yK5K
Hash Key: ST1009281328226982205
* Production credentials are provided by Hecto Financial upon contract completion.

Important Notes

Deferred Capture Method

You must use the merchant order number (mchtTrdNo) created during the authentication request, and authTrdNo must be the transaction number received upon successful authentication.
  • This API performs only the capture step separately after authentication is completed.
  • The merchant order number used during authentication and the authentication transaction number are required.
  • Billkey issuance requires a separate service activation.

API Information

POST/spay/APIService.do
Content-Typeapplication/json
Sandboxhttps://tbgw.settlebank.co.kr/spay/APIService.do
Productionhttps://gw.settlebank.co.kr/spay/APIService.do

Request Parameters

Type Notation
NNumericAAlphabeticHKoreanANAlphanumericAHNAlphanumeric + Korean
e.g. AN(10) = alphanumeric, up to 10 bytes

params Object

└mchtIdAN(12)Alphanumeric, up to 12 bytes*Unique merchant ID assigned by Hecto Financial
Unique merchant ID assigned by Hecto Financial
Parameter
Type
Description
Example
mchtIdRequired
AN(12)
Unique merchant ID assigned by Hecto Financial
nxca_jt_hd
└verAN(4)Alphanumeric, up to 4 bytes*Message version
Message version
*Fixed value
Parameter
Type
Description
Example
verRequired
AN(4)
Message version
* Fixed value
0A19
└methodA(2)Alphabetic, up to 2 bytes*Payment method
Payment method
*Fixed value
Parameter
Type
Description
Example
methodRequired
A(2)
Payment method
* Fixed value
CA
└bizTypeAN(2)Alphanumeric, up to 2 bytes*Business type code
Business type code
*Fixed value (for capture)
Parameter
Type
Description
Example
bizTypeRequired
AN(2)
Business type code
* Fixed value (for capture)
B2
└encCdN(2)Numeric, up to 2 bytes*Encryption type code
Encryption type code
*Fixed value
Parameter
Type
Description
Example
encCdRequired
N(2)
Encryption type code
* Fixed value
23
└mchtTrdNoAN(100)Alphanumeric, up to 100 bytes*Merchant order number (must use the number created during the authentication request)
Merchant order number (must use the number created during the authentication request)
Parameter
Type
Description
Example
mchtTrdNoRequired
AN(100)
Merchant order number (must use the number created during the authentication request)
ORDER20211231100000
└trdDtN(8)Numeric, up to 8 bytes*Request date (YYYYMMDD)
Request date (YYYYMMDD)
Parameter
Type
Description
Example
trdDtRequired
N(8)
Request date (YYYYMMDD)
20211231
└trdTmN(6)Numeric, up to 6 bytes*Request time (HHMMSS)
Request time (HHMMSS)
Parameter
Type
Description
Example
trdTmRequired
N(6)
Request time (HHMMSS)
100000
└mobileYnA(1)Alphabetic, up to 1 bytesMobile indicator
Mobile indicator
Y: Mobile web/app N: PC or other
Parameter
Type
Description
Example
mobileYn
A(1)
Mobile indicator
Y: Mobile web/app / N: PC or other
N
└osTypeA(1)Alphabetic, up to 1 bytesOS type
OS type
A: Android I: IOS W: Windows M: Mac E: Other
Parameter
Type
Description
Example
osType
A(1)
OS type
A: Android / I: IOS / W: Windows / M: Mac / E: Other
W

data Object

└pktHashAN(64)Alphanumeric, up to 64 bytes*SHA-256Hash value generated using SHA256(auto-generated)
Hash value generated using SHA256
Parameter
Type
Description
Example
pktHashRequired
AN(64)
SHA-256
Hash value generated using SHA256
-
NOTE

Hash Generation Combination

trdDt + trdTm + mchtId + mchtTrdNo + trdAmt (plaintext) + hashKey
└trdAmtN(12)Numeric, up to 12 bytes*AES-256AES-256/ECB/PKCS5Padding + Base64Transaction amount
Transaction amount
Parameter
Type
Description
Example
trdAmtRequired
N(12)
AES-256
Transaction amount
1000
└authTrdNoAN(40)Alphanumeric, up to 40 bytes*Authentication transaction number (transaction number received upon successful authentication)
Authentication transaction number (transaction number received upon successful authentication)
Parameter
Type
Description
Example
authTrdNoRequired
AN(40)
Authentication transaction number (transaction number received upon successful authentication)
SOFP_PGMPnxhp_sb_hd0211021111808M1234567

Response Parameters

Type Notation
NNumericAAlphabeticHKoreanANAlphanumericAHNAlphanumeric + Korean
e.g. AN(10) = alphanumeric, up to 10 bytes

params Object

└mchtIdAN(12)Alphanumeric, up to 12 bytes*Unique merchant ID assigned by Hecto Financialnxca_jt_hd
Unique merchant ID assigned by Hecto Financial
Parameter
Type
Description
Example
mchtIdRequired
AN(12)
Unique merchant ID assigned by Hecto Financial
nxca_jt_hd
└verAN(4)Alphanumeric, up to 4 bytes*Message version0A19
Message version
*Fixed value
Parameter
Type
Description
Example
verRequired
AN(4)
Message version
* Fixed value
0A19
└methodA(2)Alphabetic, up to 2 bytes*Payment methodCA
Payment method
*Fixed value
Parameter
Type
Description
Example
methodRequired
A(2)
Payment method
* Fixed value
CA
└bizTypeAN(2)Alphanumeric, up to 2 bytes*Business type codeB2
Business type code
*Fixed value for capture
Parameter
Type
Description
Example
bizTypeRequired
AN(2)
Business type code
* Fixed value for capture
B2
└encCdN(2)Numeric, up to 2 bytes*Encryption type code23
Encryption type code
*Fixed value
Parameter
Type
Description
Example
encCdRequired
N(2)
Encryption type code
* Fixed value
23
└mchtTrdNoAN(100)Alphanumeric, up to 100 bytes*Merchant order numberORDER20211231100000
Merchant order number
Parameter
Type
Description
Example
mchtTrdNoRequired
AN(100)
Merchant order number
ORDER20211231100000
└trdNoAN(40)Alphanumeric, up to 40 bytes*Unique transaction number issued by Hecto FinancialSOFP_PGMPnxhp_sb_hd0211021111808M1234567
Unique transaction number issued by Hecto Financial
Parameter
Type
Description
Example
trdNoRequired
AN(40)
Unique transaction number issued by Hecto Financial
SOFP_PGMPnxhp_sb_hd0211021111808M1234567
└trdDtN(8)Numeric, up to 8 bytes*Request date (YYYYMMDD)20211231
Request date (YYYYMMDD)
Parameter
Type
Description
Example
trdDtRequired
N(8)
Request date (YYYYMMDD)
20211231
└trdTmN(6)Numeric, up to 6 bytes*Request time (HHMMSS)100000
Request time (HHMMSS)
Parameter
Type
Description
Example
trdTmRequired
N(6)
Request time (HHMMSS)
100000
└outStatCdN(4)Numeric, up to 4 bytes*Transaction status code0061
Transaction status code
0061: Authentication success (authentication step) 0021: Capture success (capture step) 0031: Failure
*In the deferred capture method, 0061 is returned at the authentication step and 0021 at the capture step.
Parameter
Type
Description
Example
outStatCdRequired
N(4)
Transaction status code
0061: Authentication success (authentication step) / 0021: Capture success (capture step) / 0031: Failure
* In the deferred capture method, 0061 is returned at the authentication step and 0021 at the capture step.
0061
└outRsltCdN(4)Numeric, up to 4 bytes*Result code. Detailed code provided when transaction status is '0031'0000
Result code. Detailed code provided when transaction status is '0031'
*Refer to the decline code table
Parameter
Type
Description
Example
outRsltCdRequired
N(4)
Result code. Detailed code provided when transaction status is '0031'
* Refer to the decline code table
0000
└outRsltMsgAHN(200)Alphanumeric + Korean, up to 200 bytes*Result message (URL Encoding, UTF-8)Processed successfully.
Result message (URL Encoding, UTF-8)
Parameter
Type
Description
Example
outRsltMsgRequired
AHN(200)
Result message (URL Encoding, UTF-8)
Processed successfully.

data Object

└pktHashAN(64)Alphanumeric, up to 64 bytes*Hash value generated using SHA256
Hash value generated using SHA256
Parameter
Type
Description
Example
pktHashRequired
AN(64)
Hash value generated using SHA256
-
NOTE

Hash Generation Combination

outStatCd + trdDt + trdTm + mchtId + mchtTrdNo + trdAmt (plaintext) + hashKey
└trdAmtN(12)Numeric, up to 12 bytes*AES-256AES-256/ECB/PKCS5PaddingTransaction amount1000
Transaction amount
*Certain response fields are AES-256 encrypted. Decrypt them before use.
Parameter
Type
Description
Example
trdAmtRequired
N(12)
AES-256
Transaction amount
* Certain response fields are AES-256 encrypted. Decrypt them before use.
1000
└mchtParamAHN(4000)Alphanumeric + Korean, up to 4000 bytesRequest value returned as-is in responsename=HongGilDong&age=25
Request value returned as-is in response
Parameter
Type
Description
Example
mchtParam
AHN(4000)
Request value returned as-is in response
name=HongGilDong&age=25
└apprNoN(15)Numeric, up to 15 bytesCredit card approval number30001234
Credit card approval number
Parameter
Type
Description
Example
apprNo
N(15)
Credit card approval number
30001234
└intMonN(2)Numeric, up to 2 bytesCredit card installment months00
Credit card installment months
Parameter
Type
Description
Example
intMon
N(2)
Credit card installment months
00
└fnNmAH(20)Alpha + Korean, up to 20 bytesCredit card company nameWoori Card
Credit card company name
Parameter
Type
Description
Example
fnNm
AH(20)
Credit card company name
Woori Card
└fnCdAN(4)Alphanumeric, up to 4 bytesCredit card company codeLTC
Credit card company code
Parameter
Type
Description
Example
fnCd
AN(4)
Credit card company code
LTC
└pointTrdNoAN(40)Alphanumeric, up to 40 bytesPoint transaction number (for Point Damoa combined payment)STFP_PGCAnxca_jt_il0211129135810M1494620
Point transaction number (for Point Damoa combined payment)
Parameter
Type
Description
Example
pointTrdNo
AN(40)
Point transaction number (for Point Damoa combined payment)
STFP_PGCAnxca_jt_il0211129135810M1494620
└pointTrdAmtN(12)Numeric, up to 12 bytesAES-256AES-256/ECB/PKCS5PaddingPoint transaction amount (for Point Damoa combined payment)1000
Point transaction amount (for Point Damoa combined payment)
*Certain response fields are AES-256 encrypted. Decrypt them before use.
Parameter
Type
Description
Example
pointTrdAmt
N(12)
AES-256
Point transaction amount (for Point Damoa combined payment)
* Certain response fields are AES-256 encrypted. Decrypt them before use.
1000
└cardTrdAmtN(12)Numeric, up to 12 bytesAES-256AES-256/ECB/PKCS5PaddingCredit card payment amount excluding discounts/points4000
Credit card payment amount excluding discounts/points
*Certain response fields are AES-256 encrypted. Decrypt them before use.
Parameter
Type
Description
Example
cardTrdAmt
N(12)
AES-256
Credit card payment amount excluding discounts/points
* Certain response fields are AES-256 encrypted. Decrypt them before use.
4000
└billKeyAN(50)Alphanumeric, up to 50 bytesBillkey (recurring payment token)SBILL_0123456789
Billkey (recurring payment token)
*Requires separate service activation. Contact your account manager.
Parameter
Type
Description
Example
billKey
AN(50)
Billkey (recurring payment token)
* Requires separate service activation. Contact your account manager.
SBILL_0123456789
└dcTrdAmtN(12)Numeric, up to 12 bytes*AES-256AES-256/ECB/PKCS5PaddingDiscount transaction amount1000
Discount transaction amount
*Certain response fields are AES-256 encrypted. Decrypt them before use.
Parameter
Type
Description
Example
dcTrdAmtRequired
N(12)
AES-256
Discount transaction amount
* Certain response fields are AES-256 encrypted. Decrypt them before use.
1000
└dcYnA(1)Alphabetic, up to 1 bytes*Discount indicatorY
Discount indicator
Y: Discount amount exists N: No discount amount
Parameter
Type
Description
Example
dcYnRequired
A(1)
Discount indicator
Y: Discount amount exists / N: No discount amount
Y
└ninstmtTypeCdA(1)Alphabetic, up to 1 bytesInterest-free installment typeY
Interest-free installment type
Y: Interest-free N: Regular installment/full payment
Parameter
Type
Description
Example
ninstmtTypeCd
A(1)
Interest-free installment type
Y: Interest-free / N: Regular installment/full payment
Y
└cardNoAN(20)Alphanumeric, up to 20 bytesMasked card number (optional based on merchant settings)123456******7890
Masked card number (optional based on merchant settings)
Parameter
Type
Description
Example
cardNo
AN(20)
Masked card number (optional based on merchant settings)
123456******7890
└ornPntUseYnA(1)Alphabetic, up to 1 bytesCard company points usage indicatorY
Card company points usage indicator
Y: Used N: Not used
Parameter
Type
Description
Example
ornPntUseYn
A(1)
Card company points usage indicator
Y: Used / N: Not used
Y
└ornPntAmtA(12)Alphabetic, up to 12 bytesAES-256AES-256/ECB/PKCS5PaddingCard company points usage amount1000
Card company points usage amount
*Certain response fields are AES-256 encrypted. Decrypt them before use.
Parameter
Type
Description
Example
ornPntAmt
A(12)
AES-256
Card company points usage amount
* Certain response fields are AES-256 encrypted. Decrypt them before use.
1000

Request Example

{
  "params": {
    "mchtId": "nxca_jt_hd",
    "ver": "0A19",
    "method": "CA",
    "bizType": "B2",
    "encCd": "23",
    "mchtTrdNo": "ORDER20211231100000",
    "trdDt": "20211231",
    "trdTm": "100000",
    "mobileYn": "N",
    "osType": "W"
  },
  "data": {
    "pktHash": "980f95d9b059dd15394eeb39e9d7bc8b3500f9afa4a38bea10877cd46a42caf6",
    "trdAmt": "AES-encrypted amount",
    "authTrdNo": "SOFP_PGMPnxhp_sb_hd0211021111808M1234567"
  }
}

Response Examples

Success Response

{
  "params": {
    "mchtId": "nxca_jt_hd",
    "ver": "0A19",
    "method": "CA",
    "bizType": "B2",
    "encCd": "23",
    "mchtTrdNo": "ORDER20211231100000",
    "trdNo": "SOFP_PGMPnxhp_sb_hd0211021111808M1234567",
    "trdDt": "20211231",
    "trdTm": "100000",
    "outStatCd": "0021",
    "outRsltCd": "0000",
    "outRsltMsg": "Processed successfully."
  },
  "data": {
    "pktHash": "980f95d9b059dd15394eeb39e9d7bc8b3500f9afa4a38bea10877cd46a42caf6",
    "trdAmt": "AES-encrypted amount",
    "apprNo": "30001234",
    "intMon": "00",
    "fnNm": "Woori Card",
    "fnCd": "LTC",
    "billKey": "SBILL_0123456789",
    "dcTrdAmt": "AES-encrypted discount amount",
    "dcYn": "Y",
    "ninstmtTypeCd": "N"
  }
}

Failure Response

{
  "params": {
    "mchtId": "nxca_jt_hd",
    "ver": "0A19",
    "method": "CA",
    "bizType": "B2",
    "encCd": "23",
    "mchtTrdNo": "ORDER20211231100000",
    "trdNo": "",
    "trdDt": "20211231",
    "trdTm": "100000",
    "outStatCd": "0031",
    "outRsltCd": "1001",
    "outRsltMsg": "Missing payment request information"
  },
  "data": {
    "pktHash": "980f95d9b059dd15394eeb39e9d7bc8b3500f9afa4a38bea10877cd46a42caf6"
  }
}

Response Codes

Transaction Status Codes (outStatCd)

CodeDescriptionNote
0061Authentication successAuthentication step of deferred capture method
0021Capture successCapture step of deferred capture method
0031FailureSee outRsltCd for details
0051Virtual account number issuedVirtual account issuance

PG Common Response Codes (outRsltCd)

CodeDescription
0000Processed successfully
0009User cancelled
1001Missing required payment information (merchant ID)
1002Missing required payment information (version)
1003Missing required payment information (payment method)
1004Missing required payment information (business type code)
1005Missing required payment information (merchant order number)
1006Missing required payment information (request date)
1007Missing required payment information (request time)
1008Missing required payment information (hash value)
1009Missing required payment information (transaction amount)
1010Missing required payment information (encryption type code)
1011Missing required payment information (transaction number)
1012Missing required payment information (cancellation amount)
1013Missing required payment information (refund amount)
1101Payment request information length error (merchant ID)
1102Payment request information length error (version)
1103Payment request information length error (payment method)
1104Payment request information length error (business type code)
1105Payment request information length error (merchant order number)
1106Payment request information length error (request date)
1107Payment request information length error (request time)
1108Payment request information length error (hash value)
1109Payment request information length error (transaction amount)
1110Payment request information length error (encryption type code)
1111Payment request information length error (transaction number)
1112Payment request information length error (cancellation amount)
1113Payment request information length error (refund amount)
1901Hash value mismatch error
1902Encrypted field not processed error
2001Security number mismatch
2002Security number input timeout
2003Security number input attempts exceeded
5001Invalid access path (merchant information not found)
5002Invalid access path (merchant inactive)
5003Invalid access path (payment method not contracted)
5004Invalid access path (payment method inactive)
5005Invalid access path (business type not supported)
5006Invalid access path (IP blocked)
9001Gateway internal error
9002Gateway communication error
9003Gateway database error
9004Gateway timeout
9901Issuer system maintenance
9902Issuer system failure
9903Issuer communication error
9904Issuer timeout
9905Issuer response error

Credit Card Specific Response Codes (outRsltCd)

CodeDescription
CA01Issuer under maintenance
CA02Issuer system failure
CA20Invalid card expiration date
CA65Merchant not contracted for authenticated transactions
CA82Please call card company
CA83This transaction cannot be cancelled
💬

Need technical support?

Code Samples

HectoFinancial GitHub
API Test