💳 토스페이먼츠 연동하기 (4) _결제 취소 / 결제 내역 조회

📌 해당 게시물은 전 게시물과 이어지는 내용입니다.

지금까지 결제하는 로직을 모두 완성하였는데 이번 포스팅에서는 결제를 취소하는 것을 구현하려고 한다.

결제를 취소하려면 결제 승인 시에 토스페이먼츠에서 발급받은 paymentKey와 취소 이유인 cancelReason이 꼭 필요하다.

또, 성공/실패 시와 같이 헤더에 시크릿 키를 인코딩하여 보내야한다.

---

🌼 결제 취소 처리 + 검증 로직

✔️ 결제 취소 Controller

• tossPaymentCanclePoint
  

➜ 취소 요청을 받을 Controller
⠀
➜ 필요한 정보(고객 정보/paymentKey/취소 이유)를 받아 Service 로직에서 검증을 완료한 후 결제 상태를 취소로 바꿔줌

---

✔️ 결제 취소 Service

• cancelPaymentPoint()
  

➜ Controller에서 전달받은 값들을 이용하여 검증 로직들을 처리하는 메서드
⠀
➜ 결제 취소 시에 잔여 포인트가 취소하려는 금액만큼 없다면 불가능
( 이 프로젝트는 결제 = 포인트 충전임 )
⠀

• tossPaymentCancel()
  

⚠️ ➜ 토스페이먼츠에 최종 취소 승인 요청을 보내기 위해 필요한 정보들을 담아 POST로 보내는 부분

➜ net.minidev.json.JSONObject를 사용하여 키/값 쌍을 문자열이 아닌 오브젝트로 숫자 그대로 보낼 수 있음

➜ postForObject() 안에 필요한 정보인 < 요청 URL + 요청 객체 + 응답 Map.class >를 넣어주면 됨

✔ 요청 URL
➜ "https://api.tosspayments.com/v1/payments/" + paymentKey + "/cancle"

• getHeaders()
  

( ⬆️ 결제 성공 / 실패 시에 사용한 getHeaders()와 동일한 메서드임 )

➜ 헤더에는 토스에서 제공해준 시크릿 키를 Basic Authorization 방식으로 base64를 이용하여 인코딩하여 꼭 보내야함
( ❗ 꼭! {시크릿키 + ":"} 조합으로 인코딩하기 )

---

🚩 여기까지 결제 취소 로직을 구현하고 테스트를 해보았는데,

아래와 같이 CancleYN가 true로 바뀌고 취소 이유가 저장된 것을 확인할 수 있다.

테스트 사진 넣을 예정

❗ 결제 금액 중 일부만 취소하려면 cancelAmount에 취소할 금액을 추가해서 결제 취소 API를 요청하면 된다고 한다.
토스페이먼츠 참고

---

🌼 결제 내역 조회

✔️ 결제 내역 조회 Controller

• getChargingHistory
  

➜ 결제 내역 조회 요청을 받을 Controller
⠀
➜ 해당 고객 정보를 가져와 Service 로직을 타고 Repository에서 알맞은 정보들을 찾아와 반환

이 프로젝트의 경우,
데이터를 슬라이스 형식으로 보여주기 위해 SliceResponseDto를 사용하였다.

• SliceResponseDto<T>
  
• SliceInfo
  

---

✔️ 결제 내역 조회 Dto

• ChargingHistoryDto
  

➜ 결제 내역을 반환하기 위한 응답 데이터

---

✔️ 결제 내역 조회 Mapper

• PaymentMapper
  

➜ List 형태의 결제 내역을 stream을 사용하여 dto(응답 객체)의 각 요소들에 해당 값을 넣어줌

---

✔️ 결제 내역 조회 Service

• findAllChargingHistories
  

➜ 고객 정보를 가져와 해당 고객이 맞는지 검증 후에 paymentRepository에서 해당 고객의 결제 내역을 모두 가져와 반환하는 부분

➜ paymentId를 기준으로 내림차순 정렬하여 반환

---

🚩 여기까지 하고 postman으로 결제 내역을 조회해보면,

아래와 같이 잘 나오는 것을 확인할 수 있다 !

우리 프로젝트에서도 충전 내역이 잘 나타나는 것을 확인할 수 있다.

---

여기까지 프로젝트에서 구현한 토스페이먼츠 연동 관련 포스팅이었습니다.