헥토파이낸셜 개발자센터

Mobile Recurring Payment API

Mobile Recurring Payment is a service that uses the bill key (billKey) issued after the first payment approval to charge for subsequent payments.

Test Key Information

API Information

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

Important Notes

NOTE

Monthly Recurring Payment Flow

1) First payment checkout request (autoPayType='M') → 2) billKey issued → 3) Use this API for subsequent payments
  • For the first payment, set autoPayType to M in the request parameters to receive a billKey.
  • For subsequent payments, set the issued billKey in the request parameters.
  • The transaction amount and product name for subsequent payments must be the same as the first payment.

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_ma: Monthly recurring 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 (B1: Recurring renewal)
└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
└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 + trdAmt (plaintext) + hashKey
└emailAN(60)Alphanumeric, up to 60 bytes*
Customer email address
└mUserIdAHN(50)Alphanumeric + Korean, up to 50 bytes*
Merchant customer ID
└crcCdA(3)Alphabetic, up to 3 bytes*
Currency code
*Fixed value
└trdAmtN(12)Numeric, up to 12 bytes*AES-256AES-256/ECB/PKCS5Padding + Base64
Transaction amount (must match the first payment)
└prdtNmAHN(128)Alphanumeric + Korean, up to 128 bytes*
Product name (must match the first payment)
└sellerNmAHN(50)Alphanumeric + Korean, up to 50 bytes
Seller name
└ordNmAHN(50)Alphanumeric + Korean, up to 50 bytes*
Orderer name
└billKeyAN(50)Alphanumeric, up to 50 bytes*
Bill key issued by Hecto Financial

Response Parameters

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

params Object

└mchtIdAN(10)Alphanumeric, up to 10 bytes*nxhp_sb_ma
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*B1
Business type code
└encCdN(2)Numeric, up to 2 bytes*23
Encryption type code
└mchtTrdNoAN(100)Alphanumeric, up to 100 bytes*ORDER20211231100000
Merchant order number
└trdNoAN(40)Alphanumeric, up to 40 bytes*STFP_PGMPnxhp_sb_ma0211129135810M1494620
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
└telCoA(3)Alphabetic, up to 3 bytesAES-256AES-256/ECB/PKCS5PaddingSKT
Carrier
*실제 응답값은 AES-256 암호화된 값입니다. 복호화 후 사용하세요.
└trdAmtN(12)Numeric, up to 12 bytes*AES-256AES-256/ECB/PKCS5Padding1000
Transaction amount
*실제 응답값은 AES-256 암호화된 값입니다. 복호화 후 사용하세요.
└billKeyAN(50)Alphanumeric, up to 50 bytes*MO0123456789
Value from the request, returned as-is
💬

Need technical support?