@cfxlabsinc/b2b-services
    Preparing search index...

    Class DepositQuoteService

    Index

    Constructors

    constructor

    Methods

    create get search update

    Constructors

    Methods

    • Parameters

      • __namedParameters: {
            aggregateQuote?: {
                fees: (
                    {
                        amount: BigNumber;
                        receiver: "CUSTOMER"
                        | "CFX"
                        | "PROVIDER";
                        type: "FIXED" | "VARIABLE";
                    } & { currency: string }
                )[];
                sourceAmount: BigNumber;
                sourceAmountAfterFees: BigNumber;
                sourceCurrency: string;
                targetAmount: BigNumber;
                targetAmountAfterFees: BigNumber;
                targetCurrency: string;
            };
            customerId: string;
            data?: | {
                address?: string;
                barcodeNumber: string;
                barcodeStatus: | "CREATED"
                | "PENDING"
                | "DECLINED"
                | "EXPIRED"
                | "CANCELLED"
                | "CONSUMED"
                | "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; sender_name?: string }
            | {
                achBatchId?: string;
                achId: string;
                bankId?: string;
                sourcePaymentInstrumentId: string;
                speed?: string;
                victorTransactionId?: string;
            }
            | { providerId?: string; providerTransactionId?: string }
            | { ffcMemo?: string }
            | {
                achId?: string;
                achTraceId?: string;
                ffcMemo?: string;
                senderName?: string;
            }
            | { ffcMemo?: string; senderName?: string; tchInstitutionId?: string }
            | null;
            deviceIpAddress: string | null;
            deviceLocation?: { lat: number; long: number; source: "ip" };
            entityId: 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: "CUSTOMER"
                        | "CFX"
                        | "PROVIDER";
                        type: "FIXED" | "VARIABLE";
                    } & { currency: string }
                )[];
                sourceAmount: BigNumber;
                sourceAmountAfterFees: BigNumber;
                sourceCurrency: string;
                targetAmount: BigNumber;
                targetAmountAfterFees: BigNumber;
                targetCurrency: string;
            };
            reference: string;
            type: | "RTP"
            | "US_WIRE"
            | "US_BANK_ACH"
            | "CASH"
            | "SWIFT_WIRE"
            | "ACH_CREDIT";
            walletAddress: Address;
            walletBlockchain: "SOLANA";
        } & { productQuoteId: string; tx?: B2bPgTransaction }
        • OptionalaggregateQuote?: {
              fees: (
                  {
                      amount: BigNumber;
                      receiver: "CUSTOMER"
                      | "CFX"
                      | "PROVIDER";
                      type: "FIXED" | "VARIABLE";
                  } & { currency: string }
              )[];
              sourceAmount: BigNumber;
              sourceAmountAfterFees: BigNumber;
              sourceCurrency: string;
              targetAmount: BigNumber;
              targetAmountAfterFees: BigNumber;
              targetCurrency: string;
          }
        • customerId: string
        • Optionaldata?:
              | {
                  address?: string;
                  barcodeNumber: string;
                  barcodeStatus: | "CREATED"
                  | "PENDING"
                  | "DECLINED"
                  | "EXPIRED"
                  | "CANCELLED"
                  | "CONSUMED"
                  | "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; sender_name?: string }
              | {
                  achBatchId?: string;
                  achId: string;
                  bankId?: string;
                  sourcePaymentInstrumentId: string;
                  speed?: string;
                  victorTransactionId?: string;
              }
              | { providerId?: string; providerTransactionId?: string }
              | { ffcMemo?: string }
              | {
                  achId?: string;
                  achTraceId?: string;
                  ffcMemo?: string;
                  senderName?: string;
              }
              | { ffcMemo?: string; senderName?: string; tchInstitutionId?: string }
              | null

          this is the underlying db representation, don't use this by default

        • deviceIpAddress: string | null
        • OptionaldeviceLocation?: { lat: number; long: number; source: "ip" }
        • entityId: 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

          External id (pq_...) of the engine-quote audit row that produced this deposit quote. Always populated — every deposit quote is now created via productQuoteService.quote(). Used by per-rail accept() methods to stamp accepted_at on the engine-quote row.

        • Optionalquote?: {
              fees: (
                  {
                      amount: BigNumber;
                      receiver: "CUSTOMER"
                      | "CFX"
                      | "PROVIDER";
                      type: "FIXED" | "VARIABLE";
                  } & { currency: string }
              )[];
              sourceAmount: BigNumber;
              sourceAmountAfterFees: BigNumber;
              sourceCurrency: string;
              targetAmount: BigNumber;
              targetAmountAfterFees: BigNumber;
              targetCurrency: string;
          }
        • reference: string
        • type: "RTP" | "US_WIRE" | "US_BANK_ACH" | "CASH" | "SWIFT_WIRE" | "ACH_CREDIT"
        • walletAddress: Address
        • walletBlockchain: "SOLANA"

      Returns Promise<{ ok: true; value: DepositQuote | null }>

    • Parameters

      • __namedParameters: {
            cashDepositBarcodeStatuses?: (
                | "CREATED"
                | "PENDING"
                | "DECLINED"
                | "EXPIRED"
                | "CANCELLED"
                | "CONSUMED"
                | "VOIDED"
            )[];
            createdAt?: DbTimestampCriteria;
            customerId: string;
            entityIds?: string[];
            ids?: string[];
            orderBy?: DbOrderByCriterion<
                Omit<
                    PgTableWithColumns<
                        {
                            columns: {
                                createdAt: PgColumn<
                                    {
                                        baseColumn: never;
                                        columnType: "PgTimestamp";
                                        data: Date;
                                        dataType: "date";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: true;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: "createdAt";
                                        notNull: true;
                                        tableName: "deposit_quote";
                                    },
                                    {},
                                    {},
                                >;
                                customerId: PgColumn<
                                    {
                                        baseColumn: never;
                                        columnType: "PgInteger";
                                        data: number;
                                        dataType: "number";
                                        driverParam: (...)
                                        | (...);
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: "customerId";
                                        notNull: true;
                                        tableName: "deposit_quote";
                                    },
                                    {},
                                    {},
                                >;
                                data: PgColumn<
                                    {
                                        baseColumn: never;
                                        columnType: "PgJsonb";
                                        data: (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...);
                                        dataType: "json";
                                        driverParam: unknown;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: "data";
                                        notNull: false;
                                        tableName: "deposit_quote";
                                    },
                                    {},
                                    { $type: (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...) },
                                >;
                                deviceIpAddress: PgColumn<
                                    {
                                        baseColumn: never;
                                        columnType: "PgText";
                                        data: string;
                                        dataType: "string";
                                        driverParam: string;
                                        enumValues: [(...), ...(...)[]];
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: "deviceIpAddress";
                                        notNull: false;
                                        tableName: "deposit_quote";
                                    },
                                    {},
                                    {},
                                >;
                                deviceLocation: PgColumn<
                                    {
                                        baseColumn: never;
                                        columnType: "PgJsonb";
                                        data: (...)
                                        | (...);
                                        dataType: "json";
                                        driverParam: unknown;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: "deviceLocation";
                                        notNull: false;
                                        tableName: "deposit_quote";
                                    },
                                    {},
                                    { $type: (...)
                                    | (...) },
                                >;
                                externalId: PgColumn<
                                    {
                                        baseColumn: never;
                                        columnType: "PgText";
                                        data: string;
                                        dataType: "string";
                                        driverParam: string;
                                        enumValues: [(...), ...(...)[]];
                                        generated: undefined;
                                        hasDefault: true;
                                        hasRuntimeDefault: true;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: "externalId";
                                        notNull: true;
                                        tableName: "deposit_quote";
                                    },
                                    {},
                                    {},
                                >;
                                id: PgColumn<
                                    {
                                        baseColumn: never;
                                        columnType: "PgInteger";
                                        data: number;
                                        dataType: "number";
                                        driverParam: (...)
                                        | (...);
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: true;
                                        hasRuntimeDefault: false;
                                        identity: "byDefault";
                                        isAutoincrement: false;
                                        isPrimaryKey: true;
                                        name: "id";
                                        notNull: true;
                                        tableName: "deposit_quote";
                                    },
                                    {},
                                    {},
                                >;
                                identityId: PgColumn<
                                    {
                                        baseColumn: never;
                                        columnType: "PgInteger";
                                        data: number;
                                        dataType: "number";
                                        driverParam: (...)
                                        | (...);
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: "identityId";
                                        notNull: false;
                                        tableName: "deposit_quote";
                                    },
                                    {},
                                    {},
                                >;
                                metadata: PgColumn<
                                    {
                                        baseColumn: never;
                                        columnType: "PgJsonb";
                                        data: { brand?: ...; marketing?: ... };
                                        dataType: "json";
                                        driverParam: unknown;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: true;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: "metadata";
                                        notNull: true;
                                        tableName: "deposit_quote";
                                    },
                                    {},
                                    { $type: { brand?: ...; marketing?: ... } },
                                >;
                                organizationId: PgColumn<
                                    {
                                        baseColumn: never;
                                        columnType: "PgInteger";
                                        data: number;
                                        dataType: "number";
                                        driverParam: (...)
                                        | (...);
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: "organizationId";
                                        notNull: false;
                                        tableName: "deposit_quote";
                                    },
                                    {},
                                    {},
                                >;
                                productQuoteId: PgColumn<
                                    {
                                        baseColumn: never;
                                        columnType: "PgInteger";
                                        data: number;
                                        dataType: "number";
                                        driverParam: (...)
                                        | (...);
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: "productQuoteId";
                                        notNull: true;
                                        tableName: "deposit_quote";
                                    },
                                    {},
                                    {},
                                >;
                                quote: PgColumn<
                                    {
                                        baseColumn: never;
                                        columnType: "PgJsonb";
                                        data: (...)
                                        | (...);
                                        dataType: "json";
                                        driverParam: unknown;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: "quote";
                                        notNull: false;
                                        tableName: "deposit_quote";
                                    },
                                    {},
                                    { $type: (...)
                                    | (...) },
                                >;
                                reference: PgColumn<
                                    {
                                        baseColumn: never;
                                        columnType: "PgText";
                                        data: string;
                                        dataType: "string";
                                        driverParam: string;
                                        enumValues: [(...), ...(...)[]];
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: "reference";
                                        notNull: true;
                                        tableName: "deposit_quote";
                                    },
                                    {},
                                    {},
                                >;
                                status: PgColumn<
                                    {
                                        baseColumn: never;
                                        columnType: "PgText";
                                        data: (...)
                                        | (...)
                                        | (...)
                                        | (...);
                                        dataType: "string";
                                        driverParam: string;
                                        enumValues: [(...), ...(...)[]];
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: "status";
                                        notNull: true;
                                        tableName: "deposit_quote";
                                    },
                                    {},
                                    { $type: (...)
                                    | (...)
                                    | (...)
                                    | (...) },
                                >;
                                type: PgColumn<
                                    {
                                        baseColumn: never;
                                        columnType: "PgText";
                                        data: (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...);
                                        dataType: "string";
                                        driverParam: string;
                                        enumValues: [(...), ...(...)[]];
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: "type";
                                        notNull: true;
                                        tableName: "deposit_quote";
                                    },
                                    {},
                                    { $type: (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...) },
                                >;
                                updatedAt: PgColumn<
                                    {
                                        baseColumn: never;
                                        columnType: "PgTimestamp";
                                        data: Date;
                                        dataType: "date";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: true;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: "updatedAt";
                                        notNull: true;
                                        tableName: "deposit_quote";
                                    },
                                    {},
                                    {},
                                >;
                                walletAddress: PgColumn<
                                    {
                                        baseColumn: never;
                                        columnType: "PgText";
                                        data: string;
                                        dataType: "string";
                                        driverParam: string;
                                        enumValues: [(...), ...(...)[]];
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: "walletAddress";
                                        notNull: true;
                                        tableName: "deposit_quote";
                                    },
                                    {},
                                    {},
                                >;
                                walletBlockchain: PgColumn<
                                    {
                                        baseColumn: never;
                                        columnType: "PgText";
                                        data: "SOLANA";
                                        dataType: "string";
                                        driverParam: string;
                                        enumValues: [(...), ...(...)[]];
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: "walletBlockchain";
                                        notNull: true;
                                        tableName: "deposit_quote";
                                    },
                                    {},
                                    { $type: "SOLANA" },
                                >;
                            };
                            dialect: "pg";
                            name: "deposit_quote";
                            schema: "b2b";
                        },
                    >,
                    "enableRLS",
                >,
                "createdAt"
                | "updatedAt",
            >[];
            page?: number;
            pageSize?: number;
            references?: string[];
            tx?: B2bPgTransaction;
            types?: (
                | "RTP"
                | "US_WIRE"
                | "US_BANK_ACH"
                | "CASH"
                | "SWIFT_WIRE"
                | "ACH_CREDIT"
            )[];
            updatedAt?: DbTimestampCriteria;
        }

      Returns Promise<{ ok: true; value: { hasNext: boolean; items: DepositQuote[] } }>

    • Parameters

      • args: {
            customerId: string;
            data: Partial<
                (
                    | {
                        address?: string;
                        barcodeNumber: string;
                        barcodeStatus: | "CREATED"
                        | "PENDING"
                        | "DECLINED"
                        | "EXPIRED"
                        | "CANCELLED"
                        | "CONSUMED"
                        | "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;
                        sender_name?: string;
                    }
                    | {
                        achBatchId?: string;
                        achId: string;
                        bankId?: string;
                        sourcePaymentInstrumentId: string;
                        speed?: string;
                        victorTransactionId?: string;
                    }
                    | { providerId?: string; providerTransactionId?: string }
                    | { ffcMemo?: string }
                    | {
                        achId?: string;
                        achTraceId?: string;
                        ffcMemo?: string;
                        senderName?: string;
                    }
                    | { ffcMemo?: string; senderName?: string; tchInstitutionId?: string }
                    | null
                    | undefined
                ) & { status?: "ACCEPTED" | "ACTIVE" | "EXPIRED" | "REJECTED" },
            >;
            id: string;
            tx?: B2bPgTransaction;
        }

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods