[KakaoPay] 카카오페이 단건 결제 기능 구현 방법 (2024 신규 API 버전)

사전준비

• 애플리케이션 등록
• https://developers.kakaopay.com/applications

카카오페이 | 개발자센터

• 키 발급받기

• 관련 문의 포럼
• https://developers.kakaopay.com/forum/

포럼

 

 

2024 카카오페이 API 인증시 사용할 값

• 인증 스키마 
  • (구) "KakaoAK "   ->  (신) " SECRET_KEY "
• Secret Key값은 테스트의 경우 Secret Key(dev) 사용하기

 

 

 

카카오페이 결제 구현 과정

 

• OrderInfoDTO : 사용자 주문 정보
• KakaoPaymentReadyRequestDTO : 카카오 결제 준비 요청에 필요한 Body값
• PaymentInfo : 결제정보 엔티티

[ 예시 코드 더보기 🔽 ]

OrderInfoDTO

@ToString
@Getter
@Setter
@NoArgsConstructor
public class OrderInfoDTO {

    private Integer point_100_Quantity;
    private Integer point_1000_Quantity;
    private String paymentMethod; // 결제 방법
    private String paymentId; // 결제ID

    public OrderInfoDTO(Integer point_100_Quantity, Integer point_1000_Quantity, String paymentMethod, String paymentId) {
        this.point_100_Quantity = point_100_Quantity;
        this.point_1000_Quantity = point_1000_Quantity;
        this.paymentMethod = paymentMethod;
        this.paymentId = paymentId;
    }
}

 

 

KakaoPaymentReadyRequestDTO

@Getter
@Setter
@NoArgsConstructor
@AllArgsConstructor
@Builder
public class KakaoPaymentReadyRequestDTO {

    private String cid;
    private String cid_secret;
    private String partner_order_id;
    private String partner_user_id;
    private String item_name;
    private String item_code;
    private Integer quantity;
    private Integer total_amount;
    private Integer tax_free_amount;
    private Integer vat_amount;
    private Integer green_deposit;
    private String approval_url;
    private String cancel_url;
    private String fail_url;
    private List<String> available_cards;
    private String payment_method_type;
    private Integer install_month;
    private String use_share_installment;
    private Map<String, String> custom_json;
}

 

PaymentInfo

@Entity
@Getter
@NoArgsConstructor
@Table(name = "payment_info")
public class PaymentInfo extends BaseEntity {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    @Column(name = "payment_info_id")
    private Long id;

    @ManyToOne(fetch = FetchType.LAZY)
    @JoinColumn(name = "user_id")
    private RBUser user; // 사용자 ID

    private String aid; // 요청 고유 번호 - 승인/취소가 구분된 결제번호
    private String tid; // 결제 고유 번호 - 승인/취소가 동일한 결제번호
    private String partnerOrderId; // 가맹점 주문번호
    private String partnerUserId; // 가맹점 회원 ID

    @Enumerated(EnumType.STRING) // Enum 값을 문자열로 저장
    private PaymentStatus status; // 결제 상태

    private String itemName;
    private String itemCode;
    private Integer totalPointAmount; // 고객이 구매하는 총 포인트 금액
    private Integer totalAmount; // 상품 총액, 선택적 사용

    private LocalDateTime createdAt; // 결제 준비 요청 시각
    private LocalDateTime approvedAt; // 결제 승인 시각

    @Embedded
    private Amount amount;
    @Embedded
    private CardInfo cardInfo;


    public void setUser(RBUser user) {
        if (this.user != null) {
            this.user.getGameRecords().remove(this);
        }
        this.user = user;
    }

    public void firstPaymentInformation(RBUser user, String partnerOrderId, String partnerUserId,
                                        String itemName, String itemCode, Integer totalAmount, Integer totalPointAmount) {
        this.user = user;
        this.partnerOrderId = partnerOrderId;
        this.partnerUserId = partnerUserId;
        this.itemName = itemName;
        this.itemCode = itemCode;
        this.totalAmount = totalAmount;
        this.totalPointAmount = totalPointAmount;

    }

    public void updatePaymentStatus(PaymentStatus status) {
        this.status = status;
    }

    public void secondPaymentInformation(String tid, LocalDateTime createdAt) {
        this.tid = tid;
        this.createdAt = createdAt;
    }

    public void thirdPaymentInformation(String aid, Amount amount, CardInfo cardInfo, LocalDateTime approvedAt) {
        this.aid = aid;
        this.amount = amount;
        this.cardInfo = cardInfo;
        this.approvedAt = approvedAt;
    }


}

 

 

