헥토파이낸셜 개발자센터

Refund Mobile Payment API

This API requests a refund when cancellation is no longer possible because the cancellable period (current month) has passed.

Test Key Information

API Information

POST/spay/APIRefund.do
Content-Typeapplication/json
테스트https://tbgw.settlebank.co.kr/spay/APIRefund.do
운영https://gw.settlebank.co.kr/spay/APIRefund.do

Important Notes

NOTE

Service Registration Required

To use the Mobile Payment Refund service, prior service registration is required. Please contact your Hecto Financial sales representative to apply for the refund service.

Mobile Payment Refund Important Notes

Refunds are available from the month following the payment. The refund amount is transferred to the customer's bank account.
  • Current month: Use the Cancel API
  • Following month onwards: Use the Refund API (e.g., a payment approved on 2023-06-30 requires the Refund API from 2023-07-01)
  • The customer's refund bank account information is required for processing.
  • Partial refund: Increment the cancellation sequence (cnclOrd) sequentially for each request.

Request Parameters

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

params Object

└mchtIdAN(10)Alphanumeric, up to 10 bytes*
Unique merchant ID assigned by Hecto Financial
nxhp_sb_il: Mobile Payment sandbox
└verAN(4)Alphanumeric, up to 4 bytes*
Message version
*Fixed value
└methodA(2)Alphabetic, up to 2 bytes*
Payment method
*Fixed value (MP: Mobile Payment)
└bizTypeAN(2)Alphanumeric, up to 2 bytes*
Business type code
*Fixed value (C1: Refund)
└encCdN(2)Numeric, up to 2 bytes*
Encryption type code
*Fixed value
└mchtTrdNoAN(100)Alphanumeric, up to 100 bytes*
Unique order number generated by the merchant for the refund request
└trdDtN(8)Numeric, up to 8 bytes*
Request date (YYYYMMDD)
└trdTmN(6)Numeric, up to 6 bytes*
Request time (HHMMSS)
└mobileYnA(1)Alphabetic, up to 1 bytes
Mobile indicator
Y: Mobile web/app N: PC or other
└osTypeA(1)Alphabetic, up to 1 bytes
OS type
A: Android I: iOS W: Windows M: Mac E: Other

data Object

└pktHashAN(64)Alphanumeric, up to 64 bytes*SHA-256(실시간 생성)
Hash value generated using SHA256
NOTE

Hash Generation Combination

trdDt + trdTm + mchtId + mchtTrdNo + cnclAmt (plaintext) + hashKey
└orgTrdNoAN(40)Alphanumeric, up to 40 bytes*
Transaction number issued by Hecto Financial at the time of payment
└crcCdA(3)Alphabetic, up to 3 bytes*
Currency code
*Fixed value
└cnclOrdN(3)Numeric, up to 3 bytes*
Cancellation sequence (starts at 001; use 002 for the 2nd partial refund)
└cnclAmtN(12)Numeric, up to 12 bytes*AES-256AES-256/ECB/PKCS5Padding + Base64
Refund amount
└taxTypeCdA(1)Alphabetic, up to 1 bytes
Tax exemption status
N: Taxable Y: Tax-exempt G: Mixed taxation
└taxAmtN(12)Numeric, up to 12 bytesAES-256AES-256/ECB/PKCS5Padding + Base64
Taxable amount within the refund amount (required for mixed taxation)
└vatAmtN(12)Numeric, up to 12 bytesAES-256AES-256/ECB/PKCS5Padding + Base64
VAT amount within the refund amount (required for mixed taxation)
└taxFreeAmtN(12)Numeric, up to 12 bytesAES-256AES-256/ECB/PKCS5Padding + Base64
Tax-free amount within the refund amount (required for mixed taxation)
└refundBankCdAN(3)Alphanumeric, up to 3 bytes*
Bank code for the refund account
*Refer to financial institution codes
└refundAcntNoN(16)Numeric, up to 16 bytes*AES-256AES-256/ECB/PKCS5Padding + Base64
Refund account number
└refundDpstrNmAHN(50)Alphanumeric + Korean, up to 50 bytes*
Account holder name of the refund account
└cnclRsnAHN(255)Alphanumeric + Korean, up to 255 bytes
Refund reason

Response Parameters

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

params Object

└mchtIdAN(10)Alphanumeric, up to 10 bytes*nxhp_sb_il
Merchant ID
└verAN(4)Alphanumeric, up to 4 bytes*0A19
Message version
└methodA(2)Alphabetic, up to 2 bytes*MP
Payment method
└bizTypeAN(2)Alphanumeric, up to 2 bytes*C1
Business type code
└encCdN(2)Numeric, up to 2 bytes*23
Encryption type code
└mchtTrdNoAN(100)Alphanumeric, up to 100 bytes*REFUND20211231100000
Order number generated by the merchant for the refund request
└trdNoAN(40)Alphanumeric, up to 40 bytes*STFP_PGMPnxhp_sb_il0211129135810M1494620
Hecto Financial transaction number
└trdDtN(8)Numeric, up to 8 bytes*20211231
Request date (YYYYMMDD)
└trdTmN(6)Numeric, up to 6 bytes*100000
Request time (HHMMSS)
└outStatCdAN(4)Alphanumeric, up to 4 bytes*0021
Transaction status code (success/failure)
0021: Success 0031: Failure
└outRsltCdAN(4)Alphanumeric, up to 4 bytes*0000
Result code
└outRsltMsgAHN(200)Alphanumeric + Korean, up to 200 bytes*Processed successfully.
Result message

data Object

└pktHashAN(64)Alphanumeric, up to 64 bytes*f395b6725a9a18...
Hash value from the request, returned as-is
└orgTrdNoAN(40)Alphanumeric, up to 40 bytes*STFP_PGMPnxhp_sb_il0211129135810M1494620
Transaction number issued by Hecto Financial at the time of payment
└cnclAmtN(12)Numeric, up to 12 bytes*AES-256AES-256/ECB/PKCS5Padding1000
Refund amount
*실제 응답값은 AES-256 암호화된 값입니다. 복호화 후 사용하세요.
└blcAmtN(12)Numeric, up to 12 bytes*AES-256AES-256/ECB/PKCS5Padding0
Remaining refundable balance for the transaction number upon successful refund
*실제 응답값은 AES-256 암호화된 값입니다. 복호화 후 사용하세요.
💬

Need technical support?