Class AchDebitWithdrawalReconciliationService

Service responsible for handling withdrawal reconciliation operations.

Only use this if the withdrawal method maps 1:1 with a bank transaction.

Index

Constructors

constructor

Methods

maybeCreatePendingVirtualAccountAuthorization processAchDebitWithdrawal processInboundAchDebit returnAchDebitWithdrawal

Constructors

constructor

new AchDebitWithdrawalReconciliationService(
    args: {
        achDebitWithdrawalQuoteService: AchDebitWithdrawalQuoteService;
        bankTransactionService: BankTransactionService;
        db: B2bDatabase;
        externalUsAchPaymentInstrumentService: ExternalUsAchPaymentInstrumentService;
        redemptionAdminQueryService: RedemptionAdminQueryService;
        temporalClient: Client;
        temporalQueue: string;
        virtualAccountAdminQueryService: VirtualAccountAdminQueryService;
        withdrawalAdminService: WithdrawalAdminService;
        withdrawalRedemptionReconciliationService: WithdrawalRedemptionReconciliationService;
    },
): AchDebitWithdrawalReconciliationService
Parameters
- args: {
      achDebitWithdrawalQuoteService: AchDebitWithdrawalQuoteService;
      bankTransactionService: BankTransactionService;
      db: B2bDatabase;
      externalUsAchPaymentInstrumentService: ExternalUsAchPaymentInstrumentService;
      redemptionAdminQueryService: RedemptionAdminQueryService;
      temporalClient: Client;
      temporalQueue: string;
      virtualAccountAdminQueryService: VirtualAccountAdminQueryService;
      withdrawalAdminService: WithdrawalAdminService;
      withdrawalRedemptionReconciliationService: WithdrawalRedemptionReconciliationService;
  }
Returns AchDebitWithdrawalReconciliationService
- Defined in packages/withdrawal-services/src/ach-debit/AchDebitWithdrawalReconciliationService.ts:42

Methods

maybeCreatePendingVirtualAccountAuthorization

maybeCreatePendingVirtualAccountAuthorization(
    args: {
        accountNumber: string;
        achId: string;
        amount: string;
        originatorName: string | null;
    },
): Promise<{ withdrawalId: string } | null>
Create a pending ACH debit authorization for an inbound debit against a virtual account.
Parameters
- args: {
      accountNumber: string;
      achId: string;
      amount: string;
      originatorName: string | null;
  }
Returns Promise<{ withdrawalId: string } | null>
- Defined in packages/withdrawal-services/src/ach-debit/AchDebitWithdrawalReconciliationService.ts:339

processAchDebitWithdrawal

processAchDebitWithdrawal(
    args: { bankTransactionId: string; withdrawalId: string },
): Promise<
    | { ok: true; value: void }
    | {
        error:
            | ServiceError<"REDEMPTION_NOT_FOUND", { redemptionId: string }>
            | ServiceError<"REDEMPTION_NOT_PENDING", { redemptionId: string }>
            | ServiceError<"INVALID_BANK_TX", { bankTransactionId: string }>
            | ServiceError<
                "AMOUNT_MISMATCH",
                { bankTransactionAmount: string; redemptionAmount: string },
            >
            | ServiceError<"WITHDRAWAL_NOT_FOUND", { withdrawalId: string }>
            | ServiceError<"INVALID_BANK_TX", { bankTransactionId: string }>
            | ServiceError<
                "WITHDRAWAL_ALREADY_RECONCILED",
                { existingWithdrawalId: string; withdrawalId: string },
            >
            | ServiceError<
                "AMOUNT_MISMATCH",
                { bankTransactionAmount: string; withdrawalAmount: string },
            >
            | ServiceError<"REDEMPTION_NOT_FOUND", { withdrawalId: string }>;
        ok: false;
    },
>
Parameters
- args: { bankTransactionId: string; withdrawalId: string }
Returns Promise<
    | { ok: true; value: void }
    | {
        error:
            | ServiceError<"REDEMPTION_NOT_FOUND", { redemptionId: string }>
            | ServiceError<"REDEMPTION_NOT_PENDING", { redemptionId: string }>
            | ServiceError<"INVALID_BANK_TX", { bankTransactionId: string }>
            | ServiceError<
                "AMOUNT_MISMATCH",
                { bankTransactionAmount: string; redemptionAmount: string },
            >
            | ServiceError<"WITHDRAWAL_NOT_FOUND", { withdrawalId: string }>
            | ServiceError<"INVALID_BANK_TX", { bankTransactionId: string }>
            | ServiceError<
                "WITHDRAWAL_ALREADY_RECONCILED",
                { existingWithdrawalId: string; withdrawalId: string },
            >
            | ServiceError<
                "AMOUNT_MISMATCH",
                { bankTransactionAmount: string; withdrawalAmount: string },
            >
            | ServiceError<"REDEMPTION_NOT_FOUND", { withdrawalId: string }>;
        ok: false;
    },