• KakaoPaymentReadyResponseDTO : 결제 준비에 대한 응답

[ 예시 코드 더보기 🔽 ]

 

KakaoPaymentReadyResponseDTO

@Getter
@Setter
@NoArgsConstructor
@AllArgsConstructor
@Builder
@JsonIgnoreProperties(ignoreUnknown = true)
public class KakaoPaymentReadyResponseDTO {

    private String tid;
    private String next_redirect_app_url;
    private String next_redirect_mobile_url;
    private String next_redirect_pc_url;
    private String android_app_scheme;
    private String ios_app_scheme;
    private boolean tms_result;
    private LocalDateTime created_at;

}

• KakaoPaymentApproveRequestDTO :  결제 승인을 위한 요청 body

[ 예시 코드 더보기 🔽 ]

 

KakaoPaymentApproveRequestDTO 

@Getter
@Setter
@NoArgsConstructor
@AllArgsConstructor
@Builder
public class KakaoPaymentApproveRequestDTO {

    private String cid; // 가맹점 코드
    private String cid_secret; // 가맹점 코드 인증키
    private String tid; // 결제 고유번호
    private String partner_order_id; // 가맹점 주문번호
    private String partner_user_id; // 가맹점 회원 id
    private String pg_token; // 결제승인 요청을 인증하는 토큰
    private String payload; // 결제 승인 요청에 대해 저장하고 싶은 값
    private Integer total_amount; // 상품 총액

    public KakaoPaymentApproveRequestDTO(String cid, String tid, String partner_order_id, String partner_user_id, String pg_token) {
        this.cid = cid;
        this.tid = tid;
        this.partner_order_id = partner_order_id;
        this.partner_user_id = partner_user_id;
        this.pg_token = pg_token;
    }
}

• KakaoPaymentApproveResponseDTO : 성공 시 응답 bady 담기

[ 예시 코드 더보기 🔽 ]

KakaoPaymentApproveResponseDTO

• money 결제 -> Amount
• card결제 -> CardInfo

 

KakaoPaymentApproveResponseDTO

@Getter
@Setter
@NoArgsConstructor
@AllArgsConstructor
@Builder
@JsonIgnoreProperties(ignoreUnknown = true)
public class KakaoPaymentApproveResponseDTO {

    private String aid;
    private String tid;
    private String cid;
    private String sid; // 필드 추가  (구 API에서만 필요했음)
    private String partnerOrderId;
    private String partnerUserId;
    private String paymentMethodType;
    private String itemName;
    private int quantity;
    private LocalDateTime createdAt;
    private LocalDateTime approvedAt;

    private Amount amount; // 금액 정보
    private CardInfo cardInfo; // 카드 정보, 결제 수단이 카드일 때만 존재

}

 

@Embeddable
@Getter
@Setter
@NoArgsConstructor
@AllArgsConstructor
@Builder
public class Amount {

    private Integer total;
    private Integer taxFree;
    private Integer vat;
    private Integer point;
    private Integer discount;
    private Integer greenDeposit;
    private Integer taxFreeAmount; // 비과세 금액
    private Integer vatAmount; // 부가세 금액

}

@Embeddable
@Getter
@Setter
@NoArgsConstructor
@AllArgsConstructor
@Builder
public class CardInfo {
    private String kakaopayPurchaseCorp;
    private String kakaopayPurchaseCorpCode;
    private String kakaopayIssuerCorp;
    private String kakaopayIssuerCorpCode;
    private String bin;
    private String cardType;
    private String installMonth;
    private String approvedId;
    private String cardMid;
    private String interestFreeInstall;
    private String installmentType;
    private String cardItemCode;
}

 

 

• 설명 이미지 통합본 PDF

카카오페이(완).pdf

0.62MB

 

 

 

구현 과정에서 겪은 오류

2024.03.29 - [🖥️ 백엔드/SpringBoot] - [KakaoPay] 카카오페이 단건 결제 과정 중 겪은 오류 모음

[KakaoPay] 카카오페이 단건 결제 과정 중 겪은 오류 모음

 

 

 

컨트롤러 요청 예시

2024.03.29 - [🖥️ 백엔드/SpringBoot] - [KakaoPay] 카카오페이 단건 결제 컨트롤러 예시

[KakaoPay] 카카오페이 단건 결제 컨트롤러 예시