상품권 취소 API
상품권 결제 건에 대한 취소를 처리하는 API입니다.
테스트용 키 정보
API 정보
POST/spay/APICancel.do
Content-Type
application/json테스트
https://tbgw.settlebank.co.kr/spay/APICancel.do운영
https://gw.settlebank.co.kr/spay/APICancel.do주의 사항
상품권 취소 주의사항
상품권류는 취소회차(cnclOrd)가 001로 고정입니다. 부분 취소가 불가능합니다.
- 상품권 취소는 전체 취소만 가능합니다.
- 취소회차(
cnclOrd)는 001로 고정값입니다. - 상품권 종류에 따라 취소 정책이 다를 수 있습니다.
요청 파라미터
타입 표기법
N숫자A영문H한글AN영문+숫자AHN영문+한글+숫자예: AN(10) = 영문+숫자, 최대 10byte
params 객체
└mchtIdAN(10)영문+숫자, 최대 10byte*헥토파이낸셜에서 부여하는 고유 상점아이디
헥토파이낸셜에서 부여하는 고유 상점아이디
nx_mid_il: 상품권 테스트└verAN(4)영문+숫자, 최대 4byte*전문의 버전
전문의 버전
*고정값
└methodA(2)영문, 최대 2byte*결제수단
결제수단
TC: 틴캐시 CG: 컬쳐캐쉬 SG: 스마트문상 BG: 도서상품권*상품권 종류에 따라 선택
└bizTypeAN(2)영문+숫자, 최대 2byte*업무 구분코드
업무 구분코드
*고정값 (C0: 취소)
└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 + cnclAmt(평문) + hashKey
└orgTrdNoAN(40)영문+숫자, 최대 40byte*결제 시 헥토파이낸셜에서 발급한 거래번호
결제 시 헥토파이낸셜에서 발급한 거래번호
└crcCdA(3)영문, 최대 3byte*통화 구분 값
통화 구분 값
*고정값
└cnclOrdN(3)숫자, 최대 3byte*취소회차 (상품권류는 001 고정)
취소회차 (상품권류는 001 고정)
*고정값
└cnclAmtN(12)숫자, 최대 12byte*
AES-256AES-256/ECB/PKCS5Padding + Base64취소금액취소금액
└cnclRsnAHN(255)영문+한글+숫자, 최대 255byte취소사유 내용
취소사유 내용
응답 파라미터
타입 표기법
N숫자A영문H한글AN영문+숫자AHN영문+한글+숫자예: AN(10) = 영문+숫자, 최대 10byte
params 객체
└mchtIdAN(10)영문+숫자, 최대 10byte*상점아이디
nx_mid_il상점아이디
└verAN(4)영문+숫자, 최대 4byte*전문의 버전
0A19전문의 버전
└methodA(2)영문, 최대 2byte*결제수단
TC결제수단
TC: 틴캐시 CG: 컬쳐캐쉬 SG: 스마트문상 BG: 도서상품권└bizTypeAN(2)영문+숫자, 최대 2byte*업무 구분코드
C0업무 구분코드
└encCdN(2)숫자, 최대 2byte*암호화 구분 코드
23암호화 구분 코드
└mchtTrdNoAN(100)영문+숫자, 최대 100byte*상점주문번호
ORDER20211231100000상점주문번호
└trdNoAN(40)영문+숫자, 최대 40byte*헥토파이낸셜 거래번호
STFP_PGGFnxgf_jt_il0211129135810M1494620헥토파이낸셜 거래번호
└trdDtN(8)숫자, 최대 8byte*취소요청일자 (YYYYMMDD)
20211231취소요청일자 (YYYYMMDD)
└trdTmN(6)숫자, 최대 6byte*취소요청시간 (HHMMSS)
100000취소요청시간 (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_PGGFnxgf_jt_il0211129135810M1494620결제 시 헥토파이낸셜에서 발급한 거래번호
└cnclAmtN(12)숫자, 최대 12byte*
AES-256AES-256/ECB/PKCS5Padding취소금액1000취소금액
*실제 응답값은 AES-256 암호화된 값입니다. 복호화 후 사용하세요.
API 테스트