Class CashDepositQuoteService

constructor

• new CashDepositQuoteService(
      args: {
          cashDepositRetailerService: CashDepositRetailerService;
          db: B2bDatabase;
          depositQuoteService: DepositQuoteService;
          eventPublisher: CustomerEventPublisher;
          greendotBarcodeClient: GreendotBarcodeClient;
          identityQueryService: IdentityQueryService;
          productQuoteService: ProductQuoteService;
          temporalClient: TemporalWorkflowClient<Workflows>;
      },
  ): CashDepositQuoteService

  Parameters

  • args: {
        cashDepositRetailerService: CashDepositRetailerService;
        db: B2bDatabase;
        depositQuoteService: DepositQuoteService;
        eventPublisher: CustomerEventPublisher;
        greendotBarcodeClient: GreendotBarcodeClient;
        identityQueryService: IdentityQueryService;
        productQuoteService: ProductQuoteService;
        temporalClient: TemporalWorkflowClient<Workflows>;
    }

  Returns CashDepositQuoteService

Staticinstance

create

• create(
      args: {
          amount?:
              | { source: { amount: BigNumber } }
              | { target: { amount: BigNumber } };
          customerId: string;
          deviceIpAddress?: string;
          deviceLocation?: { lat: number; long: number; source: "ip" };
          entityId: string;
          idempotencyKey?: string;
          metadata?: Record<string, any>;
          reference: string;
          regionCode?: string;
          retailerId: string;
          targetCurrency?: "MOVEUSD";
          user: {
              address?: string;
              firstName: string;
              lastName: string;
              zipcode: string;
          };
          wallet: { address: string; blockchain: string };
      },
  ): Promise<
      | {
          ok: true;
          value: {
              aggregateQuote?: {
                  fees: (
                      {
                          amount: BigNumber;
                          receiver: (...)
                          | (...)
                          | (...);
                          type: (...) | (...);
                      } & { currency: string }
                  )[];
                  sourceAmount: BigNumber;
                  sourceAmountAfterFees: BigNumber;
                  sourceCurrency: string;
                  targetAmount: BigNumber;
                  targetAmountAfterFees: BigNumber;
                  targetCurrency: string;
              };
              createdAt: Date;
              customerId: string;
              data?: | {
                  address?: string;
                  barcodeNumber: string;
                  barcodeStatus: | "EXPIRED"
                  | "PENDING"
                  | "DECLINED"
                  | "CANCELLED"
                  | "CONSUMED"
                  | "CREATED"
                  | "VOIDED";
                  expiresAt: string;
                  firstName: string;
                  greendotId: string
                  | null;
                  lastName: string;
                  phone?: string;
                  retailerId: string;
                  retailerName: string;
                  targetCurrency?: "MOVEUSD" | "USDC";
                  zipcode: string;
              }
              | {
                  ffc_memo?: string;
                  imad?: string;
                  omad?: string;
                  originating_fi?: string;
                  originator_address_line1?: string;
                  originator_address_line2?: string;
                  originator_address_line3?: string;
                  originator_info?: string;
                  sender_name?: string;
                  sending_fi?: { code: string; name: string };
              }
              | {
                  achBatchId?: string;
                  achId: string;
                  bankId?: string;
                  routeFusionIncomingTransferId?: string;
                  sourcePaymentInstrumentId: string;
                  speed?: string;
                  vendorId?: string;
                  victorTransactionId?: string;
              }
              | { providerId?: string; providerTransactionId?: string }
              | { ffcMemo?: string }
              | {
                  achId?: string;
                  achTraceId?: string;
                  addenda?: string;
                  companyDiscretionaryData?: string;
                  companyEntryDescription?: string;
                  companyId?: string;
                  companyName?: string;
                  effectiveEntryDate?: string;
                  ffcMemo?: string;
                  secCode?: string;
                  senderName?: string;
                  settlementDate?: string;
                  vendorId?: string;
              }
              | { ffcMemo?: string; senderName?: string; tchInstitutionId?: string }
              | { ffcMemo?: string; institutionId?: string; senderName?: string }
              | null;
              depositId?: string;
              deviceIpAddress: string | null;
              deviceLocation?: { lat: number; long: number; source: "ip" };
              entityId: string;
              id: string;
              metadata: {
                  brand?: string;
                  marketing?:
                      | EmptyObject
                      | {
                          fbp?: string;
                          gclid?: string;
                          sub1?: string;
                          sub2?: string;
                          sub3?: string;
                          userAgent?: string;
                          utmCampaign?: string;
                          utmContent?: string;
                          utmMedium?: string;
                          utmSource?: string;
                      };
              };
              productQuoteId: string;
              quote?: {
                  fees: (
                      {
                          amount: BigNumber;
                          receiver: (...)
                          | (...)
                          | (...);
                          type: (...) | (...);
                      } & { currency: string }
                  )[];
                  sourceAmount: BigNumber;
                  sourceAmountAfterFees: BigNumber;
                  sourceCurrency: string;
                  targetAmount: BigNumber;
                  targetAmountAfterFees: BigNumber;
                  targetCurrency: string;
              };
              reference: string;
              status: "ACTIVE"
              | "EXPIRED"
              | "ACCEPTED"
              | "REJECTED";
              updatedAt: Date;
              walletAddress: Address;
              walletBlockchain: string;
          } & { type: "CASH" } & {
              address?: string;
              barcodeNumber: string;
              barcodeStatus:
                  | "EXPIRED"
                  | "PENDING"
                  | "DECLINED"
                  | "CANCELLED"
                  | "CONSUMED"
                  | "CREATED"
                  | "VOIDED";
              expiresAt: Date;
              firstName: string;
              greendotId?: string
              | null;
              lastName: string;
              phone?: string;
              retailerId: string;
              retailerName: string;
              zipcode: string;
          } & { cancelOldest: boolean };
      }
      | { error: CashDepositQuoteCreateError; ok: false },
  >

  Parameters

  • args: {
        amount?:
            | { source: { amount: BigNumber } }
            | { target: { amount: BigNumber } };
        customerId: string;
        deviceIpAddress?: string;
        deviceLocation?: { lat: number; long: number; source: "ip" };
        entityId: string;
        idempotencyKey?: string;
        metadata?: Record<string, any>;
        reference: string;
        regionCode?: string;
        retailerId: string;
        targetCurrency?: "MOVEUSD";
        user: {
            address?: string;
            firstName: string;
            lastName: string;
            zipcode: string;
        };
        wallet: { address: string; blockchain: string };
    }

    • Optionalamount?: { source: { amount: BigNumber } } | { target: { amount: BigNumber } }

    • customerId: string

    • OptionaldeviceIpAddress?: string

    • OptionaldeviceLocation?: { lat: number; long: number; source: "ip" }

    • entityId: string

    • OptionalidempotencyKey?: string

      Caller-supplied idempotency key (from the API Idempotency-Key header). Threaded into productQuoteService.quote() (dedupes the pinned engine quote) and depositQuoteService.create() (dedupes the deposit quote). Optional — internal callers don't supply one.

    • Optionalmetadata?: Record<string, any>

    • reference: string

    • OptionalregionCode?: string

    • retailerId: string

    • OptionaltargetCurrency?: "MOVEUSD"

    • user: { address?: string; firstName: string; lastName: string; zipcode: string }

    • wallet: { address: string; blockchain: string }

  Returns Promise<
      | {
          ok: true;
          value: {
              aggregateQuote?: {
                  fees: (
                      {
                          amount: BigNumber;
                          receiver: (...)
                          | (...)
                          | (...);
                          type: (...) | (...);
                      } & { currency: string }
                  )[];
                  sourceAmount: BigNumber;
                  sourceAmountAfterFees: BigNumber;
                  sourceCurrency: string;
                  targetAmount: BigNumber;
                  targetAmountAfterFees: BigNumber;
                  targetCurrency: string;
              };
              createdAt: Date;
              customerId: string;
              data?: | {
                  address?: string;
                  barcodeNumber: string;
                  barcodeStatus: | "EXPIRED"
                  | "PENDING"
                  | "DECLINED"
                  | "CANCELLED"
                  | "CONSUMED"
                  | "CREATED"
                  | "VOIDED";
                  expiresAt: string;
                  firstName: string;
                  greendotId: string
                  | null;
                  lastName: string;
                  phone?: string;
                  retailerId: string;
                  retailerName: string;
                  targetCurrency?: "MOVEUSD" | "USDC";
                  zipcode: string;
              }
              | {
                  ffc_memo?: string;
                  imad?: string;
                  omad?: string;
                  originating_fi?: string;
                  originator_address_line1?: string;
                  originator_address_line2?: string;
                  originator_address_line3?: string;
                  originator_info?: string;
                  sender_name?: string;
                  sending_fi?: { code: string; name: string };
              }
              | {
                  achBatchId?: string;
                  achId: string;
                  bankId?: string;
                  routeFusionIncomingTransferId?: string;
                  sourcePaymentInstrumentId: string;
                  speed?: string;
                  vendorId?: string;
                  victorTransactionId?: string;
              }
              | { providerId?: string; providerTransactionId?: string }
              | { ffcMemo?: string }
              | {
                  achId?: string;
                  achTraceId?: string;
                  addenda?: string;
                  companyDiscretionaryData?: string;
                  companyEntryDescription?: string;
                  companyId?: string;
                  companyName?: string;
                  effectiveEntryDate?: string;
                  ffcMemo?: string;
                  secCode?: string;
                  senderName?: string;
                  settlementDate?: string;
                  vendorId?: string;
              }
              | { ffcMemo?: string; senderName?: string; tchInstitutionId?: string }
              | { ffcMemo?: string; institutionId?: string; senderName?: string }
              | null;
              depositId?: string;
              deviceIpAddress: string | null;
              deviceLocation?: { lat: number; long: number; source: "ip" };
              entityId: string;
              id: string;
              metadata: {
                  brand?: string;
                  marketing?:
                      | EmptyObject
                      | {
                          fbp?: string;
                          gclid?: string;
                          sub1?: string;
                          sub2?: string;
                          sub3?: string;
                          userAgent?: string;
                          utmCampaign?: string;
                          utmContent?: string;
                          utmMedium?: string;
                          utmSource?: string;
                      };
              };
              productQuoteId: string;
              quote?: {
                  fees: (
                      {
                          amount: BigNumber;
                          receiver: (...)
                          | (...)
                          | (...);
                          type: (...) | (...);
                      } & { currency: string }
                  )[];
                  sourceAmount: BigNumber;
                  sourceAmountAfterFees: BigNumber;
                  sourceCurrency: string;
                  targetAmount: BigNumber;
                  targetAmountAfterFees: BigNumber;
                  targetCurrency: string;
              };
              reference: string;
              status: "ACTIVE"
              | "EXPIRED"
              | "ACCEPTED"
              | "REJECTED";
              updatedAt: Date;
              walletAddress: Address;
              walletBlockchain: string;
          } & { type: "CASH" } & {
              address?: string;
              barcodeNumber: string;
              barcodeStatus:
                  | "EXPIRED"
                  | "PENDING"
                  | "DECLINED"
                  | "CANCELLED"
                  | "CONSUMED"
                  | "CREATED"
                  | "VOIDED";
              expiresAt: Date;
              firstName: string;
              greendotId?: string
              | null;
              lastName: string;
              phone?: string;
              retailerId: string;
              retailerName: string;
              zipcode: string;
          } & { cancelOldest: boolean };
      }
      | { error: CashDepositQuoteCreateError; ok: false },
  >

