Merge pull request #1747 from maxmind/wstorey/eng-2874-eventparty-and-paymentmethod-minfraud-inputs-are-supported

Add /event/party, /payment/method, and new /event/type values

Author: oschwald

CHANGELOG.md

@@ -5,6 +5,12 @@ CHANGELOG
 ------------------
 
 * Added `Securepay` to the `Processor` enum.
+* Added `CreditApplication` and `FundTransfer` to the `EventType` enum.
+* Added the input `/event/party`. This is the party submitting the
+  transaction. You may provide this by providing `party` to `Event`.
+* Added the input `/payment/method`. This is the payment method associated
+  with the transaction. You may provide this by providing `method` to
+  `Payment`.
 
 8.1.0 (2025-05-23)
 ------------------

README.md

@@ -181,6 +181,7 @@ try {
       ipAddress: "81.2.69.160",
     }),
     event: new minFraud.Event({
+      party: minFraud.Constants.EventParty.Customer,
       shopId: 'shop',
       time: new Date(Date.now()),
       transactionId: 'txn1234',
@@ -223,6 +224,7 @@ try {
     }),
     payment: new minFraud.Payment({
       declineCode: 'A',
+      method: minFraud.Constants.PaymentMethod.Card,
       processor: minFraud.Constants.Processor.ConceptPayments,
       wasAuthorized: true,
     }),

src/constants.ts

@@ -1,7 +1,14 @@
+export enum EventParty {
+  Agent = 'agent',
+  Customer = 'customer',
+}
+
 export enum EventType {
   AccountCreation = 'account_creation',
   AccountLogin = 'account_login',
+  CreditApplication = 'credit_application',
   EmailChange = 'email_change',
+  FundTransfer = 'fund_transfer',
   PasswordReset = 'password_reset',
   PayoutChange = 'payout_change',
   Purchase = 'purchase',
@@ -17,6 +24,19 @@ export enum DeliverySpeed {
   Standard = 'standard',
 }
 
+export enum PaymentMethod {
+  BankDebit = 'bank_debit',
+  BankRedirect = 'bank_redirect',
+  BankTransfer = 'bank_transfer',
+  BuyNowPayLater = 'buy_now_pay_later',
+  Card = 'card',
+  Crypto = 'crypto',
+  DigitalWallet = 'digital_wallet',
+  GiftCard = 'gift_card',
+  RealTimePayment = 'real_time_payment',
+  Rewards = 'rewards',
+}
+
 export enum Processor {
   Adyen = 'adyen',
   Affirm = 'affirm',

src/request/event.spec.ts

@@ -1,4 +1,5 @@
 import Event from './event';
+import { EventParty, EventType } from '../constants';
 
 describe('Event()', () => {
   it('sets `time` to now by default', () => {
@@ -14,4 +15,36 @@ describe('Event()', () => {
 
     expect(event.time).toEqual(mockDate);
   });
+
+  it('accepts credit_application event type', () => {
+    const event = new Event({
+      type: EventType.CreditApplication,
+    });
+
+    expect(event.type).toEqual(EventType.CreditApplication);
+  });
+
+  it('accepts fund_transfer event type', () => {
+    const event = new Event({
+      type: EventType.FundTransfer,
+    });
+
+    expect(event.type).toEqual(EventType.FundTransfer);
+  });
+
+  it('accepts agent party', () => {
+    const event = new Event({
+      party: EventParty.Agent,
+    });
+
+    expect(event.party).toEqual(EventParty.Agent);
+  });
+
+  it('accepts customer party', () => {
+    const event = new Event({
+      party: EventParty.Customer,
+    });
+
+    expect(event.party).toEqual(EventParty.Customer);
+  });
 });

src/request/event.ts

@@ -1,6 +1,10 @@
-import { EventType } from '../constants';
+import { EventParty, EventType } from '../constants';
 
 interface EventProps {
+  /**
+   * The party submitting the transaction.
+   */
+  party?: EventParty;
   /**
    * Your internal ID for the transaction. We can use this to locate a specific
    * transaction in our logs, and it will also show up in email alerts and
@@ -27,13 +31,15 @@ interface EventProps {
  * Event information for the transaction being sent to the web service.
  */
 export default class Event implements EventProps {
+  /** @inheritDoc EventProps.party */
+  public party?: EventParty;
   /** @inheritDoc EventProps.transactionId */
   public transactionId?: string;
   /** @inheritDoc EventProps.shopId */
   public shopId?: string;
   /** @inheritDoc EventProps.time */
   public time?: Date;
-  /** @inheritDoc EventProps.EventType */
+  /** @inheritDoc EventProps.type */
   public type?: EventType;
 
   public constructor(minfraudEvent: EventProps) {

src/request/payment.spec.ts

@@ -1,4 +1,5 @@
 import Payment from './payment';
+import { PaymentMethod } from '../constants';
 
 describe('Payment()', () => {
   it('constructs', () => {
@@ -8,4 +9,28 @@ describe('Payment()', () => {
       });
     }).not.toThrow();
   });
+
+  it('accepts card payment method', () => {
+    const payment = new Payment({
+      method: PaymentMethod.Card,
+    });
+
+    expect(payment.method).toEqual(PaymentMethod.Card);
+  });
+
+  it('accepts crypto payment method', () => {
+    const payment = new Payment({
+      method: PaymentMethod.Crypto,
+    });
+
+    expect(payment.method).toEqual(PaymentMethod.Crypto);
+  });
+
+  it('accepts digital_wallet payment method', () => {
+    const payment = new Payment({
+      method: PaymentMethod.DigitalWallet,
+    });
+
+    expect(payment.method).toEqual(PaymentMethod.DigitalWallet);
+  });
 });

src/request/payment.ts

@@ -1,6 +1,10 @@
-import { Processor } from '../constants';
+import { PaymentMethod, Processor } from '../constants';
 
 interface PaymentProps {
+  /**
+   * The payment method associated with the transaction.
+   */
+  method?: PaymentMethod;
   /**
    * The payment processor used for the transaction.
    */
@@ -21,6 +25,8 @@ interface PaymentProps {
  * The payment information for the transaction being sent to the web service.
  */
 export default class Payment implements PaymentProps {
+  /** @inheritDoc PaymentProps.method */
+  public method?: PaymentMethod;
   /** @inheritDoc PaymentProps.processor */
   public processor?: Processor;
   /** @inheritDoc PaymentProps.wasAuthorized */