가상계좌 채번취소 API
발급된 가상계좌를 취소하는 API입니다.
테스트용 키 정보
API 정보
POST/spay/APIVBank.do
Content-Type
application/json테스트
https://tbgw.settlebank.co.kr/spay/APIVBank.do운영
https://gw.settlebank.co.kr/spay/APIVBank.do주의 사항
채번취소 주의사항
일반 가상계좌는 입금 전에만 채번취소가 가능합니다.
NOTE
고정식 무제한 채번취소
고정식 무제한(acntType: 3) 가상계좌는 입금 완료 후에도 채번취소가 가능합니다.
- 채번취소된 가상계좌는 더 이상 사용할 수 없습니다.
- 원거래번호와 가상계좌번호를 정확히 입력해야 합니다.
요청 파라미터
타입 표기법
N숫자A영문H한글AN영문+숫자AHN영문+한글+숫자예: AN(10) = 영문+숫자, 최대 10byte
params 객체
└mchtIdAN(10)영문+숫자, 최대 10byte*헥토파이낸셜에서 부여하는 고유 상점아이디
헥토파이낸셜에서 부여하는 고유 상점아이디
nx_mid_il: 가상계좌 테스트└verAN(4)영문+숫자, 최대 4byte*전문의 버전
전문의 버전
*고정값
└methodA(2)영문, 최대 2byte*결제수단
결제수단
*고정값 (VA: 가상계좌)
└bizTypeAN(2)영문+숫자, 최대 2byte*업무 구분코드
업무 구분코드
*고정값 (A2: 채번취소)
└encCdN(2)숫자, 최대 2byte*암호화 구분 코드
암호화 구분 코드
*고정값
└mchtTrdNoAN(100)영문+숫자, 최대 100byte*채번취소시 상점에서 생성하는 고유한 주문번호
채번취소시 상점에서 생성하는 고유한 주문번호
└trdDtN(8)숫자, 최대 8byte*취소요청일자 (YYYYMMDD)
취소요청일자 (YYYYMMDD)
└trdTmN(6)숫자, 최대 6byte*취소요청시간 (HHMMSS)
취소요청시간 (HHMMSS)
└mobileYnA(1)영문, 최대 1byte모바일 여부
모바일 여부
Y: 모바일웹/앱 N: PC 또는 그 외└osTypeA(1)영문, 최대 1byteOS 구분
OS 구분
A: Android I: iOS W: Windows M: Mac E: 기타data 객체
└pktHashAN(64)영문+숫자, 최대 64byte*
SHA-256SHA256 방식으로 생성한 해쉬값(실시간 생성)SHA256 방식으로 생성한 해쉬값
NOTE
해쉬 생성 조합
trdDt + trdTm + mchtId + mchtTrdNo + "0" + hashKey
└orgTrdNoAN(40)영문+숫자, 최대 40byte*채번시 헥토파이낸셜에서 발급한 거래번호
채번시 헥토파이낸셜에서 발급한 거래번호
└vAcntNoN(20)숫자, 최대 20byte*
AES-256AES-256/ECB/PKCS5Padding + Base64발급받았던 가상계좌번호발급받았던 가상계좌번호
응답 파라미터
타입 표기법
N숫자A영문H한글AN영문+숫자AHN영문+한글+숫자예: AN(10) = 영문+숫자, 최대 10byte
params 객체
└mchtIdAN(10)영문+숫자, 최대 10byte*상점아이디
nx_mid_il상점아이디
└verAN(4)영문+숫자, 최대 4byte*전문의 버전
0A19전문의 버전
└methodA(2)영문, 최대 2byte*결제수단
VA결제수단
└bizTypeAN(2)영문+숫자, 최대 2byte*업무 구분코드
A2업무 구분코드
└encCdN(2)숫자, 최대 2byte*암호화 구분 코드
23암호화 구분 코드
└mchtTrdNoAN(100)영문+숫자, 최대 100byte*상점주문번호
ORDER20211231100000상점주문번호
└trdNoAN(40)영문+숫자, 최대 40byte*헥토파이낸셜 거래번호
STBK_0123456789헥토파이낸셜 거래번호
└trdDtN(8)숫자, 최대 8byte*취소요청일자 (YYYYMMDD)
20211231취소요청일자 (YYYYMMDD)
└trdTmN(6)숫자, 최대 6byte*취소요청시간 (HHMMSS)
120000취소요청시간 (HHMMSS)
└outStatCdAN(4)영문+숫자, 최대 4byte*거래상태코드 (성공/실패)
0021거래상태코드 (성공/실패)
0021: 성공 0031: 실패└outRsltCdAN(4)영문+숫자, 최대 4byte*결과코드
0000결과코드
└outRsltMsgAHN(200)영문+한글+숫자, 최대 200byte*결과메시지
정상적으로 처리되었습니다.결과메시지
data 객체
└pktHashAN(64)영문+숫자, 최대 64byte*요청시 hash 값 그대로 return
f395b6725a9a18...요청시 hash 값 그대로 return
└orgTrdNoAN(40)영문+숫자, 최대 40byte채번시 헥토파이낸셜에서 발급한 거래번호
STFP_PGVAnx_mid_il00210806075210M1853381채번시 헥토파이낸셜에서 발급한 거래번호
└acntTypeN(1)숫자, 최대 1byte가상계좌 구분
4가상계좌 구분
4: 010가상계좌 null: 이외└vAcntNoN(16)숫자, 최대 16byte*
AES-256AES-256/ECB/PKCS5Padding채번받았던 가상계좌번호1234567890채번받았던 가상계좌번호
*실제 응답값은 AES-256 암호화된 값입니다. 복호화 후 사용하세요.
노티 전문 (헥토파이낸셜 → 가맹점)
채번취소 완료 시 헥토파이낸셜에서 가맹점으로 노티(결과통보)가 전송됩니다.
노티 파라미터
└outStatCdN(4)숫자, 최대 4byte*거래상태
0021거래상태
0021: 성공└trdNoAN(40)영문+숫자, 최대 40byte*헥토파이낸셜에서 부여하는 고유 거래번호
STFP_PGVAnx_mid_il0211129135810M1494620헥토파이낸셜에서 부여하는 고유 거래번호
└methodA(2)영문, 최대 2byte*결제수단
VA결제수단
VA: 가상계좌└bizTypeAN(2)영문+숫자, 최대 2byte*업무구분
A2업무구분
A2: 채번취소└mchtIdAN(12)영문+숫자, 최대 12byte*상점아이디
nx_mid_il상점아이디
└mchtTrdNoAN(100)영문+숫자, 최대 100byte*상점주문번호
ORDER20211231100000상점주문번호
└trdDtmN(14)숫자, 최대 14byte*거래일시 (YYYYMMDDhhmmss)
20211231100000거래일시 (YYYYMMDDhhmmss)
└orgTrdNoAN(40)영문+숫자, 최대 40byte원거래번호
STFP_PGVAnx_mid_il0211129135810M1494620원거래번호
└orgTrdDtN(8)숫자, 최대 8byte원거래일자
20211231원거래일자
└pktHashAN(64)영문+숫자, 최대 64byte*해쉬값 (거래상태코드+거래일자+거래시간+상점아이디+상점주문번호+거래금액+해쉬키)
a2d6d597d55d7c9b...해쉬값 (거래상태코드+거래일자+거래시간+상점아이디+상점주문번호+거래금액+해쉬키)
노티 응답
가맹점에서 헥토파이낸셜로 응답을 전송합니다.
| 응답 | 설명 |
|---|---|
| "OK" | 성공시 (대문자) |
| "FAIL" | 실패시 (대문자, FAIL로 응답시 노티가 재전송됩니다) |
| 그 외 | 비정상 실패로 인식하여, 설정된 횟수만큼 노티 재발송 처리함 |
