내통장 결제취소 API
결제 완료된 거래를 취소하거나 환불 처리하는 API입니다. 당일 취소와 익일 이후 환불 모두 동일한 API를 사용합니다.
테스트용 키 정보
API 정보
POST/v3/APIPayCancel.do
Content-Type
application/json; charset=UTF-8테스트
https://tbezauthapi.settlebank.co.kr/v3/APIPayCancel.do운영
https://ezauthapi.settlebank.co.kr:8081/v3/APIPayCancel.do요청 파라미터
타입 표기법
N숫자A영문H한글AN영문+숫자AHN영문+한글+숫자예: AN(10) = 영문+숫자, 최대 10byte
필수 파라미터
└hdInfoAN(50)영문+숫자, 최대 50byte*전문 정보 코드
전문 정보 코드
*고정값
└apiVerAN(4)영문+숫자, 최대 4byte*전문 버전
전문 버전
*고정값
└mercntIdAN(8)영문+숫자, 최대 8byte*헥토파이낸셜에서 부여하는 고유 상점아이디
헥토파이낸셜에서 부여하는 고유 상점아이디
└oldTrNoAN(50)영문+숫자, 최대 50byte*원거래번호 (결제승인 응답에서 받은 trNo)
원거래번호 (결제승인 응답에서 받은 trNo)
└ordNoAN(100)영문+숫자, 최대 100byte*취소주문번호 (가맹점에서 생성한 고유 주문번호)
취소주문번호 (가맹점에서 생성한 고유 주문번호)
└cancelPriceAN(13)영문+숫자, 최대 13byte*
AES-256AES-256/ECB/PKCS5Padding + Hex취소요청금액취소요청금액
└reqDayN(8)숫자, 최대 8byte*요청일자 (yyyyMMdd)
요청일자 (yyyyMMdd)
└reqTimeN(6)숫자, 최대 6byte*요청시간 (HH24MISS)
요청시간 (HH24MISS)
└signatureAN(200)영문+숫자, 최대 200byte*
SHA-256SHA-256 방식으로 생성한 해쉬값(실시간 생성)SHA-256 방식으로 생성한 해쉬값
NOTE
해쉬 생성 조합
mercntId + oldTrNo + ordNo + cancelPrice(평문) + reqDay + reqTime + hashKey
선택 파라미터
└taxPriceAN(13)영문+숫자, 최대 13byte
AES-256AES-256/ECB/PKCS5Padding + Hex과세금액 (복합과세 시 필수, 전체취소 시 생략)과세금액 (복합과세 시 필수, 전체취소 시 생략)
└vatPriceAN(13)영문+숫자, 최대 13byte
AES-256AES-256/ECB/PKCS5Padding + Hex부가세금액 (복합과세 시 필수, 전체취소 시 생략)부가세금액 (복합과세 시 필수, 전체취소 시 생략)
└dutyFreePriceAN(13)영문+숫자, 최대 13byte
AES-256AES-256/ECB/PKCS5Padding + Hex비과세금액 (복합과세 시 필수, 전체취소 시 생략)비과세금액 (복합과세 시 필수, 전체취소 시 생략)
응답 파라미터
타입 표기법
N숫자A영문H한글AN영문+숫자AHN영문+한글+숫자예: AN(10) = 영문+숫자, 최대 10byte
└resultCdN(1)숫자, 최대 1byte*결과코드
0결과코드
0: 성공 -1: 실패└errCdAN(5)영문+숫자, 최대 5byte*실패코드 (실패코드 테이블 참조)
0000실패코드 (실패코드 테이블 참조)
└resultMsgAN(200)영문+숫자, 최대 200byte*결과 메시지
성공결과 메시지
└oldTrNoAN(50)영문+숫자, 최대 50byte*취소 원거래번호
STFP_PNPTms00001t00220922182409M1962430취소 원거래번호
└trNoAN(50)영문+숫자, 최대 50byte*취소거래번호
STFP_PNPTms00001t00220404134307M1550602취소거래번호
└cancelPriceN(13)숫자, 최대 13byte*취소금액
9000취소금액
└disntCancelPriceN(13)숫자, 최대 13byte*취소 할인(프로모션) 금액
1000취소 할인(프로모션) 금액
└payCancelPriceN(13)숫자, 최대 13byte*결제 취소 금액 (할인 제외)
8000결제 취소 금액 (할인 제외)
└criPriceN(13)숫자, 최대 13byte*현금영수증 발급 금액 (현금성 결제 금액만)
7000현금영수증 발급 금액 (현금성 결제 금액만)
└criTaxVatPriceN(13)숫자, 최대 13byte*현금영수증 취소 과세 금액 (부가세 포함)
5500현금영수증 취소 과세 금액 (부가세 포함)
└criDutyFreePiceN(13)숫자, 최대 13byte*현금영수증 취소 비과세 금액
1500현금영수증 취소 비과세 금액
└cancelDayN(8)숫자, 최대 8byte*취소일자 (yyyyMMdd)
20190222취소일자 (yyyyMMdd)
연동 예시 (JSON)
{
"hdInfo": "IA_CANCEL",
"apiVer": "3.0",
"mercntId": "ms00003t",
"oldTrNo": "STFP_PNPTms00001t00220922182409M1962430",
"ordNo": "OID201902210001",
"reqDay": "20190221",
"reqTime": "142120",
"cancelPrice": "AES암호화된금액",
"signature": "SHA256해쉬값"
}
