Add additional Korean payment methods

CHANGELOG.md

@@ -20,6 +20,12 @@ in a response, this weakens the Typescript type but does not cause existing usag
 This means when upgrading minor versions of the SDK, you may notice type errors. You can safely ignore these or fix by
 adding additional type guards.
 
+## 3.4.0 - 2025-11-11
+
+### Added
+
+- Added additional support for local Korean payment methods. See [related changelog](https://developer.paddle.com/changelog/2025/improved-korean-payment-methods?utm_source=dx&utm_medium=paddle-node-sdk)
+
 ## 3.3.0 - 2025-10-07
 
 ### Added
@@ -447,11 +453,10 @@ see [related changelog](https://developer.paddle.com/changelog/2024/product-pric
 ### Removed
 
 - **Breaking change:** Removed `*Includes` entity in favour of standard entities.
-
-    - Use `Price` instead of `PriceWithIncludes`
-    - Use `Product` instead of `ProductWithIncludes`
-    - Use `Subscription` instead of `SubscriptionIncludes`
-    - Use `Transaction` instead of `TransactionIncludes`
+  - Use `Price` instead of `PriceWithIncludes`
+  - Use `Product` instead of `ProductWithIncludes`
+  - Use `Subscription` instead of `SubscriptionIncludes`
+  - Use `Transaction` instead of `TransactionIncludes`
 
 ---
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@paddle/paddle-node-sdk",
-  "version": "3.3.0",
+  "version": "3.4.0",
   "description": "A Node.js SDK that you can use to integrate Paddle Billing with applications written in server-side JavaScript.",
   "main": "dist/cjs/index.cjs.node.js",
   "module": "dist/esm/index.esm.node.js",

src/__tests__/mocks/notifications/transaction-completed.mock.ts

@@ -199,6 +199,7 @@ export const TransactionCompletedMock: IEventsResponse<ITransactionNotificationR
         captured_at: '2023-08-22T07:15:43.792797Z',
         method_details: {
           card: { type: 'visa', last4: '4242', expiry_year: 2025, expiry_month: 12, cardholder_name: 'Joe Bloggs' },
+          south_korea_local_card: null,
           type: 'card',
           underlying_details: null,
         },
@@ -213,6 +214,7 @@ export const TransactionCompletedMock: IEventsResponse<ITransactionNotificationR
         captured_at: null,
         method_details: {
           card: { type: 'visa', last4: '0000', expiry_year: 2025, expiry_month: 12, cardholder_name: 'Joe Bloggs' },
+          south_korea_local_card: null,
           type: 'card',
           underlying_details: null,
         },
@@ -555,6 +557,7 @@ export const TransactionCompletedMockExpectation = {
             last4: '4242',
             type: 'visa',
           },
+          southKoreaLocalCard: null,
           type: 'card',
           underlyingDetails: null,
         },
@@ -576,6 +579,7 @@ export const TransactionCompletedMockExpectation = {
             last4: '0000',
             type: 'visa',
           },
+          southKoreaLocalCard: null,
           type: 'card',
           underlyingDetails: null,
         },

src/__tests__/mocks/notifications/transaction-paid.mock.ts

@@ -167,6 +167,7 @@ export const TransactionPaidMock: IEventsResponse<ITransactionNotificationRespon
         captured_at: '2023-04-13T09:07:04.730931Z',
         method_details: {
           card: { type: 'visa', last4: '3184', expiry_year: 2024, expiry_month: 1, cardholder_name: 'Jo Williams' },
+          south_korea_local_card: null,
           type: 'card',
           underlying_details: null,
         },
@@ -461,6 +462,7 @@ export const TransactionPaidMockExpectation = {
             last4: '3184',
             type: 'visa',
           },
+          southKoreaLocalCard: null,
           type: 'card',
           underlyingDetails: null,
         },

src/__tests__/mocks/notifications/transaction-past-due.mock.ts

@@ -138,6 +138,7 @@ export const TransactionPastDueMock: IEventsResponse<ITransactionNotificationRes
         captured_at: null,
         method_details: {
           card: { type: 'visa', last4: '3184', expiry_year: 2025, expiry_month: 1, cardholder_name: 'Jo Williams' },
+          south_korea_local_card: null,
           type: 'card',
           underlying_details: null,
         },
@@ -387,6 +388,7 @@ export const TransactionPastDueMockExpectation = {
             last4: '3184',
             type: 'visa',
           },
+          southKoreaLocalCard: null,
           type: 'card',
           underlyingDetails: null,
         },

src/__tests__/mocks/notifications/transaction-payment-failed.mock.ts

@@ -176,6 +176,7 @@ export const TransactionPaymentFailedMock: IEventsResponse<ITransactionNotificat
         captured_at: null,
         method_details: {
           card: { type: 'visa', last4: '0000', expiry_year: 2025, expiry_month: 12, cardholder_name: 'Jo Williams' },
+          south_korea_local_card: null,
           type: 'card',
           underlying_details: null,
         },
@@ -491,6 +492,7 @@ export const TransactionPaymentFailedMockExpectation = {
             last4: '0000',
             type: 'visa',
           },
+          southKoreaLocalCard: null,
           type: 'card',
           underlyingDetails: null,
         },

src/__tests__/mocks/notifications/transaction-revised.mock.ts

@@ -287,6 +287,7 @@ export const TransactionRevisedMock: IEventsResponse<ITransactionNotificationRes
             expiry_month: 1,
             cardholder_name: 'Michael McGovern',
           },
+          south_korea_local_card: null,
           type: 'card',
           underlying_details: null,
         },
@@ -308,6 +309,7 @@ export const TransactionRevisedMock: IEventsResponse<ITransactionNotificationRes
             expiry_month: 1,
             cardholder_name: 'Michael McGovern',
           },
+          south_korea_local_card: null,
           type: 'card',
           underlying_details: null,
         },
@@ -632,6 +634,7 @@ export const TransactionRevisedMockExpectation = {
             last4: '3184',
             type: 'visa',
           },
+          southKoreaLocalCard: null,
           type: 'card',
           underlyingDetails: null,
         },
@@ -653,6 +656,7 @@ export const TransactionRevisedMockExpectation = {
             last4: '0002',
             type: 'visa',
           },
+          southKoreaLocalCard: null,
           type: 'card',
           underlyingDetails: null,
         },

src/__tests__/mocks/resources/payment-methods.mock.ts

@@ -21,6 +21,7 @@ export const PaymentMethodMock: IPaymentMethodResponse = {
     cardholder_name: 'Sam Miller',
   },
   paypal: null,
+  south_korea_local_card: null,
   underlying_details: null,
   origin: 'saved_during_purchase',
   saved_at: '2024-05-03T11:50:23.422Z',

src/__tests__/mocks/resources/transactions.mock.ts

@@ -282,6 +282,7 @@ export const TransactionMock: ITransactionResponse = {
           last4: '',
           type: 'american_express',
         },
+        south_korea_local_card: null,
         underlying_details: null,
       },
       created_at: '2024-10-12T07:20:50.52Z',

src/entities/payment-method/payment-method.ts

@@ -6,7 +6,7 @@
 
 import type { SavedPaymentMethodType, SavedPaymentOrigin } from '../../enums/index.js';
 import type { IPaymentMethodResponse } from '../../types/index.js';
