Class AchDebitWithdrawalQuoteService

constructor

• new AchDebitWithdrawalQuoteService(
      args: {
          db: B2bDatabase;
          ledgerAccountQueryService: LedgerAccountQueryService;
          paymentInstrumentQueryService: PaymentInstrumentQueryService;
          productQuoteService: ProductQuoteService;
          temporalClient: TemporalWorkflowClient<Workflows>;
          withdrawalAdminService: WithdrawalAdminService;
          withdrawalQuoteService: WithdrawalQuoteService;
      },
  ): AchDebitWithdrawalQuoteService

  Parameters

  • args: {
        db: B2bDatabase;
        ledgerAccountQueryService: LedgerAccountQueryService;
        paymentInstrumentQueryService: PaymentInstrumentQueryService;
        productQuoteService: ProductQuoteService;
        temporalClient: TemporalWorkflowClient<Workflows>;
        withdrawalAdminService: WithdrawalAdminService;
        withdrawalQuoteService: WithdrawalQuoteService;
    }

  Returns AchDebitWithdrawalQuoteService

Staticinstance

accept

• accept(
      args: { customerId: string; quoteId: string; settled?: true },
  ): Promise<
      | { error: ServiceError; ok: false }
      | { ok: true; value: { withdrawalId: string } },
  >

  Parameters

  • args: { customerId: string; quoteId: string; settled?: true }

    • customerId: string

    • quoteId: string

    • Optionalsettled?: true

      A debit that has already posted, quoted with settled: its limits are not re-checked. Never set on a customer path.

  Returns Promise<
      | { error: ServiceError; ok: false }
      | { ok: true; value: { withdrawalId: string } },
  >

create

• create(
      args: Pick<
          AchDebitWithdrawalQuote,
          "deviceIpAddress"
          | "deviceLocation"
          | "entityId"
          | "achId",
      > & (
          { customerId: string; targetAchPaymentInstrument: string; sourceAccountId: string; idempotencyKey?: string | undefined; settled?: true | undefined; } & ({ sourceAmount: BigNumber; } | { targetAmount: BigNumber; })
      ),
  ): Promise<
      | { ok: true; value: AchDebitWithdrawalQuote }
      | {
          error:
              | ServiceError<"ENTITY_NOT_FOUND" | "ENTITY_CANNOT_TRANSACT">
              | ServiceError<"LIMIT_EXCEEDED", ProductLimitViolation>
              | ServiceError<QuoteInvariantViolation>
              | ServiceError<
                  | "INSUFFICIENT_FUNDS"
                  | "PRODUCT_INACTIVE"
                  | "NO_ELIGIBLE_ROUTE"
                  | "CUSTOMER_NOT_ACTIVE"
                  | "PAYMENT_INSTRUMENT_BLOCKED"
                  | "PAYMENT_INSTRUMENT_ACTION_REQUIRED"
                  | "DUPLICATE_ACH_ID",
              >;
          ok: false;
      },
  >

  Parameters

  • args: Pick<
        AchDebitWithdrawalQuote,
        "deviceIpAddress"
        | "deviceLocation"
        | "entityId"
        | "achId",
    > & (
        { customerId: string; targetAchPaymentInstrument: string; sourceAccountId: string; idempotencyKey?: string | undefined; settled?: true | undefined; } & ({ sourceAmount: BigNumber; } | { targetAmount: BigNumber; })
    )

  Returns Promise<
      | { ok: true; value: AchDebitWithdrawalQuote }
      | {
          error:
              | ServiceError<"ENTITY_NOT_FOUND" | "ENTITY_CANNOT_TRANSACT">
              | ServiceError<"LIMIT_EXCEEDED", ProductLimitViolation>
              | ServiceError<QuoteInvariantViolation>
              | ServiceError<
                  | "INSUFFICIENT_FUNDS"
                  | "PRODUCT_INACTIVE"
                  | "NO_ELIGIBLE_ROUTE"
                  | "CUSTOMER_NOT_ACTIVE"
                  | "PAYMENT_INSTRUMENT_BLOCKED"
                  | "PAYMENT_INSTRUMENT_ACTION_REQUIRED"
                  | "DUPLICATE_ACH_ID",
              >;
          ok: false;
      },
  >