본 페이지에서는 결제 취소 요청에 대해 설명합니다.
결제 승인 후 취소 처리가 필요할 때 사용됩니다.
결제 취소 요청
URL : /payment/v1/cancel
Protocol : HTTP/1.1
Method : POST
Encoding : UTF-8
Content-Type : application/json
tid(30byte)
인증 거래번호
mId(10byte)
상점 아이디
ccMsg(100byte)
취소 사유
partCanFlg(1byte)
부분 취소 여부
0 : 전체취소
1 : 부분취소
ediDate(14byte)
인증처리 일시
형태 : YYYYMMDDHHmmss
예시) 20230914135133
hashString
결제정보 검증 데이터 (mid + ediDate + tid + 가맹점KEY)
인증 데이터 정합성을 위해 가맹점에서 HASH값 비교
orderId(40byte)
주문 번호
주문한 결제를 식별하는 역할로, 결제를 요청할 때 가맹점에서 만들어서 사용한 값입니다.
중복되지 않는 고유한 값을 발급해야 합니다.
cancelAmount(15byte)
부분취소일 경우 필수(숫자만 입력)
ccId(21byte)
취소 아이디, 한글/특수기호 입력가능
ccNm(30byte)
취소자명
ccIp(20byte)
취소 아이피(IPv4, IPv6 지원)
mbsReserved(500byte)
상점 예약 필드에 셋팅한 값
goodsSplAmt(15byte)
결제 수수료의 공급가액(부가세 설정이 전송금액 기준이면 필수)
goodsVat(15byte)
결제 수수료 부가세(부가세 설정이 전송금액 기준이면 필수)
goodsSvsAmt(15byte)
상품 봉사료(부가세 설정이 전송금액 기준이면 필수)
결제 취소 응답
resultCd(4byte)
결제 취소 결과 코드, 실패 코드
: 0000
: 0000을 제외한 나머지
resultMsg(100byte)
결과 메시지
tid(30byte)
인증 거래번호
mId(10byte)
상점 아이디
trDt(8byte)
취소 일
형태 : yyyyMMdd
예시) 20231113
trTm(6byte)
취소 시간
형태 : HHmmss
예시) 163620
trxStCd(2byte)
거래 상태
0 : 승인
1 : 전취소
2 : 후취소
9 : 망취소
method(2byte)
결제 수단 코드
01 : 신용카드
spmCd(2byte)
결제 수단 Sub 코드
01 : 고정
cancelAmount(15byte)
결제 취소 결과 금액
orderId(40byte)
주문 번호
주문한 결제를 식별하는 역할로, 결제를 요청할 때 가맹점에서 만들어서 사용한 값입니다.
중복되지 않는 고유한 값을 발급해야 합니다.
otid(30byte)
원거래 아이디
partCanFlg(1byte)
부분 취소 여부
0 : 전체취소
1 : 부분취소
netCanFlg(500byte)
망취소 여부
0 : 일반취소
1 : 망취소
mbsReserved(500byte)
상점 예약 필드에 셋팅한 값
ediDate(14byte)
인증처리 일시
형태 : yyyyMMddHHmmss
예시) 20230914135133
결제 취소 요청 후 취소결과(responseBody)를 받아 내부처리(DB 저장 등) 하시기 바랍니다.
수신시 전송 필드명을 명확히하여 처리하시기 바랍니다. (필드명 대/소문자 구분)
결제취소에 실패하였을 경우 실패시 전달되는 데이터만 전송됩니다.
