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

    Class PaymentInstrumentQueryService

    Query payment instruments across supported types

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    db dbHelper

    Methods

    get search

    Constructors

    Properties

    db: B2bDatabase
    dbHelper: DbHelper

    Methods

    • Get instrument by ID or reference ID

      It can be further narrowed down by type and entity ID.

      Parameters

      • __namedParameters: {
            customerId: string;
            deleted?: boolean;
            entityId?: string;
            type?:
                | "US_WIRE"
                | "SWIFT_WIRE"
                | "AF_BANK"
                | "AF_MOMO"
                | "MX_CLABE"
                | "NETWORK_WALLET"
                | "US_ACH"
                | "US_INSTANT"
                | "WALLET";
        } & ({ id: string } | { referenceId: string })

      Returns Promise<{ ok: true; value: (PaymentInstrument & { entityId: string; }) | null }>

    • Parameters

      • __namedParameters: {
            createdAt?: DbTimestampCriteria;
            customerId: string;
            deleted?: boolean;
            entityIds?: string[];
            ids?: string[];
            nameLike?: 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: "payment_instrument";
                                    },
                                    {},
                                    {},
                                >;
                                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: "payment_instrument";
                                    },
                                    {},
                                    {},
                                >;
                                deletedAt: PgColumn<
                                    {
                                        baseColumn: never;
                                        columnType: "PgTimestamp";
                                        data: Date;
                                        dataType: "date";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: "deletedAt";
                                        notNull: false;
                                        tableName: "payment_instrument";
                                    },
                                    {},
                                    {},
                                >;
                                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: "payment_instrument";
                                    },
                                    {},
                                    {},
                                >;
                                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: "payment_instrument";
                                    },
                                    {},
                                    {},
                                >;
                                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: "payment_instrument";
                                    },
                                    {},
                                    {},
                                >;
                                instrumentData: PgColumn<
                                    {
                                        baseColumn: never;
                                        columnType: "PgJsonb";
                                        data: unknown;
                                        dataType: "json";
                                        driverParam: unknown;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: "instrumentData";
                                        notNull: true;
                                        tableName: "payment_instrument";
                                    },
                                    {},
                                    {},
                                >;
                                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: "payment_instrument";
                                    },
                                    {},
                                    {},
                                >;
                                provider: PgColumn<
                                    {
                                        baseColumn: never;
                                        columnType: "PgText";
                                        data: | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...);
                                        dataType: "string";
                                        driverParam: string;
                                        enumValues: [(...), ...(...)[]];
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: "provider";
                                        notNull: true;
                                        tableName: "payment_instrument";
                                    },
                                    {},
                                    {
                                        $type: | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...);
                                    },
                                >;
                                providerId: 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: "providerId";
                                        notNull: true;
                                        tableName: "payment_instrument";
                                    },
                                    {},
                                    {},
                                >;
                                referenceId: 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: "referenceId";
                                        notNull: false;
                                        tableName: "payment_instrument";
                                    },
                                    {},
                                    {},
                                >;
                                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: "payment_instrument";
                                    },
                                    {},
                                    { $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: "payment_instrument";
                                    },
                                    {},
                                    {
                                        $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: "payment_instrument";
                                    },
                                    {},
                                    {},
                                >;
                            };
                            dialect: "pg";
                            name: "payment_instrument";
                            schema: "b2b";
                        },
                    >,
                    "enableRLS",
                >,
                "createdAt"
                | "updatedAt",
            >[];
            page?: number;
            pageSize?: number;
            partialText?: string;
            provider?:
                | "REDEMPTION"
                | "SOLANA"
                | "MX_CLABE"
                | "WIRE_DEPOSIT"
                | "ACH_PUSH_DEPOSIT"
                | "YELLOWCARD"
                | "QUILTT"
                | "VICTOR"
                | "CFX"
                | "ETHEREUM"
                | "BASE";
            providerId?: string;
            quilttConnectionId?: string;
            referenceIdLike?: string;
            referenceIds?: string[];
            statuses?: ("ACTIVE" | "PENDING_VERIFICATION" | "BLOCKED" | "DELETED")[];
            types?: (
                | "US_WIRE"
                | "SWIFT_WIRE"
                | "AF_BANK"
                | "AF_MOMO"
                | "MX_CLABE"
                | "NETWORK_WALLET"
                | "US_ACH"
                | "US_INSTANT"
                | "WALLET"
            )[];
            updatedAt?: DbTimestampCriteria;
        }
        • OptionalcreatedAt?: DbTimestampCriteria
        • customerId: string
        • Optionaldeleted?: boolean
        • OptionalentityIds?: string[]
        • Optionalids?: string[]
        • OptionalnameLike?: string
        • OptionalorderBy?: 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: "payment_instrument";
                                  },
                                  {},
                                  {},
                              >;
                              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: "payment_instrument";
                                  },
                                  {},
                                  {},
                              >;
                              deletedAt: PgColumn<
                                  {
                                      baseColumn: never;
                                      columnType: "PgTimestamp";
                                      data: Date;
                                      dataType: "date";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: "deletedAt";
                                      notNull: false;
                                      tableName: "payment_instrument";
                                  },
                                  {},
                                  {},
                              >;
                              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: "payment_instrument";
                                  },
                                  {},
                                  {},
                              >;
                              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: "payment_instrument";
                                  },
                                  {},
                                  {},
                              >;
                              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: "payment_instrument";
                                  },
                                  {},
                                  {},
                              >;
                              instrumentData: PgColumn<
                                  {
                                      baseColumn: never;
                                      columnType: "PgJsonb";
                                      data: unknown;
                                      dataType: "json";
                                      driverParam: unknown;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: "instrumentData";
                                      notNull: true;
                                      tableName: "payment_instrument";
                                  },
                                  {},
                                  {},
                              >;
                              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: "payment_instrument";
                                  },
                                  {},
                                  {},
                              >;
                              provider: PgColumn<
                                  {
                                      baseColumn: never;
                                      columnType: "PgText";
                                      data: | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...);
                                      dataType: "string";
                                      driverParam: string;
                                      enumValues: [(...), ...(...)[]];
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: "provider";
                                      notNull: true;
                                      tableName: "payment_instrument";
                                  },
                                  {},
                                  {
                                      $type: | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...);
                                  },
                              >;
                              providerId: 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: "providerId";
                                      notNull: true;
                                      tableName: "payment_instrument";
                                  },
                                  {},
                                  {},
                              >;
                              referenceId: 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: "referenceId";
                                      notNull: false;
                                      tableName: "payment_instrument";
                                  },
                                  {},
                                  {},
                              >;
                              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: "payment_instrument";
                                  },
                                  {},
                                  { $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: "payment_instrument";
                                  },
                                  {},
                                  {
                                      $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: "payment_instrument";
                                  },
                                  {},
                                  {},
                              >;
                          };
                          dialect: "pg";
                          name: "payment_instrument";
                          schema: "b2b";
                      },
                  >,
                  "enableRLS",
              >,
              "createdAt"
              | "updatedAt",
          >[]
        • Optionalpage?: number

          Defaults to 1

        • OptionalpageSize?: number

          Defaults to 10

        • OptionalpartialText?: string

          Perform partial search text on instrument data.

          One or more of the below types should be present in types argument for partial text search to execute.

          • SWIFT_WIRE
            • referenceId
            • beneficiary.name (BUSINESS)
            • beneficiary.firstName (PERSON)
            • beneficiary.middleName (PERSON)
            • beneficiary.lastName (PERSON)
            • beneficiary.reference
          • US_ACH
            • referenceId
            • accountName
            • accountHolderName
          • US_WIRE
            • referenceId
            • beneficiary.name (BUSINESS)
            • beneficiary.firstName (PERSON)
            • beneficiary.middleName (PERSON)
            • beneficiary.lastName (PERSON)
            • beneficiary.reference
          • WALLET
            • referenceId
            • address
            • chain
        • Optionalprovider?:
              | "REDEMPTION"
              | "SOLANA"
              | "MX_CLABE"
              | "WIRE_DEPOSIT"
              | "ACH_PUSH_DEPOSIT"
              | "YELLOWCARD"
              | "QUILTT"
              | "VICTOR"
              | "CFX"
              | "ETHEREUM"
              | "BASE"
        • OptionalproviderId?: string
        • OptionalquilttConnectionId?: string
        • OptionalreferenceIdLike?: string
        • OptionalreferenceIds?: string[]
        • Optionalstatuses?: ("ACTIVE" | "PENDING_VERIFICATION" | "BLOCKED" | "DELETED")[]
        • Optionaltypes?: (
              | "US_WIRE"
              | "SWIFT_WIRE"
              | "AF_BANK"
              | "AF_MOMO"
              | "MX_CLABE"
              | "NETWORK_WALLET"
              | "US_ACH"
              | "US_INSTANT"
              | "WALLET"
          )[]
        • OptionalupdatedAt?: DbTimestampCriteria

      Returns Promise<
          {
              ok: true;
              value: {
                  hasNext: boolean;
                  items: (PaymentInstrument & { entityId: string })[];
              };
          },
      >

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods