Class PaymentInstrumentQueryService

Query payment instruments across supported types

Hierarchy (View Summary)

PaymentInstrumentQueryService
- UsAchPaymentInstrumentService

Index

Constructors

constructor

Properties

Methods

get search

Constructors

constructor

new PaymentInstrumentQueryService(
args: { db: B2bDatabase },
): PaymentInstrumentQueryService
Parameters
- args: { db: B2bDatabase }
Returns PaymentInstrumentQueryService
- Defined in packages/payment-instrument-services/src/PaymentInstrumentQueryService.ts:70

Properties

`Protected` `Readonly`db

db: B2bDatabase

Methods

get

get(
    __namedParameters: {
        customerId: string;
        deleted?: boolean;
        entityId?: string;
        type?:
            | "US_WIRE"
            | "SWIFT_WIRE"
            | "AF_BANK"
            | "AF_MOMO"
            | "EXTERNAL_US_ACH"
            | "MX_CLABE"
            | "NETWORK_WALLET"
            | "US_ACH"
            | "US_INSTANT"
            | "WALLET";
    } & ({ id: string } | { referenceId: string }),
): Promise<
    {
        ok: true;
        value: | (
            PaymentInstrument & { entityId: string; entityName: string; entityDisplayName: string; entityType: "IDENTITY" | "ORGANIZATION"; entityReferenceId: string | null; }
        )
        | null;
    },
>
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"
          | "EXTERNAL_US_ACH"
          | "MX_CLABE"
          | "NETWORK_WALLET"
          | "US_ACH"
          | "US_INSTANT"
          | "WALLET";
  } & ({ id: string } | { referenceId: string })
Returns Promise<
    {
        ok: true;
        value: | (
            PaymentInstrument & { entityId: string; entityName: string; entityDisplayName: string; entityType: "IDENTITY" | "ORGANIZATION"; entityReferenceId: string | null; }
        )
        | null;
    },
>
- Defined in packages/payment-instrument-services/src/PaymentInstrumentQueryService.ts:79

search

search(
    __namedParameters: {
        createdAt?: DbTimestampCriteria;
        customerId: string;
        deleted?: boolean;
        entityIds?: string[];
        ids?: string[];
        nameLike?: string;
        orderBy?: DbOrderByCriterion<
            Omit<
                PgTableWithColumns<
                    {
                        columns: {
                            createdAt: PgBuildColumn<
                                "payment_instrument",
                                SetHasDefault<SetNotNull<(...)>>,
                                {
                                    data: Date;
                                    dataType: "object date";
                                    driverParam: string;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: true;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: true;
                                    tableName: "payment_instrument";
                                },
                            >;
                            customerId: PgBuildColumn<
                                "payment_instrument",
                                SetNotNull<PgIntegerBuilder>,
                                {
                                    data: number;
                                    dataType: "number int32";
                                    driverParam: (...) | (...);
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: true;
                                    tableName: "payment_instrument";
                                },
                            >;
                            deletedAt: PgBuildColumn<
                                "payment_instrument",
                                PgTimestampBuilder,
                                {
                                    data: Date;
                                    dataType: "object date";
                                    driverParam: string;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: false;
                                    tableName: "payment_instrument";
                                },
                            >;
                            externalId: PgBuildColumn<
                                "payment_instrument",
                                SetHasRuntimeDefault<SetNotNull<(...)>>,
                                {
                                    data: string;
                                    dataType: "string";
                                    driverParam: string;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: true;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: true;
                                    tableName: "payment_instrument";
                                },
                            >;
                            id: PgBuildColumn<
                                "payment_instrument",
                                HasIdentity<SetIsPrimaryKey<(...)>, "byDefault">,
                                {
                                    data: number;
                                    dataType: "number int32";
                                    driverParam: (...) | (...);
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: true;
                                    hasRuntimeDefault: false;
                                    identity: "byDefault";
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: true;
                                    tableName: "payment_instrument";
                                },
                            >;
                            identityId: PgBuildColumn<
                                "payment_instrument",
                                PgIntegerBuilder,
                                {
                                    data: number;
                                    dataType: "number int32";
                                    driverParam: (...)
                                    | (...);
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: false;
                                    tableName: "payment_instrument";
                                },
                            >;
                            instrumentData: PgBuildColumn<
                                "payment_instrument",
                                SetNotNull<PgJsonbBuilder>,
                                {
                                    data: unknown;
                                    dataType: "object json";
                                    driverParam: unknown;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: true;
                                    tableName: "payment_instrument";
                                },
                            >;
                            organizationId: PgBuildColumn<
                                "payment_instrument",
                                PgIntegerBuilder,
                                {
                                    data: number;
                                    dataType: "number int32";
                                    driverParam: (...)
                                    | (...);
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: false;
                                    tableName: "payment_instrument";
                                },
                            >;
                            provider: PgBuildColumn<
                                "payment_instrument",
                                SetNotNull<Set$Type<(...), (...)>>,
                                {
                                    data:
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...);
                                    dataType: "string";
                                    driverParam: string;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: true;
                                    tableName: "payment_instrument";
                                },
                            >;
                            providerId: PgBuildColumn<
                                "payment_instrument",
                                SetNotNull<PgTextBuilder<(...)>>,
                                {
                                    data: string;
                                    dataType: "string";
                                    driverParam: string;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: true;
                                    tableName: "payment_instrument";
                                },
                            >;
                            referenceId: PgBuildColumn<
                                "payment_instrument",
                                PgTextBuilder<[(...), ...(...)[]]>,
                                {
                                    data: string;
                                    dataType: "string";
                                    driverParam: string;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: false;
                                    tableName: "payment_instrument";
                                },
                            >;
                            status: PgBuildColumn<
                                "payment_instrument",
                                Set$Type<SetNotNull<(...)>, (...) | (...) | (...) | (...)>,
                                {
                                    data: (...) | (...) | (...) | (...);
                                    dataType: "string";
                                    driverParam: string;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: true;
                                    tableName: "payment_instrument";
                                },
                            >;
                            type: PgBuildColumn<
                                "payment_instrument",
                                Set$Type<
                                    SetNotNull<(...)>,

                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...),
                                >,
                                {
                                    data:
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...);
                                    dataType: "string";
                                    driverParam: string;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: true;
                                    tableName: "payment_instrument";
                                },
                            >;
                            updatedAt: PgBuildColumn<
                                "payment_instrument",
                                SetHasDefault<SetHasDefault<(...)>>,
                                {
                                    data: Date;
                                    dataType: "object date";
                                    driverParam: string;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: true;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: true;
                                    tableName: "payment_instrument";
                                },
                            >;
                        };
                        dialect: "pg";
                        name: "payment_instrument";
                        schema: "b2b";
                    },
                >,
                "enableRLS",
            >,
            "createdAt"
            | "updatedAt",
        >[];
        page?: number;
        pageSize?: number;
        partialText?: string;
        provider?:
            | "LEDGER_ACCOUNT"
            | "MX_CLABE"
            | `chn_${string}`
            | "WIRE_DEPOSIT"
            | "ACH_PUSH_DEPOSIT"
            | "YELLOWCARD"
            | "QUILTT"
            | "VICTOR"
            | "CFX";
        providerId?: string;
        quilttConnectionId?: string;
        referenceIdLike?: string;
        referenceIds?: string[];
        statuses?: ("ACTIVE" | "DELETED" | "PENDING_VERIFICATION" | "BLOCKED")[];
        types?: (
            | "US_WIRE"
            | "SWIFT_WIRE"
            | "AF_BANK"
            | "AF_MOMO"
            | "EXTERNAL_US_ACH"
            | "MX_CLABE"
            | "NETWORK_WALLET"
            | "US_ACH"
            | "US_INSTANT"
            | "WALLET"
        )[];
        updatedAt?: DbTimestampCriteria;
    },
): Promise<
    {
        ok: true;
        value: {
            hasNext: boolean;
            items: (
                PaymentInstrument & {
                    entityDisplayName: string;
                    entityId: string;
                    entityName: string;
                    entityReferenceId: string
                    | null;
                    entityType: "IDENTITY" | "ORGANIZATION";
                }
            )[];
        };
    },
