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

    Constructors

    Methods

    • Parameters

      • body: {
            amount?: { amount: number; currency: "USD" };
            amountOut?: { amount: number; currency: "MOVEUSD" | "USDC" };
            deviceIpAddress?: string;
            deviceLocation: { lat: number; long: number; source: "ip" };
            identityId: string;
            metadata?: StaticRecord<
                [],
                "Encode",
                {},
                {
                    amount: TOptional<
                        TObject<{ amount: TNumber; currency: TLiteral<"USD"> }>,
                    >;
                    amountOut: TOptional<
                        TObject<{ amount: TNumber; currency: TUnsafe<"MOVEUSD" | "USDC"> }>,
                    >;
                    deviceIpAddress: TOptional<TString>;
                    deviceLocation: TObject<
                        { lat: TNumber; long: TNumber; source: TLiteral<"ip"> },
                    >;
                    identityId: TString;
                    metadata: TOptional<TRecord<"^.*$", TAny>>;
                    reference: TString;
                    retailerId: TString;
                    targetCurrency: TOptional<TUnsafe<"MOVEUSD" | "USDC">>;
                    user: TIntersect<
                        [
                            TObject<
                                {
                                    address: TOptional<TString>;
                                    firstName: TString;
                                    lastName: TString;
                                },
                            >,
                            TObject<{ zipcode: TOptional<TString> }>,
                        ],
                    >;
                    wallet: TObject<{ address: TString; blockchain: TLiteral<"SOLANA"> }>;
                },
                "^.*$",
                TAny,
            >;
            reference: string;
            retailerId: string;
            targetCurrency?: "MOVEUSD"
            | "USDC";
            user: { address?: string; firstName: string; lastName: string } & {
                zipcode?: string;
            };
            wallet: { address: string; blockchain: "SOLANA" };
        }
      • customerId: string

      Returns Promise<
          {
              createdAt: string;
              depositId?: string;
              deviceIpAddress?: string;
              deviceLocation?: { lat: number; long: number; source: "ip" };
              id: string;
              legacyId?: string;
              reference: string;
              updatedAt: string;
              wallet: { address: string; blockchain: "SOLANA" };
          } & {
              barcodeNumber: string;
              expiresAt: string;
              id: string;
              identityId: string;
              metadata?: StaticRecord<
                  [],
                  "Encode",
                  {},
                  {
                      barcodeNumber: TString;
                      expiresAt: TString;
                      id: TString;
                      identityId: TString;
                      metadata: TOptional<TRecord<"^.*$", TAny>>;
                      quote: TOptional<
                          TObject<
                              {
                                  amountIn: TObject<{ amount: ...; currency: ... }>;
                                  amountOut: TObject<{ amount: ...; currency: ... }>;
                                  fees: TArray<TObject<(...)>>;
                              },
                          >,
                      >;
                      retailerId: TString;
                      retailerName: TString;
                      status: TUnsafe<
                          | "CREATED"
                          | "PENDING"
                          | "DECLINED"
                          | "VOIDED"
                          | "CANCELLED"
                          | "EXPIRED"
                          | "CONSUMED",
                      >;
                      user: TObject<
                          {
                              address: TOptional<TString>;
                              firstName: TString;
                              lastName: TString;
                              zipcode: TString;
                          },
                      >;
                  },
                  "^.*$",
                  TAny,
              >;
              quote?: {
                  amountIn: {
                      amount: number;
                      currency: | "USD"
                      | "AUD"
                      | "HKD"
                      | "JPY"
                      | "MXN"
                      | "NZD"
                      | "SGD"
                      | "SEK"
                      | "CHF"
                      | "CAD"
                      | "GBP"
                      | "CZK"
                      | "DKK"
                      | "EUR";
                  };
                  amountOut: { amount: number; currency: "MOVEUSD"
                  | "USDC" };
                  fees: {
                      fee: { amount: number; currency: "MOVEUSD" | "USDC" };
                      type:
                          | "CFX_FIXED_FEE"
                          | "CFX_VARIABLE_FEE"
                          | "PROVIDER_FIXED_FEE"
                          | "PROVIDER_VARIABLE_FEE"
                          | "CUSTOMER_FIXED_FEE"
                          | "CUSTOMER_VARIABLE_FEE";
                  }[];
              };
              retailerId: string;
              retailerName: string;
              status: | "CREATED"
              | "PENDING"
              | "DECLINED"
              | "VOIDED"
              | "CANCELLED"
              | "EXPIRED"
              | "CONSUMED";
              user: {
                  address?: string;
                  firstName: string;
                  lastName: string;
                  zipcode: string;
              };
          },
      >

    • Parameters

      • __namedParameters: { depositId?: string; id?: string }
      • customerId: string

      Returns Promise<
          {
              createdAt: string;
              depositId?: string;
              deviceIpAddress?: string;
              deviceLocation?: { lat: number; long: number; source: "ip" };
              id: string;
              legacyId?: string;
              reference: string;
              updatedAt: string;
              wallet: { address: string; blockchain: "SOLANA" };
          } & {
              barcodeNumber: string;
              expiresAt: string;
              id: string;
              identityId: string;
              metadata?: StaticRecord<
                  [],
                  "Encode",
                  {},
                  {
                      barcodeNumber: TString;
                      expiresAt: TString;
                      id: TString;
                      identityId: TString;
                      metadata: TOptional<TRecord<"^.*$", TAny>>;
                      quote: TOptional<
                          TObject<
                              {
                                  amountIn: TObject<{ amount: ...; currency: ... }>;
                                  amountOut: TObject<{ amount: ...; currency: ... }>;
                                  fees: TArray<TObject<(...)>>;
                              },
                          >,
                      >;
                      retailerId: TString;
                      retailerName: TString;
                      status: TUnsafe<
                          | "CREATED"
                          | "PENDING"
                          | "DECLINED"
                          | "VOIDED"
                          | "CANCELLED"
                          | "EXPIRED"
                          | "CONSUMED",
                      >;
                      user: TObject<
                          {
                              address: TOptional<TString>;
                              firstName: TString;
                              lastName: TString;
                              zipcode: TString;
                          },
                      >;
                  },
                  "^.*$",
                  TAny,
              >;
              quote?: {
                  amountIn: {
                      amount: number;
                      currency: | "USD"
                      | "AUD"
                      | "HKD"
                      | "JPY"
                      | "MXN"
                      | "NZD"
                      | "SGD"
                      | "SEK"
                      | "CHF"
                      | "CAD"
                      | "GBP"
                      | "CZK"
                      | "DKK"
                      | "EUR";
                  };
                  amountOut: { amount: number; currency: "MOVEUSD"
                  | "USDC" };
                  fees: {
                      fee: { amount: number; currency: "MOVEUSD" | "USDC" };
                      type:
                          | "CFX_FIXED_FEE"
                          | "CFX_VARIABLE_FEE"
                          | "PROVIDER_FIXED_FEE"
                          | "PROVIDER_VARIABLE_FEE"
                          | "CUSTOMER_FIXED_FEE"
                          | "CUSTOMER_VARIABLE_FEE";
                  }[];
              };
              retailerId: string;
              retailerName: string;
              status: | "CREATED"
              | "PENDING"
              | "DECLINED"
              | "VOIDED"
              | "CANCELLED"
              | "EXPIRED"
              | "CONSUMED";
              user: {
                  address?: string;
                  firstName: string;
                  lastName: string;
                  zipcode: string;
              };
          },
      >

    • Parameters

      • params: {
            entityId?: string;
            reference?: string;
            status?: (
                | "CREATED"
                | "PENDING"
                | "DECLINED"
                | "VOIDED"
                | "CANCELLED"
                | "EXPIRED"
                | "CONSUMED"
            )[];
        }
      • customerId: string

      Returns Promise<
          {
              results: {
                  barcodeNumber: string;
                  createdAt: string;
                  depositId?: string;
                  deviceIpAddress?: string;
                  deviceLocation?: { lat: number; long: number; source: "ip" };
                  expiresAt: string;
                  id: string;
                  identityId: string;
                  legacyId?: string;
                  metadata?: StaticRecord<
                      [],
                      "Encode",
                      {},
                      {
                          barcodeNumber: TString;
                          createdAt: TString;
                          depositId: TOptional<TString>;
                          deviceIpAddress: TOptional<TString>;
                          deviceLocation: TOptional<
                              TObject<{ lat: TNumber; long: TNumber; source: TLiteral<(...)> }>,
                          >;
                          expiresAt: TString;
                          id: TString;
                          identityId: TString;
                          legacyId: TOptional<TString>;
                          metadata: TOptional<TRecord<"^.*$", TAny>>;
                          quote: TOptional<
                              TObject<
                                  {
                                      amountIn: TObject<(...)>;
                                      amountOut: TObject<(...)>;
                                      fees: TArray<(...)>;
                                  },
                              >,
                          >;
                          reference: TString;
                          retailerId: TString;
                          retailerName: TString;
                          status: TUnsafe<
                              | "CREATED"
                              | "PENDING"
                              | "DECLINED"
                              | "VOIDED"
                              | "CANCELLED"
                              | "EXPIRED"
                              | "CONSUMED",
                          >;
                          updatedAt: TString;
                          wallet: TObject<{ address: TString; blockchain: TLiteral<"SOLANA"> }>;
                      },
                      "^.*$",
                      TAny,
                  >;
                  quote?: {
                      amountIn: {
                          amount: number;
                          currency: | "USD"
                          | "AUD"
                          | "HKD"
                          | "JPY"
                          | "MXN"
                          | "NZD"
                          | "SGD"
                          | "SEK"
                          | "CHF"
                          | "CAD"
                          | "GBP"
                          | "CZK"
                          | "DKK"
                          | "EUR";
                      };
                      amountOut: { amount: number; currency: "MOVEUSD"
                      | "USDC" };
                      fees: {
                          fee: { amount: number; currency: "MOVEUSD" | "USDC" };
                          type:
                              | "CFX_FIXED_FEE"
                              | "CFX_VARIABLE_FEE"
                              | "PROVIDER_FIXED_FEE"
                              | "PROVIDER_VARIABLE_FEE"
                              | "CUSTOMER_FIXED_FEE"
                              | "CUSTOMER_VARIABLE_FEE";
                      }[];
                  };
                  reference: string;
                  retailerId: string;
                  retailerName: string;
                  status: | "CREATED"
                  | "PENDING"
                  | "DECLINED"
                  | "VOIDED"
                  | "CANCELLED"
                  | "EXPIRED"
                  | "CONSUMED";
                  updatedAt: string;
                  wallet: { address: string; blockchain: "SOLANA" };
              }[];
          },
      >