Class PaymentInstrumentNotificationService

Builds the PAYMENT_INSTRUMENT email payload for a payment-instrument status change and hands it to the CustomerNotificationService core. Lives in payment-instrument-services (next to the per-type writer services) so it can use the instrument domain types; each writer calls notify right where it publishes the paymentInstrument.<type>.statusUpdated event.

Relocated from the customer-dashboard paymentInstrument webhook handler.

Index

Constructors

constructor

Methods

notify

Constructors

constructor

new PaymentInstrumentNotificationService(
    args: {
        appBaseUrl: string;
        customerNotificationService: CustomerNotificationService;
        customerService: CustomerService;
        templateId: string;
    },
): PaymentInstrumentNotificationService
Parameters
- args: {
      appBaseUrl: string;
      customerNotificationService: CustomerNotificationService;
      customerService: CustomerService;
      templateId: string;
  }
  - appBaseUrl: string
  - customerNotificationService: CustomerNotificationService
  - customerService: CustomerService
  - templateId: string
    SendGrid template id for the PAYMENT_INSTRUMENT notification.
Returns PaymentInstrumentNotificationService
- Defined in packages/payment-instrument-services/src/PaymentInstrumentNotificationService.ts:43

Methods

notify

notify(
    __namedParameters: {
        customerId: string;
        event: NotifiablePaymentInstrumentEvent;
        paymentInstrument: NotifiablePaymentInstrument;
    },
): Promise<void>
Notify the relevant recipients of a payment-instrument status change. Best-effort. event must be the specific per-type event name the writer published, so the core's creator-backfill maps it to the right activity.
Parameters
- __namedParameters: {
      customerId: string;
      event: NotifiablePaymentInstrumentEvent;
      paymentInstrument: NotifiablePaymentInstrument;
  }
Returns Promise<void>
- Defined in packages/payment-instrument-services/src/PaymentInstrumentNotificationService.ts:61

Class PaymentInstrumentNotificationService

Index

Constructors

Methods

Constructors

constructor

Parameters

appBaseUrl: string

customerNotificationService: CustomerNotificationService

customerService: CustomerService

templateId: string

Returns PaymentInstrumentNotificationService

Methods

notify

Parameters

Returns Promise<void>

Settings

On This Page