헥토파이낸셜 개발자센터

Simulate Virtual Account Deposit API

An API that simulates virtual account deposits in the sandbox environment. Allows receiving a deposit webhook (B1) without an actual deposit.

API Information

GET/spay/APIVBankTest.do
Content-Typeapplication/json
테스트https://tbgw.settlebank.co.kr/spay/APIVBankTest.do

Sandbox Environment Only

This API is only available in the sandbox environment. It cannot be called in the production environment.

Request Parameters

Parameters are passed via URL Query String.

타입 표기법
N숫자A영문H한글AN영문+숫자AHN영문+한글+숫자
예: AN(10) = 영문+숫자, 최대 10byte
└mchtIdAN(10)Alphanumeric, up to 10 bytes*
Merchant ID
└methodAN(2)Alphanumeric, up to 2 bytes*
Payment method
VA: Virtual Account
└bizTypeAN(2)Alphanumeric, up to 2 bytes*
Business type
F1: Deposit Simulation
└vAcntNoN(11)Numeric, up to 11 bytes*
Virtual account number issued via the virtual account checkout or API
└trdAmtN(12)Numeric, up to 12 bytes*
Deposit simulation amount

Request Example

Call directly from the browser address bar or via an HTTP GET request.

https://tbgw.settlebank.co.kr/spay/APIVBankTest.do?mchtId=nx_mid_il&method=VA&bizType=F1&vAcntNo=12345678901234&trdAmt=1000

cURL Example

curl -X GET "https://tbgw.settlebank.co.kr/spay/APIVBankTest.do?mchtId=nx_mid_il&method=VA&bizType=F1&vAcntNo=12345678901234&trdAmt=1000"

Test Flow

  1. Call the virtual account issuance (B0) API to obtain a virtual account number.
  2. Call the deposit simulation (F1) API using the issued virtual account number.
  3. A deposit webhook (B1) is sent to the notiUrl registered at the time of issuance.
  4. Verify that the webhook is received and processed correctly.

Important Notes

NOTE

Webhook Receipt Verification

After calling the deposit simulation, verify that the deposit webhook (B1) is received correctly via notiUrl.
  • Only operates in the sandbox environment.
  • Generates a deposit webhook without an actual bank deposit.
  • Only virtual account numbers that have been issued can be used for testing.
  • The test amount does not need to match the amount set at issuance.

Response Parameters

타입 표기법
N숫자A영문H한글AN영문+숫자AHN영문+한글+숫자
예: AN(10) = 영문+숫자, 최대 10byte
└methodAN(2)Alphanumeric, up to 2 bytes*VA
Payment method
└bizTypeAN(2)Alphanumeric, up to 2 bytes*F1
Business type
└outRsltCdAN(4)Alphanumeric, up to 4 bytes*0000
Result code
0000: Processed successfully
└outRsltMsgAHN(200)Alphanumeric + Korean, up to 200 bytes*Processed successfully.
Result message
💬

Need technical support?