헥토파이낸셜 개발자센터

010 Virtual Account Issuance Cancel API

An API for cancelling an issued 010 virtual account. Cancels the issued virtual account number before deposit.

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

Cancel Only Available Before Deposit

Issuance cancel (A2) cancels the virtual account issuance before deposit. For already-deposited transactions, use refund (C0) instead of issuance cancel.

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
└verAN(4)Alphanumeric, up to 4 bytes*
Message version
└methodA(2)Alphabetic, up to 2 bytes*
Payment method
└bizTypeAN(2)Alphanumeric, up to 2 bytes*
Business type code
*A2: Issuance Cancel
└encCdN(2)Numeric, up to 2 bytes*
Encryption type code
└mchtTrdNoAN(100)Alphanumeric, up to 100 bytes*
Merchant order number for cancel (newly generated)
└trdDtN(8)Numeric, up to 8 bytes*
Cancel request date (yyyyMMdd)
└trdTmN(6)Numeric, up to 6 bytes*
Cancel 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
*Cancel request date + cancel request time + merchant ID + merchant order number + '0' + hash key
└orgTrdNoAN(40)Alphanumeric, up to 40 bytes*
Transaction number issued by Hecto Financial at the time of issuance
└vAcntNoN(14)Numeric, up to 14 bytes*AES-256AES-256/ECB/PKCS5Padding + Base64
Previously issued virtual account number

Response Parameters

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

params Object

└mchtIdAN(10)Alphanumeric, up to 10 bytes*nxva_sb_il
Merchant ID
└verAN(4)Alphanumeric, up to 4 bytes*0A18
Message version
└methodA(2)Alphabetic, up to 2 bytes*VA
Payment method
└bizTypeAN(2)Alphanumeric, up to 2 bytes*A2
Business type code
└encCdN(2)Numeric, up to 2 bytes*23
Encryption type code
└mchtTrdNoAN(100)Alphanumeric, up to 100 bytes*CANCEL20211231100000
Merchant order number
└trdNoAN(40)Alphanumeric, up to 40 bytes*STBK_0123456789
Hecto Financial transaction number
└trdDtN(8)Numeric, up to 8 bytes*20211231
Cancel request date
└trdTmN(6)Numeric, up to 6 bytes*120000
Cancel request time
└outStatCdAN(4)Alphanumeric, up to 4 bytes*0021
Transaction status code
0021: Success 0031: Failure
└outRsltCdAN(4)Alphanumeric, up to 4 bytes*0000
Result code (0000 indicates success)
└outRsltMsgAHN(200)Alphanumeric + Korean, up to 200 bytes*Processed successfully.
Result message

data Object

└pktHashAN(64)Alphanumeric, up to 64 bytes*75ac014c33165f3ee0c331123a0049f37a6e1578f8cec1d3d0374ffb75f18496
Response hash value
└orgTrdNoAN(40)Alphanumeric, up to 40 bytesSTBK_0123456789
Original transaction number
└acntTypeN(1)Numeric, up to 1 bytes4
Account type
4: 010 Virtual Account
└vAcntNoN(14)Numeric, up to 14 bytes01012345678
Virtual account number

Request Example

{
  "params": {
    "mchtId": "nxva_sb_il",
    "ver": "0A18",
    "method": "VA",
    "bizType": "A2",
    "encCd": "23",
    "mchtTrdNo": "CANCEL20211231100000",
    "trdDt": "20211231",
    "trdTm": "120000",
    "mobileYn": "N",
    "osType": "W"
  },
  "data": {
    "pktHash": "hash value",
    "orgTrdNo": "STBK_0123456789",
    "vAcntNo": "AES-encrypted virtual account number"
  }
}

Response Example

Success

{
  "params": {
    "mchtId": "nxva_sb_il",
    "ver": "0A18",
    "method": "VA",
    "bizType": "A2",
    "encCd": "23",
    "mchtTrdNo": "CANCEL20211231100000",
    "trdNo": "STBK_0123456790",
    "trdDt": "20211231",
    "trdTm": "120000",
    "outStatCd": "0021",
    "outRsltCd": "0000",
    "outRsltMsg": "Processed successfully."
  },
  "data": {
    "pktHash": "response hash value",
    "orgTrdNo": "STBK_0123456789",
    "acntType": "4",
    "vAcntNo": "01012345678"
  }
}

Failure

{
  "params": {
    "mchtId": "nxva_sb_il",
    "ver": "0A18",
    "method": "VA",
    "bizType": "A2",
    "encCd": "23",
    "mchtTrdNo": "CANCEL20211231100000",
    "trdNo": "",
    "trdDt": "20211231",
    "trdTm": "120000",
    "outStatCd": "0031",
    "outRsltCd": "0004",
    "outRsltMsg": "This transaction has already been deposited."
  },
  "data": {}
}
💬

Need technical support?