Modify Virtual Account API

An API to modify the deposit expiration date and transaction amount of an issued virtual account.

Test Key Information


API Information

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

Important Notes

NOTE

Issuance Information Modification Notice

You can modify the deposit expiration date and transaction amount of an already issued virtual account.
  • Available for all virtual account types: Rotating-type, Fixed-type, and Fixed-type Recurring.
  • The maximum deposit expiration date is +365 days 23:59:59 from the current date for Rotating-type and Fixed-type, and unlimited for Fixed-type Recurring (acntType=3).
  • The virtual account number and bank code from the original issuance must be entered accurately.
  • Modification is not possible for virtual accounts whose deposit expiration date has already passed. In such cases, a new issuance is required.

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
nx_mid_il: Rotating-type test nxva_fix: Fixed-type test nxva_fix2: Fixed-type Recurring test
verAN(4)Alphanumeric, up to 4 bytes*
Message version
*Fixed value
methodA(2)Alphabetic, up to 2 bytes*
Payment method
*Fixed value (VA: Virtual Account)
bizTypeAN(2)Alphanumeric, up to 2 bytes*
Business type code
*Fixed value (A1: Issuance Information Modification)
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
bankCdAN(3)Alphanumeric, up to 3 bytes*
Bank code
vAcntNoN(16)Numeric, up to 16 bytes*AES-256AES-256/ECB/PKCS5Padding + Base64
Previously issued virtual account number
expireDateN(14)Numeric, up to 14 bytes*
New deposit expiration date and time (yyyyMMddHHmmss)
*Rotating-type and Fixed-type: maximum +365 days 23:59:59 from the current date. Fixed-type Recurring (acntType=3): unlimited.
trdAmtN(12)Numeric, up to 12 bytes*AES-256AES-256/ECB/PKCS5Padding + Base64
Transaction amount
acntTypeN(1)Numeric, up to 1 bytes*
Virtual account type
1: Rotating-type 2: Fixed-type 3: Fixed-type Recurring

Response Parameters

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

params Object

mchtIdAN(10)Alphanumeric, up to 10 bytes*nx_mid_il
Merchant ID
verAN(4)Alphanumeric, up to 4 bytes*0A19
Message version
methodA(2)Alphabetic, up to 2 bytes*VA
Payment method
bizTypeAN(2)Alphanumeric, up to 2 bytes*A1
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*STBK_0123456789
Hecto Financial transaction number
trdDtN(8)Numeric, up to 8 bytes*20211231
Request date (YYYYMMDD)
trdTmN(6)Numeric, up to 6 bytes*120000
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...
Returns the hash value from the request as-is
bankCdAN(3)Alphanumeric, up to 3 bytes*011
Bank code (returned as-is from the request)
vAcntNoN(16)Numeric, up to 16 bytes*AES-256AES-256/ECB/PKCS5Padding1234567890
Virtual account number (returned as-is from the request)
*실제 응답값은 AES-256 암호화된 값입니다. 복호화 후 사용하세요.
expireDateN(14)Numeric, up to 14 bytes*20221231235959
Deposit expiration date and time (returned as-is from the request)
trdAmtN(12)Numeric, up to 12 bytes*AES-256AES-256/ECB/PKCS5Padding1000
Transaction amount (returned as-is from the request)
*실제 응답값은 AES-256 암호화된 값입니다. 복호화 후 사용하세요.
acntTypeN(1)Numeric, up to 1 bytes*1
Virtual account type (returned as-is from the request)
💬

Need technical support?