-import { PaymentCard, PaymentMethodUnderlyingDetails, PayPal } from '../shared/index.js';
+import { PaymentCard, PaymentMethodUnderlyingDetails, PayPal, SouthKoreaLocalCard } from '../shared/index.js';
 
 export class PaymentMethod {
   public readonly id: string;
@@ -15,6 +15,8 @@ export class PaymentMethod {
   public readonly type: SavedPaymentMethodType;
   public readonly card: PaymentCard | null;
   public readonly paypal: PayPal | null;
+  public readonly southKoreaLocalCard: SouthKoreaLocalCard | null;
+  /** @deprecated */
   public readonly underlyingDetails: PaymentMethodUnderlyingDetails | null;
   public readonly origin: SavedPaymentOrigin;
   public readonly savedAt: string;
@@ -27,6 +29,9 @@ export class PaymentMethod {
     this.type = paymentMethodResponse.type;
     this.card = paymentMethodResponse.card ? new PaymentCard(paymentMethodResponse.card) : null;
     this.paypal = paymentMethodResponse.paypal ? new PayPal(paymentMethodResponse.paypal) : null;
+    this.southKoreaLocalCard = paymentMethodResponse.south_korea_local_card
+      ? new SouthKoreaLocalCard(paymentMethodResponse.south_korea_local_card)
+      : null;
     this.underlyingDetails = paymentMethodResponse.underlying_details
       ? new PaymentMethodUnderlyingDetails(paymentMethodResponse.underlying_details)
       : null;

src/entities/shared/index.ts

@@ -29,3 +29,4 @@ export * from './simulation-event-request.js';
 export * from './simulation-event-response.js';
 export * from './payment-method-underlying-details.js';
 export * from './korean-market-underlying-details.js';
+export * from './south-korea-local-card.js';

src/entities/shared/payment-method-details.ts

@@ -8,15 +8,21 @@ import { type PaymentType } from '../../enums/index.js';
 import { PaymentCard } from './payment-card.js';
 import { type IPaymentMethodDetails } from '../../types/index.js';
 import { PaymentMethodUnderlyingDetails } from './payment-method-underlying-details.js';
+import { SouthKoreaLocalCard } from './south-korea-local-card.js';
 
 export class PaymentMethodDetails {
   public readonly type: PaymentType;
   public readonly card: PaymentCard | null;
+  public readonly southKoreaLocalCard: SouthKoreaLocalCard | null;
+  /** @deprecated */
   public readonly underlyingDetails: PaymentMethodUnderlyingDetails | null;
 
   constructor(paymentMethodDetails: IPaymentMethodDetails) {
     this.type = paymentMethodDetails.type;
     this.card = paymentMethodDetails.card ? new PaymentCard(paymentMethodDetails.card) : null;
+    this.southKoreaLocalCard = paymentMethodDetails.south_korea_local_card
+      ? new SouthKoreaLocalCard(paymentMethodDetails.south_korea_local_card)
+      : null;
     this.underlyingDetails = paymentMethodDetails.underlying_details
       ? new PaymentMethodUnderlyingDetails(paymentMethodDetails.underlying_details)
       : null;

src/entities/shared/south-korea-local-card.ts

@@ -0,0 +1,18 @@
+/**
+ *  ! Autogenerated code !
+ *  Do not make changes to this file.
+ *  Changes may be overwritten as part of auto-generation.
+ */
+
+import { type SouthKoreaLocalCardType } from '../../enums/index.js';
+import { type ISouthKoreaLocalCardResponse } from '../../types/index.js';
+
+export class SouthKoreaLocalCard {
+  public readonly type: SouthKoreaLocalCardType;
+  public readonly last4: string;
+
+  constructor(southKoreaLocalCard: ISouthKoreaLocalCardResponse) {
+    this.type = southKoreaLocalCard.type;
+    this.last4 = southKoreaLocalCard.last4;
+  }
+}

src/enums/payment-method/type.ts

@@ -4,14 +4,22 @@
  *  Changes may be overwritten as part of auto-generation.
  */
 
+/**
+ * @deprecated 'korea_local' is deprecated. Use 'south_korea_local_card', 'kakao_pay', 'naver_pay', 'payco', or 'samsung_pay' instead.
+ */
 export type SavedPaymentMethodType =
   | 'alipay'
   | 'apple_pay'
   | 'blik'
   | 'card'
   | 'google_pay'
-  | 'mb_way'
+  | 'kakao_pay'
   | 'korea_local'
+  | 'south_korea_local_card'
+  | 'mb_way'
+  | 'naver_pay'
+  | 'payco'
   | 'paypal'
   | 'pix'
+  | 'samsung_pay'
   | 'upi';

src/enums/shared/available-payment-methods.ts

@@ -4,6 +4,9 @@
  *  Changes may be overwritten as part of auto-generation.
  */
 
+/**
+ * @deprecated 'korea_local' is deprecated. Use 'south_korea_local_card', 'kakao_pay', 'naver_pay', 'payco', or 'samsung_pay' instead.
+ */
 export type AvailablePaymentMethod =
   | 'alipay'
   | 'apple_pay'
@@ -12,8 +15,13 @@ export type AvailablePaymentMethod =
   | 'card'
   | 'google_pay'
   | 'ideal'
+  | 'kakao_pay'
   | 'korea_local'
+  | 'south_korea_local_card'
   | 'mb_way'
+  | 'naver_pay'
+  | 'payco'
   | 'paypal'
   | 'pix'
+  | 'samsung_pay'
   | 'upi';

src/enums/shared/index.ts

@@ -21,3 +21,4 @@ export * from './catalog-type.js';
 export * from './available-payment-methods.js';
 export * from './disposition.js';
 export * from './korean-market-underlying-payment-method-type.js';
+export * from './south-korea-local-card-type.js';

src/enums/shared/korean-market-underlying-payment-method-type.ts

@@ -4,6 +4,9 @@
  *  Changes may be overwritten as part of auto-generation.
  */
 
+/**
+ * @deprecated The following values are deprecated: 'kakaopay', 'naverpaycard', 'naverpaypoint', 'payco', 'samsungpay'
+ */
 export type KoreanMarketUnderlyingPaymentMethodType =
   | 'bc'
   | 'citi'

src/enums/shared/payment-type.ts

@@ -4,6 +4,9 @@
  *  Changes may be overwritten as part of auto-generation.
  */
 
+/**
+ * @deprecated 'korea_local' is deprecated. Use 'south_korea_local_card', 'kakao_pay', 'naver_pay', 'payco', or 'samsung_pay' instead.
+ */
 export type PaymentType =
   | 'alipay'
   | 'apple_pay'
@@ -12,11 +15,16 @@ export type PaymentType =
   | 'card'
   | 'google_pay'
   | 'ideal'
+  | 'kakao_pay'
   | 'korea_local'
+  | 'south_korea_local_card'
   | 'mb_way'
+  | 'naver_pay'
   | 'offline'
+  | 'payco'
   | 'paypal'
   | 'pix'
+  | 'samsung_pay'
   | 'unknown'
   | 'upi'
   | 'wire_transfer';

src/enums/shared/south-korea-local-card-type.ts

@@ -0,0 +1,30 @@
+/**
+ *  ! Autogenerated code !
+ *  Do not make changes to this file.
+ *  Changes may be overwritten as part of auto-generation.
+ */
+
+export type SouthKoreaLocalCardType =
+  | 'bc'
+  | 'citi'
+  | 'hana'
+  | 'hyundai'
+  | 'jeju'
+  | 'jeonbuk'
+  | 'kakaobank'
+  | 'kbank'
+  | 'kdbbank'
+  | 'kookmin'
+  | 'kwangju'
+  | 'lotte'
+  | 'mg'
+  | 'nh'
+  | 'post'
+  | 'samsung'
+  | 'savingsbank'
+  | 'shinhan'
+  | 'shinhyup'
+  | 'suhyup'
+  | 'tossbank'
+  | 'unknown'
+  | 'woori';

src/notifications/entities/shared/index.ts

@@ -26,3 +26,4 @@ export * from './payout-totals-adjustment-notification.js';
 export * from './import-meta-notification.js';
 export * from './korean-market-underlying-details-notification.js';
 export * from './payment-method-underlying-details-notification.js';
+export * from './south-korea-local-card-notification.js';

src/notifications/entities/shared/payment-method-details-notification.ts

@@ -8,15 +8,21 @@ import { type PaymentType } from '../../../enums/index.js';
 import { PaymentCardNotification } from './payment-card-notification.js';
 import { type IPaymentMethodDetailsNotification } from '../../types/index.js';
 import { PaymentMethodUnderlyingDetailsNotification } from './payment-method-underlying-details-notification.js';
+import { SouthKoreaLocalCardNotification } from './south-korea-local-card-notification.js';
 
 export class PaymentMethodDetailsNotification {
   public readonly type: PaymentType;
   public readonly card: PaymentCardNotification | null;
+  public readonly southKoreaLocalCard: SouthKoreaLocalCardNotification | null;
+  /** @deprecated */
   public readonly underlyingDetails: PaymentMethodUnderlyingDetailsNotification | null;
 
   constructor(paymentMethodDetails: IPaymentMethodDetailsNotification) {
     this.type = paymentMethodDetails.type;
     this.card = paymentMethodDetails.card ? new PaymentCardNotification(paymentMethodDetails.card) : null;
+    this.southKoreaLocalCard = paymentMethodDetails.south_korea_local_card
+      ? new SouthKoreaLocalCardNotification(paymentMethodDetails.south_korea_local_card)
+      : null;
     this.underlyingDetails = paymentMethodDetails.underlying_details
       ? new PaymentMethodUnderlyingDetailsNotification(paymentMethodDetails.underlying_details)
       : null;