Class PaymentInstrumentAdminService

Cross-customer queries and instrument type-agnostic admin actions

Hierarchy (View Summary)

PaymentInstrumentAdminQueryService
- PaymentInstrumentAdminService

Index

Constructors

constructor

new PaymentInstrumentAdminService(
args: { entityEventPublisher: EntityEventPublisher; sqlClient: Sql },
): PaymentInstrumentAdminService
Parameters
- args: { entityEventPublisher: EntityEventPublisher; sqlClient: Sql }
Returns PaymentInstrumentAdminService
Overrides PaymentInstrumentAdminQueryService.constructor
- Defined in packages/payment-instrument-services/src/PaymentInstrumentAdminService.ts:397

Properties

`Protected` `Readonly`db

db: B2bDatabase

`Protected` `Readonly`dbHelper

dbHelper: DbHelper

Methods

block

block(
input: Pick<PaymentInstrument, "provider" | "providerId">,
): Promise<{ ok: true; value: PaymentInstrument[] }>
Add a block for the given provider and ID and set all existing relevant payment instruments to BLOCKED.
Parameters
- input: Pick<PaymentInstrument, "provider" | "providerId">
Returns Promise<{ ok: true; value: PaymentInstrument[] }>
- Defined in packages/payment-instrument-services/src/PaymentInstrumentAdminService.ts:557

get

get(
    __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 }),
): Promise<
    {
        ok: true;
        value: | (PaymentInstrument & { entityId: string; customerId: string; })
        | null;
    },
>
Get instrument by ID or reference ID

It can be further narrowed down by type, customer ID 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; customerId: string; })
        | null;
    },
>
Inherited from PaymentInstrumentAdminQueryService.get
- Defined in packages/payment-instrument-services/src/PaymentInstrumentAdminService.ts:62

search

search(
    __namedParameters: {
        createdAt?: DbTimestampCriteria;
        customerId?: string;
        customerIds?: string[];
        deleted?: boolean;
        entityIds?: string[];
        ids?: string[];
        nameLike?: string;
        nominisWalletScreenRequestId?: 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 | null;
        partialText?: string;
        referenceIdLike?: string;
        referenceIds?: string[];
        statuses?: ("ACTIVE" | "PENDING_VERIFICATION" | "BLOCKED" | "DELETED")[];
        tx?: B2bPgTransaction;
        types?: (
            | "US_WIRE"
            | "SWIFT_WIRE"
            | "AF_BANK"
            | "AF_MOMO"
            | "MX_CLABE"
            | "NETWORK_WALLET"
            | "US_ACH"
            | "US_INSTANT"
            | "WALLET"
        )[];
        updatedAt?: DbTimestampCriteria;
    },
): Promise<
    {
        ok: true;
        value: {
            hasNext: boolean;
            items: (PaymentInstrument & { customerId: string; entityId: string })[];
        };
    },
>
Parameters
- __namedParameters: {
      createdAt?: DbTimestampCriteria;
      customerId?: string;
      customerIds?: string[];
      deleted?: boolean;
      entityIds?: string[];
      ids?: string[];
      nameLike?: string;
      nominisWalletScreenRequestId?: 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 | null;
      partialText?: string;
      referenceIdLike?: string;
      referenceIds?: string[];
      statuses?: ("ACTIVE" | "PENDING_VERIFICATION" | "BLOCKED" | "DELETED")[];
      tx?: B2bPgTransaction;
      types?: (
          | "US_WIRE"
          | "SWIFT_WIRE"
          | "AF_BANK"
          | "AF_MOMO"
          | "MX_CLABE"
          | "NETWORK_WALLET"
          | "US_ACH"
          | "US_INSTANT"
          | "WALLET"
      )[];
      updatedAt?: DbTimestampCriteria;
  }
  - OptionalcreatedAt?: DbTimestampCriteria
  - OptionalcustomerId?: string
  - OptionalcustomerIds?: string[]
  - Optionaldeleted?: boolean
  - OptionalentityIds?: string[]
  - Optionalids?: string[]
  - OptionalnameLike?: string
  - OptionalnominisWalletScreenRequestId?: 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 | null
    Defaults to 10. null for no limit
  - OptionalpartialText?: string
    Perform partial search text on instrument data
  - OptionalreferenceIdLike?: string
  - OptionalreferenceIds?: string[]
  - Optionalstatuses?: ("ACTIVE" | "PENDING_VERIFICATION" | "BLOCKED" | "DELETED")[]
  - Optionaltx?: B2bPgTransaction
  - 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 & { customerId: string; entityId: string })[];
        };
    },
