결제 취소

결제 완료된 거래 전체취소 처리를 하는 API 입니다.

요청

요청 URL
POST https://{API 도메인}/appcardpay/v1/cancel.do
Content-type: application/json; charset=euc-kr

참고

API 멱등성 지원 대상 (API 멱등성 참조)

주의사항

최종 결제 취소가 완료되기까지 시간이 걸리므로 timeout을 30초로 설정해야 합니다.
응답 대기시간 초과 및 네트워크 오류로 응답을 받지 못한 경우 반드시 거래상태 조회를 통해 PG 거래고유번호를 조회 후 취소처리 바랍니다. 거래상태 조회 참고

파라미터

필드명	타입	길이	필수여부	설명
vanTid	String	8Byte	✅	VAN 터미널ID
shopTransactionId	String	60Byte	✅	상점 거래고유번호 (API 멱등성 키)
controlNo	String	20Byte	✅	원 승인 KICC 거래일련번호
approvalReqDate	String	8Byte	✅	원 승인 요청일자(yyyyMMdd)
cancelReqDate	String	8Byte	✅	취소 요청일자(yyyyMMdd)

요청 예시
{  
   "vanTid": "T5102001", 
   "shopTransactionId": "{API 멱등성 키}", 
   "controlNo": "{PG 거래고유번호}",
   "approvalReqDate": "{원 승인 요청일자}",
   "cancelReqDate": "{취소 요청일자}"
}

응답

파라미터

필드명	타입	길이	설명
resCd	String	4Byte	결과코드(정상 : “0000”)
resMsg	String	1000Byte	결과 메시지
shopTransactionId	String	60Byte	취소요청 시 전송한 값 그대로 사용
vanTid	String	8Byte	VAN 터미널ID
cancelControlNo	String	20Byte	결제취소 KICC 거래일련번호
transactionDate	String	14Byte	거래일시(yyyyMMddHHmmss)
vanSerial	String	20Byte	VAN 취소 거래일련번호
amount	Number		총 취소금액

응답 예시
{
  "resCd": "0000",
  "resMsg": "정상취소",
  "vanTid": "{요청한 VAN 터미널 ID}",
  "shopTransactionId": "{요청한 API 멱등성 키}",
  "cancelControlNo": "{결제취소 KICC 거래일련번호}",  
  "transactionDate": "20210326090200",
  "vanSerial": "{VAN 취소 거래일련번호}",   
  "amount": 0
}

요청​

파라미터​

응답​

파라미터​

요청

파라미터

응답

파라미터