reconcileCancelledBarcode

• reconcileCancelledBarcode(
      __namedParameters: { customerId: string; entityId: string },
  ): Promise<{ ok: true; value: boolean }>

  Syncs our state after Green Dot returns response code 111111111 (OldestBarcodeCancelled), which guarantees they already cancelled exactly one barcode on our behalf, but never says which. Rather than guess (the old logic assumed "oldest CREATED" and never checked), this asks Green Dot for every barcode it has touched for the entity and matches by barcode number against whichever of our own still-open barcodes reads back CANCELLED.

  If a concurrent caller already handled the same cancellation (the quote is no longer CREATED), it drops out of openByBarcodeNumber and this is a no-op.

  Parameters

  • __namedParameters: { customerId: string; entityId: string }

  Returns Promise<{ ok: true; value: boolean }>

update

• update(
      args: {
          customerId: string;
          data: {
              barcodeStatus:
                  | "EXPIRED"
                  | "PENDING"
                  | "DECLINED"
                  | "CANCELLED"
                  | "CONSUMED"
                  | "CREATED"
                  | "VOIDED";
          };
          id: string;
      },
  ): Promise<void>

  Parameters

  • args: {
        customerId: string;
        data: {
            barcodeStatus:
                | "EXPIRED"
                | "PENDING"
                | "DECLINED"
                | "CANCELLED"
                | "CONSUMED"
                | "CREATED"
                | "VOIDED";
        };
        id: string;
    }

  Returns Promise<void>