>
Parameters
- __namedParameters: {
      createdAt?: DbTimestampCriteria;
      customerId: string;
      deleted?: boolean;
      entityIds?: string[];
      ids?: string[];
      nameLike?: string;
      orderBy?: DbOrderByCriterion<
          Omit<
              PgTableWithColumns<
                  {
                      columns: {
                          createdAt: PgBuildColumn<
                              "payment_instrument",
                              SetHasDefault<SetNotNull<(...)>>,
                              {
                                  data: Date;
                                  dataType: "object date";
                                  driverParam: string;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: true;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: true;
                                  tableName: "payment_instrument";
                              },
                          >;
                          customerId: PgBuildColumn<
                              "payment_instrument",
                              SetNotNull<PgIntegerBuilder>,
                              {
                                  data: number;
                                  dataType: "number int32";
                                  driverParam: (...) | (...);
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: true;
                                  tableName: "payment_instrument";
                              },
                          >;
                          deletedAt: PgBuildColumn<
                              "payment_instrument",
                              PgTimestampBuilder,
                              {
                                  data: Date;
                                  dataType: "object date";
                                  driverParam: string;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: false;
                                  tableName: "payment_instrument";
                              },
                          >;
                          externalId: PgBuildColumn<
                              "payment_instrument",
                              SetHasRuntimeDefault<SetNotNull<(...)>>,
                              {
                                  data: string;
                                  dataType: "string";
                                  driverParam: string;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: true;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: true;
                                  tableName: "payment_instrument";
                              },
                          >;
                          id: PgBuildColumn<
                              "payment_instrument",
                              HasIdentity<SetIsPrimaryKey<(...)>, "byDefault">,
                              {
                                  data: number;
                                  dataType: "number int32";
                                  driverParam: (...) | (...);
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: true;
                                  hasRuntimeDefault: false;
                                  identity: "byDefault";
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: true;
                                  tableName: "payment_instrument";
                              },
                          >;
                          identityId: PgBuildColumn<
                              "payment_instrument",
                              PgIntegerBuilder,
                              {
                                  data: number;
                                  dataType: "number int32";
                                  driverParam: (...)
                                  | (...);
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: false;
                                  tableName: "payment_instrument";
                              },
                          >;
                          instrumentData: PgBuildColumn<
                              "payment_instrument",
                              SetNotNull<PgJsonbBuilder>,
                              {
                                  data: unknown;
                                  dataType: "object json";
                                  driverParam: unknown;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: true;
                                  tableName: "payment_instrument";
                              },
                          >;
                          organizationId: PgBuildColumn<
                              "payment_instrument",
                              PgIntegerBuilder,
                              {
                                  data: number;
                                  dataType: "number int32";
                                  driverParam: (...)
                                  | (...);
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: false;
                                  tableName: "payment_instrument";
                              },
                          >;
                          provider: PgBuildColumn<
                              "payment_instrument",
                              SetNotNull<Set$Type<(...), (...)>>,
                              {
                                  data:
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...);
                                  dataType: "string";
                                  driverParam: string;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: true;
                                  tableName: "payment_instrument";
                              },
                          >;
                          providerId: PgBuildColumn<
                              "payment_instrument",
                              SetNotNull<PgTextBuilder<(...)>>,
                              {
                                  data: string;
                                  dataType: "string";
                                  driverParam: string;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: true;
                                  tableName: "payment_instrument";
                              },
                          >;
                          referenceId: PgBuildColumn<
                              "payment_instrument",
                              PgTextBuilder<[(...), ...(...)[]]>,
                              {
                                  data: string;
                                  dataType: "string";
                                  driverParam: string;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: false;
                                  tableName: "payment_instrument";
                              },
                          >;
                          status: PgBuildColumn<
                              "payment_instrument",
                              Set$Type<SetNotNull<(...)>, (...) | (...) | (...) | (...)>,
                              {
                                  data: (...) | (...) | (...) | (...);
                                  dataType: "string";
                                  driverParam: string;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: true;
                                  tableName: "payment_instrument";
                              },
                          >;
                          type: PgBuildColumn<
                              "payment_instrument",
                              Set$Type<
                                  SetNotNull<(...)>,
  
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...),
                              >,
                              {
                                  data:
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...)
                                      | (...);
                                  dataType: "string";
                                  driverParam: string;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: true;
                                  tableName: "payment_instrument";
                              },
                          >;
                          updatedAt: PgBuildColumn<
                              "payment_instrument",
                              SetHasDefault<SetHasDefault<(...)>>,
                              {
                                  data: Date;
                                  dataType: "object date";
                                  driverParam: string;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: true;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: true;
                                  tableName: "payment_instrument";
                              },
                          >;
                      };
                      dialect: "pg";
                      name: "payment_instrument";
                      schema: "b2b";
                  },
              >,
              "enableRLS",
          >,
          "createdAt"
          | "updatedAt",
      >[];
      page?: number;
      pageSize?: number;
      partialText?: string;
      provider?:
          | "LEDGER_ACCOUNT"
          | "MX_CLABE"
          | `chn_${string}`
          | "WIRE_DEPOSIT"
          | "ACH_PUSH_DEPOSIT"
          | "YELLOWCARD"
          | "QUILTT"
          | "VICTOR"
          | "CFX";
      providerId?: string;
      quilttConnectionId?: string;
      referenceIdLike?: string;
      referenceIds?: string[];
      statuses?: ("ACTIVE" | "DELETED" | "PENDING_VERIFICATION" | "BLOCKED")[];
      types?: (
          | "US_WIRE"
          | "SWIFT_WIRE"
          | "AF_BANK"
          | "AF_MOMO"
          | "EXTERNAL_US_ACH"
          | "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: PgBuildColumn<
                            "payment_instrument",
                            SetHasDefault<SetNotNull<(...)>>,
                            {
                                data: Date;
                                dataType: "object date";
                                driverParam: string;
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: true;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: true;
                                tableName: "payment_instrument";
                            },
                        >;
                        customerId: PgBuildColumn<
                            "payment_instrument",
                            SetNotNull<PgIntegerBuilder>,
                            {
                                data: number;
                                dataType: "number int32";
                                driverParam: (...) | (...);
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: true;
                                tableName: "payment_instrument";
                            },
                        >;
                        deletedAt: PgBuildColumn<
                            "payment_instrument",
                            PgTimestampBuilder,
                            {
                                data: Date;
                                dataType: "object date";
                                driverParam: string;
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: false;
                                tableName: "payment_instrument";
                            },
                        >;
                        externalId: PgBuildColumn<
                            "payment_instrument",
                            SetHasRuntimeDefault<SetNotNull<(...)>>,
                            {
                                data: string;
                                dataType: "string";
                                driverParam: string;
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: true;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: true;
                                tableName: "payment_instrument";
                            },
                        >;
                        id: PgBuildColumn<
                            "payment_instrument",
                            HasIdentity<SetIsPrimaryKey<(...)>, "byDefault">,
                            {
                                data: number;
                                dataType: "number int32";
                                driverParam: (...) | (...);
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: true;
                                hasRuntimeDefault: false;
                                identity: "byDefault";
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: true;
                                tableName: "payment_instrument";
                            },
                        >;
                        identityId: PgBuildColumn<
                            "payment_instrument",
                            PgIntegerBuilder,
                            {
                                data: number;
                                dataType: "number int32";
                                driverParam: (...)
                                | (...);
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: false;
                                tableName: "payment_instrument";
                            },
                        >;
                        instrumentData: PgBuildColumn<
                            "payment_instrument",
                            SetNotNull<PgJsonbBuilder>,
                            {
                                data: unknown;
                                dataType: "object json";
                                driverParam: unknown;
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: true;
                                tableName: "payment_instrument";
                            },
                        >;
                        organizationId: PgBuildColumn<
                            "payment_instrument",
                            PgIntegerBuilder,
                            {
                                data: number;
                                dataType: "number int32";
                                driverParam: (...)
                                | (...);
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: false;
                                tableName: "payment_instrument";
                            },
                        >;
                        provider: PgBuildColumn<
                            "payment_instrument",
                            SetNotNull<Set$Type<(...), (...)>>,
                            {
                                data:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                dataType: "string";
                                driverParam: string;
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: true;
                                tableName: "payment_instrument";
                            },
                        >;
                        providerId: PgBuildColumn<
                            "payment_instrument",
                            SetNotNull<PgTextBuilder<(...)>>,
                            {
                                data: string;
                                dataType: "string";
                                driverParam: string;
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: true;
                                tableName: "payment_instrument";
                            },
                        >;
                        referenceId: PgBuildColumn<
                            "payment_instrument",
                            PgTextBuilder<[(...), ...(...)[]]>,
                            {
                                data: string;
                                dataType: "string";
                                driverParam: string;
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: false;
                                tableName: "payment_instrument";
                            },
                        >;
                        status: PgBuildColumn<
                            "payment_instrument",
                            Set$Type<SetNotNull<(...)>, (...) | (...) | (...) | (...)>,
                            {
                                data: (...) | (...) | (...) | (...);
                                dataType: "string";
                                driverParam: string;
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: true;
                                tableName: "payment_instrument";
                            },
                        >;
                        type: PgBuildColumn<
                            "payment_instrument",
                            Set$Type<
                                SetNotNull<(...)>,
    
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...),
                            >,
                            {
                                data:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                dataType: "string";
                                driverParam: string;
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: true;
                                tableName: "payment_instrument";
                            },
                        >;
                        updatedAt: PgBuildColumn<
                            "payment_instrument",
                            SetHasDefault<SetHasDefault<(...)>>,
                            {
                                data: Date;
                                dataType: "object date";
                                driverParam: string;
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: true;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                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?:
        | "LEDGER_ACCOUNT"
        | "MX_CLABE"
        | `chn_${string}`
        | "WIRE_DEPOSIT"
        | "ACH_PUSH_DEPOSIT"
        | "YELLOWCARD"
        | "QUILTT"
        | "VICTOR"
        | "CFX"
  - OptionalproviderId?: string
  - OptionalquilttConnectionId?: string
  - OptionalreferenceIdLike?: string
  - OptionalreferenceIds?: string[]
  - Optionalstatuses?: ("ACTIVE" | "DELETED" | "PENDING_VERIFICATION" | "BLOCKED")[]
  - Optionaltypes?: (
        | "US_WIRE"
        | "SWIFT_WIRE"
        | "AF_BANK"
        | "AF_MOMO"
        | "EXTERNAL_US_ACH"
        | "MX_CLABE"
        | "NETWORK_WALLET"
        | "US_ACH"
        | "US_INSTANT"
        | "WALLET"
    )[]
  - OptionalupdatedAt?: DbTimestampCriteria
Returns Promise<
    {
        ok: true;
        value: {
            hasNext: boolean;
            items: (
                PaymentInstrument & {
                    entityDisplayName: string;
                    entityId: string;
                    entityName: string;
                    entityReferenceId: string
                    | null;
                    entityType: "IDENTITY" | "ORGANIZATION";
                }
            )[];
        };
    },
>
- Defined in packages/payment-instrument-services/src/PaymentInstrumentQueryService.ts:189

Class PaymentInstrumentQueryService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PaymentInstrumentQueryService

Properties

`Protected` `Readonly`db

Methods

get

Parameters

Returns Promise<
    {
        ok: true;
        value: | (
            PaymentInstrument & { entityId: string; entityName: string; entityDisplayName: string; entityType: "IDENTITY" | "ORGANIZATION"; entityReferenceId: string | null; }
        )
        | null;
    },
>

search

Parameters

`Optional`createdAt?: DbTimestampCriteria

customerId: string

`Optional`deleted?: boolean

`Optional`entityIds?: string[]

`Optional`ids?: string[]

`Optional`nameLike?: string

`Optional`page?: number

`Optional`pageSize?: number

`Optional`partialText?: string

`Optional`provider?:
    | "LEDGER_ACCOUNT"
    | "MX_CLABE"
    | `chn_${string}`
    | "WIRE_DEPOSIT"
    | "ACH_PUSH_DEPOSIT"
    | "YELLOWCARD"
    | "QUILTT"
    | "VICTOR"
    | "CFX"

`Optional`providerId?: string

`Optional`quilttConnectionId?: string

`Optional`referenceIdLike?: string

`Optional`referenceIds?: string[]

`Optional`statuses?: ("ACTIVE" | "DELETED" | "PENDING_VERIFICATION" | "BLOCKED")[]

`Optional`types?: (
    | "US_WIRE"
    | "SWIFT_WIRE"
    | "AF_BANK"
    | "AF_MOMO"
    | "EXTERNAL_US_ACH"
    | "MX_CLABE"
    | "NETWORK_WALLET"
    | "US_ACH"
    | "US_INSTANT"
    | "WALLET"
)[]

`Optional`updatedAt?: DbTimestampCriteria

Settings

On This Page

Class PaymentInstrumentQueryService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PaymentInstrumentQueryService

Properties

Protected Readonlydb

Methods

get

Parameters

Returns Promise< { ok: true; value: | ( PaymentInstrument & { entityId: string; entityName: string; entityDisplayName: string; entityType: "IDENTITY" | "ORGANIZATION"; entityReferenceId: string | null; } ) | null; },>

search

Parameters

OptionalcreatedAt?: DbTimestampCriteria

customerId: string

Optionaldeleted?: boolean

OptionalentityIds?: string[]

Optionalids?: string[]

OptionalnameLike?: string

Optionalpage?: number

OptionalpageSize?: number

OptionalpartialText?: string

Optionalprovider?: | "LEDGER_ACCOUNT" | "MX_CLABE" | `chn_${string}` | "WIRE_DEPOSIT" | "ACH_PUSH_DEPOSIT" | "YELLOWCARD" | "QUILTT" | "VICTOR" | "CFX"

OptionalproviderId?: string

OptionalquilttConnectionId?: string

OptionalreferenceIdLike?: string

OptionalreferenceIds?: string[]

Optionalstatuses?: ("ACTIVE" | "DELETED" | "PENDING_VERIFICATION" | "BLOCKED")[]

Optionaltypes?: ( | "US_WIRE" | "SWIFT_WIRE" | "AF_BANK" | "AF_MOMO" | "EXTERNAL_US_ACH" | "MX_CLABE" | "NETWORK_WALLET" | "US_ACH" | "US_INSTANT" | "WALLET")[]

OptionalupdatedAt?: DbTimestampCriteria

Returns Promise< { ok: true; value: { hasNext: boolean; items: ( PaymentInstrument & { entityDisplayName: string; entityId: string; entityName: string; entityReferenceId: string | null; entityType: "IDENTITY" | "ORGANIZATION"; } )[]; }; },>

Settings

On This Page

`Protected` `Readonly`db

Returns Promise<
{
ok: true;
value: | (
PaymentInstrument & { entityId: string; entityName: string; entityDisplayName: string; entityType: "IDENTITY" | "ORGANIZATION"; entityReferenceId: string | null; }
)
| null;
},
>

`Optional`createdAt?: DbTimestampCriteria

`Optional`deleted?: boolean

`Optional`entityIds?: string[]

`Optional`ids?: string[]

`Optional`nameLike?: string

`Optional`page?: number

`Optional`pageSize?: number

`Optional`partialText?: string

`Optional`provider?:
| "LEDGER_ACCOUNT"
| "MX_CLABE"
| `chn_${string}`
| "WIRE_DEPOSIT"
| "ACH_PUSH_DEPOSIT"
| "YELLOWCARD"
| "QUILTT"
| "VICTOR"
| "CFX"

`Optional`providerId?: string

`Optional`quilttConnectionId?: string

`Optional`referenceIdLike?: string

`Optional`referenceIds?: string[]

`Optional`statuses?: ("ACTIVE" | "DELETED" | "PENDING_VERIFICATION" | "BLOCKED")[]

`Optional`types?: (
| "US_WIRE"
| "SWIFT_WIRE"
| "AF_BANK"
| "AF_MOMO"
| "EXTERNAL_US_ACH"
| "MX_CLABE"
| "NETWORK_WALLET"
| "US_ACH"
| "US_INSTANT"
| "WALLET"
)[]

`Optional`updatedAt?: DbTimestampCriteria

Returns Promise<
{
ok: true;
value: {
hasNext: boolean;
items: (
PaymentInstrument & {
entityDisplayName: string;
entityId: string;
entityName: string;
entityReferenceId: string
| null;
entityType: "IDENTITY" | "ORGANIZATION";
}
)[];
};
},
>