>
- Defined in packages/withdrawal-services/src/ach-debit/AchDebitWithdrawalReconciliationService.ts:68

processInboundAchDebit

processInboundAchDebit(
    args: {
        achId: string;
        bankTransactionId: string;
        originatorName: string | null;
    },
): Promise<
    | { ok: true; value: void }
    | {
        error:
            | ServiceError<"REDEMPTION_NOT_FOUND", { redemptionId: string }>
            | ServiceError<"REDEMPTION_NOT_PENDING", { redemptionId: string }>
            | ServiceError<"INVALID_BANK_TX", { bankTransactionId: string }>
            | ServiceError<
                "AMOUNT_MISMATCH",
                { bankTransactionAmount: string; redemptionAmount: string },
            >
            | ServiceError<"WITHDRAWAL_NOT_FOUND", { withdrawalId: string }>
            | ServiceError<"INVALID_BANK_TX", { bankTransactionId: string }>
            | ServiceError<
                "WITHDRAWAL_ALREADY_RECONCILED",
                { existingWithdrawalId: string; withdrawalId: string },
            >
            | ServiceError<
                "AMOUNT_MISMATCH",
                { bankTransactionAmount: string; withdrawalAmount: string },
            >
            | ServiceError<"REDEMPTION_NOT_FOUND", { withdrawalId: string }>
            | ServiceError<
                "WITHDRAWAL_STILL_CREATED",
                { achId: string; withdrawalId: string },
            >;
        ok: false;
    },
>
Find a pending ACH_PULL withdrawal by achId and reconcile it with the given bank transaction. No-op if no matching pending withdrawal exists.
Parameters
- args: { achId: string; bankTransactionId: string; originatorName: string | null }
Returns Promise<
    | { ok: true; value: void }
    | {
        error:
            | ServiceError<"REDEMPTION_NOT_FOUND", { redemptionId: string }>
            | ServiceError<"REDEMPTION_NOT_PENDING", { redemptionId: string }>
            | ServiceError<"INVALID_BANK_TX", { bankTransactionId: string }>
            | ServiceError<
                "AMOUNT_MISMATCH",
                { bankTransactionAmount: string; redemptionAmount: string },
            >
            | ServiceError<"WITHDRAWAL_NOT_FOUND", { withdrawalId: string }>
            | ServiceError<"INVALID_BANK_TX", { bankTransactionId: string }>
            | ServiceError<
                "WITHDRAWAL_ALREADY_RECONCILED",
                { existingWithdrawalId: string; withdrawalId: string },
            >
            | ServiceError<
                "AMOUNT_MISMATCH",
                { bankTransactionAmount: string; withdrawalAmount: string },
            >
            | ServiceError<"REDEMPTION_NOT_FOUND", { withdrawalId: string }>
            | ServiceError<
                "WITHDRAWAL_STILL_CREATED",
                { achId: string; withdrawalId: string },
            >;
        ok: false;
    },
>
- Defined in packages/withdrawal-services/src/ach-debit/AchDebitWithdrawalReconciliationService.ts:189

returnAchDebitWithdrawal

returnAchDebitWithdrawal(
args: { withdrawalId: string },
): Promise<{ ok: true; value: void } | { error: ServiceError; ok: false }>
Parameters
- args: { withdrawalId: string }
Returns Promise<{ ok: true; value: void } | { error: ServiceError; ok: false }>
- Defined in packages/withdrawal-services/src/ach-debit/AchDebitWithdrawalReconciliationService.ts:264

Class AchDebitWithdrawalReconciliationService

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns AchDebitWithdrawalReconciliationService

Methods

maybeCreatePendingVirtualAccountAuthorization

Parameters

Returns Promise<{ withdrawalId: string } | null>

processAchDebitWithdrawal

Parameters

processInboundAchDebit

Parameters

returnAchDebitWithdrawal

Parameters

Returns Promise<{ ok: true; value: void } | { error: ServiceError; ok: false }>

Settings

On This Page