Class ExternalUsAchPaymentInstrumentService

Maintain external ACH debit payment instruments.

These represent ACH debit originators where only the originator name is known (no account/routing number).

Index

Constructors

Methods

create delete upsert

Constructors

constructor

new ExternalUsAchPaymentInstrumentService(
    args: {
        db: B2bDatabase;
        entityEventPublisher: EntityEventPublisher;
        entityService: EntityService;
    },
): ExternalUsAchPaymentInstrumentService
Parameters
- args: {
      db: B2bDatabase;
      entityEventPublisher: EntityEventPublisher;
      entityService: EntityService;
  }
Returns ExternalUsAchPaymentInstrumentService
- Defined in packages/payment-instrument-services/src/instruments/ExternalUsAchPaymentInstrumentService.ts:42

Methods

create

create(
    __namedParameters: {
        customerId: string;
        entityId: string;
        originatorName: string;
        referenceId?: string;
    },
): Promise<
    | {
        ok: true;
        value: {
            createdAt: Date;
            deletedAt: Date
            | null;
            id: string;
            originatorName: string;
            provider: "CFX";
            providerId: string;
            referenceId?: string;
            status: "ACTIVE" | "DELETED" | "PENDING_VERIFICATION" | "BLOCKED";
            type: "EXTERNAL_US_ACH";
            updatedAt: Date;
        };
    }
    | { error: ServiceError; ok: false },
>
Parameters
- __namedParameters: {
      customerId: string;
      entityId: string;
      originatorName: string;
      referenceId?: string;
  }
Returns Promise<
    | {
        ok: true;
        value: {
            createdAt: Date;
            deletedAt: Date
            | null;
            id: string;
            originatorName: string;
            provider: "CFX";
            providerId: string;
            referenceId?: string;
            status: "ACTIVE" | "DELETED" | "PENDING_VERIFICATION" | "BLOCKED";
            type: "EXTERNAL_US_ACH";
            updatedAt: Date;
        };
    }
    | { error: ServiceError; ok: false },
>
- Defined in packages/payment-instrument-services/src/instruments/ExternalUsAchPaymentInstrumentService.ts:52

delete

delete(
    __namedParameters: { customerId: string; entityId: string; id: string },
): Promise<
    { ok: true; value: undefined }
    | { error: ServiceError; ok: false },
>
Parameters
- __namedParameters: { customerId: string; entityId: string; id: string }
Returns Promise<{ ok: true; value: undefined } | { error: ServiceError; ok: false }>
- Defined in packages/payment-instrument-services/src/instruments/ExternalUsAchPaymentInstrumentService.ts:171

upsert

upsert(
    args: {
        customerId: string;
        entityId: string;
        originatorName: string;
        referenceId?: string;
    },
): Promise<
    | {
        ok: true;
        value: {
            createdAt: Date;
            deletedAt: Date
            | null;
            id: string;
            originatorName: string;
            provider: "CFX";
            providerId: string;
            referenceId?: string;
            status: "ACTIVE" | "DELETED" | "PENDING_VERIFICATION" | "BLOCKED";
            type: "EXTERNAL_US_ACH";
            updatedAt: Date;
        };
    }
    | { error: ServiceError; ok: false },
>
Create the instrument if it doesn't exist, otherwise return the existing one.
Parameters
- args: {
      customerId: string;
      entityId: string;
      originatorName: string;
      referenceId?: string;
  }
Returns Promise<
    | {
        ok: true;
        value: {
            createdAt: Date;
            deletedAt: Date
            | null;
            id: string;
            originatorName: string;
            provider: "CFX";
            providerId: string;
            referenceId?: string;
            status: "ACTIVE" | "DELETED" | "PENDING_VERIFICATION" | "BLOCKED";
            type: "EXTERNAL_US_ACH";
            updatedAt: Date;
        };
    }
    | { error: ServiceError; ok: false },
>
- Defined in packages/payment-instrument-services/src/instruments/ExternalUsAchPaymentInstrumentService.ts:129