KakaoCancelResponse (카카오페이 결제 취소 응답 DTO)
@Data
@Builder
@ToString
@NoArgsConstructor
@AllArgsConstructor
public class KakaoCancelResponse {
private String aid; // 요청 고유 번호
private String tid; // 결제 고유 번호
private String cid; // 가맹점 코드
private String status; // 결제 상태 (예: “CANCELLED”)
private String partner_order_id; // 가맹점 주문 번호
private String partner_user_id; // 가맹점 회원 ID
private String payment_method_type; // 결제 수단 (예: “KAKAO_PAY”)
private Amount amount; // 원래 결제 금액 정보
private ApprovedCancelAmount approved_cancel_amount; // 이번 요청으로 취소된 금액
private CanceledAmount canceled_amount; // 누적 취소된 금액
private CancelAvailableAmount cancel_available_amount; // 남은 취소 가능 금액
private String item_name; // 상품 이름
private String item_code; // 상품 코드
private int quantity; // 상품 수량
private String created_at; // 결제 준비 요청 시각 (YYYY-MM-DDTHH:mm:ss)
private String approved_at; // 결제 승인 시각
private String canceled_at; // 결제 취소 시각
private String payload; // 취소 요청 시 전달한 값
/**
* 이번 요청으로 취소된 금액
*/
@Getter
@Setter
@ToString
public static class ApprovedCancelAmount {
private int total; // 이번 요청으로 취소된 전체 금액
private int tax_free; // 취소된 비과세 금액
private int vat; // 취소된 부가세 금액
private int point; // 취소된 포인트 금액
private int discount; // 취소된 할인 금액
private int green_deposit; // 컵 보증금 취소 금액
}
/**
* 누계 취소 금액
*/
@Getter
@Setter
@ToString
public static class CanceledAmount {
private int total; // 누적 취소된 전체 금액
private int tax_free; // 누적 비과세 금액
private int vat; // 누적 부가세 금액
private int point; // 누적 포인트 금액
private int discount; // 누적 할인 금액
private int green_deposit; // 누적 컵 보증금 금액
}
/**
* 취소 요청 시 전달한 값 (남은 취소 가능 금액)
*/
@Getter
@Setter
@ToString
public static class CancelAvailableAmount {
private int total; // 전체 취소 가능 금액
private int tax_free; // 취소 가능 비과세 금액
private int vat; // 취소 가능 부가세 금액
private int point; // 취소 가능 포인트 금액
private int discount; // 취소 가능 할인 금액
private int green_deposit; // 취소 가능 컵 보증금 금액
}
}
설명
- aid, tid, cid
– 카카오페이 요청 고유 번호(aid), 결제 고유 번호(tid), 가맹점 코드(cid).
- status
– 현재 결제 상태 (예: “CANCELLED”).
- partner\_order\_id, partner\_user\_id
– 가맹점 주문 번호, 가맹점 회원 ID.
- payment\_method\_type
– 결제 수단 (예: “KAKAO\_PAY”).
- amount
– 원래 결제 금액 (
Amount DTO 포함).
- approved\_cancel\_amount
– 이번 취소 요청으로 실제로 취소된 금액 정보 (총액, 비과세, 부가세, 포인트, 할인, 그린 보증금).
- canceled\_amount
– 지금까지 누적해서 취소된 금액 정보 (총액, 비과세, 부가세, 포인트, 할인, 그린 보증금).
- cancel\_available\_amount
– 아직 취소가 가능한 금액 정보 (총액, 비과세, 부가세, 포인트, 할인, 그린 보증금).
- item\_name, item\_code, quantity
– 취소 대상 상품 이름, 코드, 수량.
- created\_at, approved\_at, canceled\_at
– 각각 결제 준비 시각, 결제 승인 시각, 결제 취소 시각 (ISO 8601 형식).
- payload
– 취소 요청 시 전달한 추가 데이터(예: 내부 식별자).
approved_cancel_amount : 이 API 호출로 새롭게 취소된 금액
canceled_amount : 지금까지 취소된 누적 금액
cancel_available_amount : 앞으로 취소 가능한 금액