일반취소
KG이니시스를 통한 거래를 취소처리 하기위한 API 서비스
Quick Guide
샘플 다운로드
개발 언어에 맞는 샘플을
다운로드 받아 주세요.
결제승인 TID 세팅
취소처리할 결제승인 TID 를 세팅해주세요.
테스트 실행 및 결과확인
결제 진행과정과
응답결과를 확인해 주세요.
실제 연동진행
가맹점 실서버 환경에 맞게
연동을 진행해주세요.
연동 준비하기
취소 API 연동 전, 체크해야할 사항을 안내드립니다.
MID상점아이디
계약 완료 여부, 사용 가능 지불 수단 등은 계약담당자 문의INIAPI key대칭키
가맹점관리자 ▶ 상점정보 ▶ 계약정보 ▶ 부가정보 ▶ INIAPI key 생성조회방화벽정보
항목 | 스테이징환경 | 운영환경 |
---|---|---|
URL | stginiapi.inicis.com | iniapi.inicis.com |
IP | 118.129.210.153 | 118.129.210.166 183.109.71.79 |
PORT | 443 | |
연결방향 | OUTBOUND | |
프로토콜 | TLS 1.2 이상 지원 |
STEP1전체취소 요청
전체취소 요청정보
- 요청전문 형식 : JSON NVP
- 취소요청URL : https://iniapi.inicis.com/api/v1/refund
- Header 정보
POST /api/v1/refund HTTP/1.1
Host: iniapi.inicis.com
Content-type: application/x-www-form-urlencoded;charset=utf-8
- 유의사항
각 파라미터는 key=value 로 세팅하여 POST 로 API 요청 ( JSON방식 요청불가 )
Form data 세팅 후 API 통신 구간에서 모든 value를 urlEncode 하여 전송
type* | 요청서비스 ["Refund" 고정] |
6 byte
|
---|---|---|
paymethod* | 지불수단 코드 |
지불수단
10 byte
|
timestamp* | 전문생성시간 [YYYYMMDDhhmmss] |
14 byte
|
clientIp* | 가맹점 요청 서버IP (추후 거래 확인 등에 사용됨) |
15 byte
|
mid* | 상점아이디 |
10 byte
|
tid* | 취소요청할 승인TID |
40 byte
|
msg* | 취소요청 사유 |
80 byte
|
hashData* | SHA512 HASH 한 값 대상 : INIAPIKey + type + paymethod + timestamp + clientIp + mid + tid |
HASH
128 byte
|
전체취소 요청정보
- 요청전문 형식 : JSON NVP
- 취소요청URL : https://iniapi.inicis.com/v2/pg/refund
- Header 정보
POST /v2/pg/refund HTTP/1.1
Host: iniapi.inicis.com
Content-type: application/json
mid* | String | 상점아이디 |
10 byte
|
---|---|---|---|
type* | String | 요청서비스 ["refund" 고정] |
6 byte
|
timestamp* | String | 전문생성시간 [YYYYMMDDhhmmss] |
14 byte
|
clientIp* | String | 가맹점 요청 서버IP (추후 거래 확인 등에 사용됨) |
15 byte
|
hashData* | String | SHA512 HASH 한 값 대상 : INIAPIKey + mid + type + timestamp + data |
HASH
128 byte
|
data* | Data | 요청데이터 |
N/A
|
Data 상세 | |||
tid* | String | 취소요청할 승인TID |
40 byte
|
msg* | String | 취소요청 사유 |
80 byte
|
STEP2전체취소 응답
※ 유의사항
해당 응답파라미터는 모든 프로세스 종료 후 최종적으로 전달되는 결과값 입니다.
- 응답파라미터는 추후 요건에 의해 추가될 수 있습니다.
- 실패 응답 시, 일부 파라미터 응답이 null 일 수 있습니다.
- 응답형식은 JSON 형식 입니다.
resultCode | 결과코드 "00":성공, 이외 실패 |
6 byte
|
---|---|---|
resultMsg | 결과메세지 |
100 byte
|
cancelDate | 취소일자 [YYYYMMDD] |
8 byte
|
cancelTime | 취소시간 [hhmmss] |
6 byte
|
cshrCancelNum | 현금영수증 취소승인번호 현금영수증 발행건에 한함 |
6 byte
|
detailResultCode | 취소실패 응답시 상세코드 |
6 byte
|
receiptInfo | 특정 가맹점 전용 응답필드 |
6 byte
|
STEP1부분취소 요청
부분취소 요청정보
- 요청전문 형식 : JSON NVP
- 취소요청URL : https://iniapi.inicis.com/api/v1/refund
- Header 정보
POST /api/v1/refund HTTP/1.1
Host: iniapi.inicis.com
Content-type: application/x-www-form-urlencoded;charset=utf-8
- 유의사항
각 파라미터는 key=value 로 세팅하여 POST 로 API 요청 ( JSON방식 요청불가 )
Form data 세팅 후 API 통신 구간에서 모든 value를 urlEncode 하여 전송
type* | 요청서비스 ["PartialRefund" 고정] |
6 byte
|
---|---|---|
paymethod* | 지불수단 코드 |
지불수단
10 byte
|
timestamp* | 전문생성시간 [YYYYMMDDhhmmss] |
14 byte
|
clientIp* | 가맹점 요청 서버IP (추후 거래 확인 등에 사용됨) |
15 byte
|
mid* | 상점아이디 |
10 byte
|
tid* | 취소요청할 승인TID |
40 byte
|
msg* | 취소요청 사유 |
80 byte
|
price* | 취소요청 금액 |
12 byte
|
confirmPrice* | 부분취소 후 남은금액 |
12 byte
|
currency | 통화코드 [WON,USD] |
3 byte
|
tax | 부가세 |
12 byte
|
taxFree | 비과세 |
12 byte
|
hashData* | SHA512 HASH 한 값 대상 : INIAPIKey + type + paymethod + timestamp + clientIp + mid + tid + price + confirmPrice |
HASH
128 byte
|
부분취소 요청정보
- 요청전문 형식 : JSON NVP
- 취소요청URL : https://iniapi.inicis.com/v2/pg/partialRefund
- Header 정보
POST /v2/pg/partialRefund HTTP/1.1
Host: iniapi.inicis.com
Content-type: application/json
mid* | String | 상점아이디 |
10 byte
|
---|---|---|---|
type* | String | 요청서비스 ["partialRefund" 고정] |
13 byte
|
timestamp* | String | 전문생성시간 [YYYYMMDDhhmmss] |
14 byte
|
clientIp* | String | 가맹점 요청 서버IP (추후 거래 확인 등에 사용됨) |
15 byte
|
hashData* | String | SHA512 HASH 한 값 대상 : INIAPIKey + mid + type + timestamp + data |
HASH
128 byte
|
data* | Data | 요청데이터 |
N/A
|
Data 상세 | |||
tid* | String | 취소요청할 승인TID |
40 byte
|
msg* | String | 취소요청 사유 |
80 byte
|
price* | String | 취소요청 금액 |
12 byte
|
confirmPrice* | String | 부분취소 후 남은 금액 |
12 byte
|
currency | String | 통화 (WON, USD) |
3 byte
|
tax | String | 부가세 |
12 byte
|
taxFree | String | 비과세 |
12 byte
|
STEP2부분취소 응답
※ 유의사항
해당 응답파라미터는 모든 프로세스 종료 후 최종적으로 전달되는 결과값 입니다.
- 응답파라미터는 추후 요건에 의해 추가될 수 있습니다.
- 실패 응답 시, 일부 파라미터 응답이 null 일 수 있습니다.
- 응답형식은 JSON 형식 입니다.
resultCode | 결과코드 "00":성공, 이외 실패 |
6 byte
|
---|---|---|
resultMsg | 결과메세지 |
100 byte
|
prtcDate | 취소일자 [YYYYMMDD] |
8 byte
|
prtcTime | 취소시간 [hhmmss] |
6 byte
|
tid | 부분취소 거래번호 |
40 byte
|
prtcTid | 원 승인 거래번호 |
40 byte
|
prtcPrice | 부분취소금액 |
12 byte
|
prtcRemains | 부분취소 후 남은금액 |
12 byte
|
prtcCnt | 부분취소 요청 횟수 |
2 byte
|
prtcType | 부분취소 구분 ["0":재승인방식, "1":부분취소] |
1 byte
|
pointAmount | 부분취소 시 취소된 포인트 금액 |
12 byte
|
discountAmount | 부분취소 시 취소된 할인 금액 |
12 byte
|
creditAmount | 부분취소 시 취소된 여신 금액 |
12 byte
|
cashReceiptAmount | 부분취소 후 남은 금액에 대한 현금영수증 발행 대상 금액 |
12 byte
|