헥토파이낸셜 개발자센터

010 Virtual Account Deposit Test API

An API that simulates a virtual account deposit in the sandbox environment. You can receive 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 as URL query strings.

타입 표기법
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
└bizTypeN(2)Numeric, up to 2 bytes*
Business type
F1: Deposit Test
└vAcntNoN(11)Numeric, up to 11 bytes*
Virtual account number (010 format). Enter the number issued via the Issuance (A4) API.
└trdAmtN(9)Numeric, up to 9 bytes*
Deposit test amount

Request Example

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

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

cURL Example

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

Response

The GET request result is returned as plain text.

ResponseDescription
OKDeposit test successful. A deposit webhook (B1) is sent to notiUrl.
Error messageAn error message is returned on failure.

Test Flow

  1. Call the 010 virtual account issuance (A4) API to obtain a virtual account number.
  2. Call the deposit test (F1) API using the issued virtual account number.
  3. A deposit webhook (B1) is sent to the notiUrl registered during issuance.
  4. Verify that the webhook is received and processed correctly.

Important Notes

NOTE

Verify Webhook Receipt

After calling the deposit test, verify that the deposit webhook (B1) is successfully received at notiUrl.
  • Only operates in the sandbox environment.
  • Triggers a deposit webhook without an actual bank deposit.
  • Testing is only possible with an issued virtual account number.
  • The test amount does not need to match the amount set at the time of issuance.
💬

Need technical support?