헥토파이낸셜 개발자센터

간편결제 취소 API

간편결제(페이코, 카카오페이, 네이버페이, 토스페이 등) 결제 건에 대한 전체 취소 또는 부분 취소를 처리하는 API입니다.

테스트용 키 정보

API 정보

POST/spay/APICancel.do
Content-Typeapplication/json
테스트https://tbgw.settlebank.co.kr/spay/APICancel.do
운영https://gw.settlebank.co.kr/spay/APICancel.do

주의 사항

NOTE

간편결제 취소 안내

간편결제 취소는 각 서비스사(페이코, 카카오페이, 네이버페이, 토스페이 등)의 정책에 따릅니다.
  • 전체 취소 및 부분 취소가 가능합니다.
  • 부분 취소 시 취소회차(cnclOrd)를 순차적으로 증가시켜 요청합니다.
  • 간편결제사별 취소 정책이 다를 수 있습니다.
  • 취소 성공 시 남은 취소 가능 잔액이 응답됩니다.

카카오페이 부분 취소 테스트 환경 미지원

테스트 환경에서 카카오페이 부분 취소는 지원되지 않습니다. 운영 환경에서는 정상적으로 사용 가능합니다.

요청 파라미터

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

params 객체

└mchtIdAN(10)영문+숫자, 최대 10byte*
헥토파이낸셜에서 부여하는 고유 상점아이디
hecto_test: 간편결제 테스트
└verAN(4)영문+숫자, 최대 4byte*
전문의 버전
*고정값
└methodA(2)영문, 최대 2byte*
결제수단
*고정값 (PZ: 간편결제)
└bizTypeAN(2)영문+숫자, 최대 2byte*
업무 구분코드
*고정값 (C0: 취소)
└encCdN(2)숫자, 최대 2byte*
암호화 구분 코드
*고정값
└mchtTrdNoAN(100)영문+숫자, 최대 100byte*
상점에서 생성하는 고유한 주문번호
└trdDtN(8)숫자, 최대 8byte*
취소요청일자 (YYYYMMDD)
└trdTmN(6)숫자, 최대 6byte*
취소요청시간 (HHMMSS)
└mobileYnA(1)영문, 최대 1byte
모바일 여부
Y: 모바일웹/앱 N: PC 또는 그 외
└osTypeA(1)영문, 최대 1byte
OS 구분
A: Android I: iOS W: Windows M: Mac E: 기타

data 객체

└pktHashAN(64)영문+숫자, 최대 64byte*SHA-256(실시간 생성)
SHA256 방식으로 생성한 해쉬값
NOTE

해쉬 생성 조합

trdDt + trdTm + mchtId + mchtTrdNo + cnclAmt(평문) + hashKey
└orgTrdNoAN(40)영문+숫자, 최대 40byte*
결제 시 헥토파이낸셜에서 발급한 거래번호
└crcCdA(3)영문, 최대 3byte*
통화 구분 값
*고정값
└cnclOrdN(3)숫자, 최대 3byte*
취소회차 (001부터 시작, 부분취소 2회차의 경우 002)
└cnclAmtN(12)숫자, 최대 12byte*AES-256AES-256/ECB/PKCS5Padding + Base64
취소금액
└taxTypeCdA(1)영문, 최대 1byte
면세여부
N: 과세 Y: 면세 G: 복합과세
└taxAmtN(12)숫자, 최대 12byteAES-256AES-256/ECB/PKCS5Padding + Base64
취소금액 중 과세금액 (복합과세인 경우 필수)
└vatAmtN(12)숫자, 최대 12byteAES-256AES-256/ECB/PKCS5Padding + Base64
취소금액 중 부가세금액 (복합과세인 경우 필수)
└taxFreeAmtN(12)숫자, 최대 12byteAES-256AES-256/ECB/PKCS5Padding + Base64
취소금액 중 면세금액 (복합과세인 경우 필수)
└svcAmtN(12)숫자, 최대 12byteAES-256AES-256/ECB/PKCS5Padding + Base64
취소금액 중 봉사료
└cnclRsnAHN(255)영문+한글+숫자, 최대 255byte
취소사유 내용

응답 파라미터

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

params 객체

└mchtIdAN(10)영문+숫자, 최대 10byte*hecto_test
상점아이디
└verAN(4)영문+숫자, 최대 4byte*0A19
전문의 버전
└methodA(2)영문, 최대 2byte*PZ
결제수단
└bizTypeAN(2)영문+숫자, 최대 2byte*C0
업무 구분코드
└encCdN(2)숫자, 최대 2byte*23
암호화 구분 코드
└mchtTrdNoAN(100)영문+숫자, 최대 100byte*ORDER20211231100000
상점주문번호
└trdNoAN(40)영문+숫자, 최대 40byte*STFP_PGPZhecto_test0211129135810M1494620
헥토파이낸셜 거래번호
└trdDtN(8)숫자, 최대 8byte*20211231
취소요청일자 (YYYYMMDD)
└trdTmN(6)숫자, 최대 6byte*100000
취소요청시간 (HHMMSS)
└outStatCdAN(4)영문+숫자, 최대 4byte*0021
거래상태코드 (성공/실패)
0021: 성공 0031: 실패
└outRsltCdAN(4)영문+숫자, 최대 4byte*0000
결과코드
└outRsltMsgAHN(200)영문+한글+숫자, 최대 200byte*정상적으로 처리되었습니다.
결과메시지

data 객체

└pktHashAN(64)영문+숫자, 최대 64byte*f395b6725a9a18...
요청시 hash 값 그대로 return
└orgTrdNoAN(40)영문+숫자, 최대 40byte*STFP_PGPZhecto_test0211129135810M1494620
결제 시 헥토파이낸셜에서 발급한 거래번호
└cnclAmtN(12)숫자, 최대 12byte*AES-256AES-256/ECB/PKCS5Padding1000
취소금액
*실제 응답값은 AES-256 암호화된 값입니다. 복호화 후 사용하세요.
└blcAmtN(12)숫자, 최대 12byte*AES-256AES-256/ECB/PKCS5Padding0
취소성공시 거래번호 기준 남은 취소 가능잔액
*실제 응답값은 AES-256 암호화된 값입니다. 복호화 후 사용하세요.
└cardCnclAmtN(12)숫자, 최대 12byte*AES-256AES-256/ECB/PKCS5Padding5000
전체금액 중 신용카드 취소금액
*실제 응답값은 AES-256 암호화된 값입니다. 복호화 후 사용하세요.
└pntCnclAmtN(12)숫자, 최대 12byte*AES-256AES-256/ECB/PKCS5Padding0
전체금액 중 포인트 취소금액 (원거래가 복합결제인 경우에만 해당)
*실제 응답값은 AES-256 암호화된 값입니다. 복호화 후 사용하세요.
└coupCnclAmtN(12)숫자, 최대 12byte*1000
전체금액 중 쿠폰 취소금액
❓

더 궁금한 내용이 있나요?

FAQ
💬

기술지원이 필요한가요?