헥토파이낸셜 개발자센터

신용카드 취소 API

신용카드 결제를 취소하는 API입니다. 전체 취소와 부분 취소를 모두 지원합니다.

테스트용 키 정보

주의 사항

  • 취소는 원거래번호를 기준으로 진행됩니다.
  • 부분 취소 시 취소회차(cnclOrd)를 순차적으로 증가시켜야 합니다.
  • 취소 가능 잔액을 초과하는 금액은 취소할 수 없습니다.

API 정보

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

요청 파라미터

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

params 객체

└mchtIdAN(12)영문+숫자, 최대 12byte*
헥토파이낸셜에서 부여하는 고유 상점아이디
nxca_jt_il: 인증 nxca_jt_bi: 비인증 nxca_ks_gu: 구인증
└verAN(4)영문+숫자, 최대 4byte*
전문의 버전
*고정값
└methodA(2)영문, 최대 2byte*
결제수단
*고정값
└bizTypeAN(2)영문+숫자, 최대 2byte*
업무 구분코드
*고정값 (취소용)
└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(200)영문+숫자, 최대 200byte*SHA-256(실시간 생성)
SHA256 방식으로 생성한 해쉬값
NOTE

해쉬 생성 조합

trdDt + trdTm + mchtId + mchtTrdNo + cnclAmt(평문) + hashKey
└orgTrdNoAN(40)영문+숫자, 최대 40byte*
결제 시 헥토파이낸셜에서 발급한 거래번호
└crcCdA(3)영문, 최대 3byte*
통화 구분 값
KRW: 국내결제 USD: 해외결제
└cnclOrdN(3)숫자, 최대 3byte*
취소회차. 001부터 시작
*부분취소 2회차의 경우 002
└taxTypeCdA(1)영문, 최대 1byte
면세여부. 공백일 경우 상점 기본 정보에 따름
Y: 면세 N: 과세 G: 복합과세
└cnclAmtN(12)숫자, 최대 12byte*AES-256AES-256/ECB/PKCS5Padding + Base64
취소금액
*국내결제: 1000, 해외결제: 150 (ex [1.50$] => 정수표기 [150])
└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
취소사유내용. 필요한 경우 취소 사유 메세지 기재

응답 파라미터

params 객체

└mchtIdAN(12)영문+숫자, 최대 12byte*nxca_jt_il
헥토파이낸셜에서 부여하는 고유 상점아이디
└verAN(4)영문+숫자, 최대 4byte*0A19
전문의 버전
*고정값
└methodA(2)영문, 최대 2byte*CA
결제수단
*고정값
└bizTypeAN(2)영문+숫자, 최대 2byte*C0
업무 구분코드
*취소용 고정값
└encCdN(2)숫자, 최대 2byte*23
암호화 구분 코드
*고정값
└mchtTrdNoAN(100)영문+숫자, 최대 100byte*ORDER20211231100000
상점에서 생성하는 고유한 주문번호
└trdNoAN(40)영문+숫자, 최대 40byte*STFP_PGCAnxca_jt_il0211129135810M1494620
헥토파이낸셜에서 생성하는 고유한 거래번호
└trdDtN(8)숫자, 최대 8byte*20211231
취소요청일자 (YYYYMMDD)
└trdTmN(6)숫자, 최대 6byte*100000
취소요청시간 (HHMMSS)
└outStatCdAN(4)영문+숫자, 최대 4byte*0021
거래상태코드 (성공/실패)
0021: 성공 0031: 실패
└outRsltCdAN(4)영문+숫자, 최대 4byte*0000
거절코드. 거래상태가 '0031'일 경우, 상세 코드 전달
└outRsltMsgAHN(200)영문+한글+숫자, 최대 200byte*정상적으로 처리되었습니다.
결과 메세지 전달 (URL Encoding, UTF-8)

data 객체

└pktHashAN(64)영문+숫자, 최대 64byte*
요청시 hash 값 그대로 return
└orgTrdNoAN(40)영문+숫자, 최대 40byte*STFP_PGCAnxca_jt_il0211129135810M1494620
결제 시 헥토파이낸셜에서 발급한 거래번호
└cnclAmtN(12)숫자, 최대 12byte*AES-256AES-256/ECB/PKCS5Padding1000
취소금액
*실제 응답값은 AES-256 암호화된 값입니다. 복호화 후 사용하세요.
└cardCnclAmtN(12)숫자, 최대 12byte*AES-256AES-256/ECB/PKCS5Padding5000
전체금액 중 신용카드 취소금액
*실제 응답값은 AES-256 암호화된 값입니다. 복호화 후 사용하세요.
└pntCnclAmtN(12)숫자, 최대 12byte*AES-256AES-256/ECB/PKCS5Padding1000
전체금액 중 포인트 취소금액
*실제 응답값은 AES-256 암호화된 값입니다. 복호화 후 사용하세요.
└blcAmtN(12)숫자, 최대 12byte*AES-256AES-256/ECB/PKCS5Padding0
취소성공시 거래번호 기준 남은 취소 가능잔액
*실제 응답값은 AES-256 암호화된 값입니다. 복호화 후 사용하세요.
└dcCnclAmtN(12)숫자, 최대 12byteAES-256AES-256/ECB/PKCS5Padding1000
취소된 할인 금액
*실제 응답값은 AES-256 암호화된 값입니다. 복호화 후 사용하세요.
└dcCnclYnA(1)영문, 최대 1byteY
할인취소여부 (할인취소금액 값 존재시 Y, 그 외 N)
Y: 할인취소 N: 할인취소 아님

노티 전문 (결과통보)

취소 노티는 기본 미제공

신용카드 결제 취소는 API 응답으로 결과를 확인하므로, 기본적으로 취소 노티가 전송되지 않습니다. 취소 노티가 필요한 경우 영업 담당자 또는 기술지원 이메일(pgsupport@hecto.co.kr)로 요청하세요.
NOTE

노티 전문 확인

취소 노티 활성화 시 신용카드 노티 전문과 동일한 형식으로 전달됩니다. 노티 전문 문서 보기
❓

더 궁금한 내용이 있나요?

FAQ
💬

기술지원이 필요한가요?