>
Inherited from PaymentInstrumentAdminQueryService.search
- Defined in packages/payment-instrument-services/src/PaymentInstrumentAdminService.ts:158

unblock

unblock(
input: Pick<PaymentInstrument, "provider" | "providerId">,
): Promise<{ ok: true; value: PaymentInstrument[] }>
Remove an existing block for the given provider and ID and optionally set all existing relevant payment instruments to ACTIVE.
Parameters
- input: Pick<PaymentInstrument, "provider" | "providerId">
Returns Promise<{ ok: true; value: PaymentInstrument[] }>
- Defined in packages/payment-instrument-services/src/PaymentInstrumentAdminService.ts:589

update

update(
    __namedParameters: {
        customerId?: string;
        data: Pick<PaymentInstrument, "status">;
        entityId?: string;
        type?:
            | "US_WIRE"
            | "SWIFT_WIRE"
            | "AF_BANK"
            | "AF_MOMO"
            | "MX_CLABE"
            | "NETWORK_WALLET"
            | "US_ACH"
            | "US_INSTANT"
            | "WALLET";
    } & ({ id: string } | { referenceId: string }),
): Promise<
    {
        ok: true;
        value: | (PaymentInstrument & { entityId: string; customerId: string; })
        | null;
    },
>
Update an existing instrument, get by ID or reference ID.

It can be further narrowed down by type, customer ID and entity ID.
Parameters
- __namedParameters: {
      customerId?: string;
      data: Pick<PaymentInstrument, "status">;
      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; customerId: string; })
        | null;
    },
>
Updated payment instrument or null if no instrument found
- Defined in packages/payment-instrument-services/src/PaymentInstrumentAdminService.ts:414

Class PaymentInstrumentAdminService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PaymentInstrumentAdminService

Properties

Protected Readonlydb

Protected ReadonlydbHelper

Methods

block

Parameters

Returns Promise<{ ok: true; value: PaymentInstrument[] }>

get

Parameters

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

search

Parameters

OptionalcreatedAt?: DbTimestampCriteria

OptionalcustomerId?: string

OptionalcustomerIds?: string[]

Optionaldeleted?: boolean

OptionalentityIds?: string[]

Optionalids?: string[]

OptionalnameLike?: string

OptionalnominisWalletScreenRequestId?: string

Optionalpage?: number

OptionalpageSize?: number | null

OptionalpartialText?: string

OptionalreferenceIdLike?: string

OptionalreferenceIds?: string[]

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

Optionaltx?: B2bPgTransaction

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 & { customerId: string; entityId: string })[]; }; },>

unblock

Parameters

Returns Promise<{ ok: true; value: PaymentInstrument[] }>

update

Parameters

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

Settings

On This Page

`Protected` `Readonly`db

`Protected` `Readonly`dbHelper

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

`Optional`createdAt?: DbTimestampCriteria

`Optional`customerId?: string

`Optional`customerIds?: string[]

`Optional`deleted?: boolean

`Optional`entityIds?: string[]

`Optional`ids?: string[]

`Optional`nameLike?: string

`Optional`nominisWalletScreenRequestId?: string

`Optional`page?: number

`Optional`pageSize?: number | null

`Optional`partialText?: string

`Optional`referenceIdLike?: string

`Optional`referenceIds?: string[]

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

`Optional`tx?: B2bPgTransaction

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

`Optional`updatedAt?: DbTimestampCriteria

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

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