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

    Hierarchy

    • VictorBaseClient
      • VictorCounterpartyClient
    Index

    Constructors

    • Parameters

      • args: {
            baseUrl: string;
            clientId: string;
            clientSecret: string;
            keyvStore?: KeyvStoreAdapter;
            proxy: { cert: string; key: string; uri: string } | null;
        }

      Returns VictorCounterpartyClient

    Properties

    client: Client<paths>

    Methods

    • Parameters

      • args: {
            accountNumber: string;
            accountType: "CHECKING" | "SAVING";
            nameOnAccount: string;
            routingNumber: string;
        }

      Returns Promise<
          {
              account_name?: string;
              address?: {
                  city: string;
                  country_code?: string;
                  state: string;
                  street_address1: string;
                  street_address2?: string;
                  zip_code: string;
              };
              counterparty_ach_info?: {
                  account_number?: string;
                  account_type?: "CHECKING"
                  | "SAVING"
                  | "GL";
                  routing_number?: string;
              };
              counterparty_rtp_info?: {
                  account_number?: string;
                  routing_number?: string;
              };
              counterparty_wire_info?: {
                  account_number?: string;
                  address_on_account?: {
                      city: string;
                      country_code?: string;
                      state: string;
                      street_address1: string;
                      street_address2?: string;
                      zip_code: string;
                  };
                  bank_address?: {
                      city: string;
                      country_code?: string;
                      state: string;
                      street_address1: string;
                      street_address2?: string;
                      zip_code: string;
                  };
                  bank_name?: string;
                  intermediary_bank_name?: string;
                  intermediary_bank_routing_number?: string;
                  routing_number?: string;
              };
              created_at?: number;
              description?: string;
              updated_at?: number;
              victor_counterparty_id?: string;
          },
      >

    • Parameters

      • args: { accountNumber: string; nameOnAccount: string; routingNumber: string }

      Returns Promise<
          {
              account_name?: string;
              address?: {
                  city: string;
                  country_code?: string;
                  state: string;
                  street_address1: string;
                  street_address2?: string;
                  zip_code: string;
              };
              counterparty_ach_info?: {
                  account_number?: string;
                  account_type?: "CHECKING"
                  | "SAVING"
                  | "GL";
                  routing_number?: string;
              };
              counterparty_rtp_info?: {
                  account_number?: string;
                  routing_number?: string;
              };
              counterparty_wire_info?: {
                  account_number?: string;
                  address_on_account?: {
                      city: string;
                      country_code?: string;
                      state: string;
                      street_address1: string;
                      street_address2?: string;
                      zip_code: string;
                  };
                  bank_address?: {
                      city: string;
                      country_code?: string;
                      state: string;
                      street_address1: string;
                      street_address2?: string;
                      zip_code: string;
                  };
                  bank_name?: string;
                  intermediary_bank_name?: string;
                  intermediary_bank_routing_number?: string;
                  routing_number?: string;
              };
              created_at?: number;
              description?: string;
              updated_at?: number;
              victor_counterparty_id?: string;
          },
      >

    • Parameters

      • args: {
            accountNumber: string;
            addressOnAccount: {
                city: string;
                countryCode: string;
                line1: string;
                line2?: string;
                postalCode: string;
                region: string;
            };
            bankAddress: {
                city: string;
                line1: string;
                postalCode: string;
                state: string;
            };
            bankName: string;
            nameOnAccount: string;
            routingNumber: string;
        }

      Returns Promise<
          {
              account_name?: string;
              address?: {
                  city: string;
                  country_code?: string;
                  state: string;
                  street_address1: string;
                  street_address2?: string;
                  zip_code: string;
              };
              counterparty_ach_info?: {
                  account_number?: string;
                  account_type?: "CHECKING"
                  | "SAVING"
                  | "GL";
                  routing_number?: string;
              };
              counterparty_rtp_info?: {
                  account_number?: string;
                  routing_number?: string;
              };
              counterparty_wire_info?: {
                  account_number?: string;
                  address_on_account?: {
                      city: string;
                      country_code?: string;
                      state: string;
                      street_address1: string;
                      street_address2?: string;
                      zip_code: string;
                  };
                  bank_address?: {
                      city: string;
                      country_code?: string;
                      state: string;
                      street_address1: string;
                      street_address2?: string;
                      zip_code: string;
                  };
                  bank_name?: string;
                  intermediary_bank_name?: string;
                  intermediary_bank_routing_number?: string;
                  routing_number?: string;
              };
              created_at?: number;
              description?: string;
              updated_at?: number;
              victor_counterparty_id?: string;
          },
      >

    • Parameters

      • args: { routingNumber: string }

      Returns Promise<
          {
              bank_name?: string;
              fed_now?: {
                  enabled?: boolean;
                  services_available?: {
                      request_for_payment?: boolean;
                      send_payment?: boolean;
                  };
              };
              routing_number?: unknown;
              rtp?: {
                  enabled?: boolean;
                  services_available?: {
                      credit_request?: boolean;
                      request_for_payment?: boolean;
                      request_refund?: boolean;
                      send_payment?: boolean;
                  };
              };
          },
      >

    • Parameters

      • __namedParameters: {
            data: Partial<
                {
                    accountNumber: string;
                    accountType: "CHECKING"
                    | "SAVING";
                    nameOnAccount: string;
                    routingNumber: string;
                },
            >;
            victorCounterpartyId: string;
        }

      Returns Promise<
          {
              account_name?: string;
              address?: {
                  city: string;
                  country_code?: string;
                  state: string;
                  street_address1: string;
                  street_address2?: string;
                  zip_code: string;
              };
              counterparty_ach_info?: {
                  account_number?: string;
                  account_type?: "CHECKING"
                  | "SAVING"
                  | "GL";
                  routing_number?: string;
              };
              counterparty_rtp_info?: {
                  account_number?: string;
                  routing_number?: string;
              };
              counterparty_wire_info?: {
                  account_number?: string;
                  address_on_account?: {
                      city: string;
                      country_code?: string;
                      state: string;
                      street_address1: string;
                      street_address2?: string;
                      zip_code: string;
                  };
                  bank_address?: {
                      city: string;
                      country_code?: string;
                      state: string;
                      street_address1: string;
                      street_address2?: string;
                      zip_code: string;
                  };
                  bank_name?: string;
                  intermediary_bank_name?: string;
                  intermediary_bank_routing_number?: string;
                  routing_number?: string;
              };
              created_at?: number;
              description?: string;
              updated_at?: number;
              victor_counterparty_id?: string;
          },
      >

    • Parameters

      • __namedParameters: {
            data: Partial<
                { accountNumber: string; nameOnAccount: string; routingNumber: string },
            >;
            victorCounterpartyId: string;
        }

      Returns Promise<
          {
              account_name?: string;
              address?: {
                  city: string;
                  country_code?: string;
                  state: string;
                  street_address1: string;
                  street_address2?: string;
                  zip_code: string;
              };
              counterparty_ach_info?: {
                  account_number?: string;
                  account_type?: "CHECKING"
                  | "SAVING"
                  | "GL";
                  routing_number?: string;
              };
              counterparty_rtp_info?: {
                  account_number?: string;
                  routing_number?: string;
              };
              counterparty_wire_info?: {
                  account_number?: string;
                  address_on_account?: {
                      city: string;
                      country_code?: string;
                      state: string;
                      street_address1: string;
                      street_address2?: string;
                      zip_code: string;
                  };
                  bank_address?: {
                      city: string;
                      country_code?: string;
                      state: string;
                      street_address1: string;
                      street_address2?: string;
                      zip_code: string;
                  };
                  bank_name?: string;
                  intermediary_bank_name?: string;
                  intermediary_bank_routing_number?: string;
                  routing_number?: string;
              };
              created_at?: number;
              description?: string;
              updated_at?: number;
              victor_counterparty_id?: string;
          },
      >

    • Parameters

      • __namedParameters: {
            data: Partial<
                {
                    accountNumber: string;
                    addressOnAccount: {
                        city: string;
                        countryCode: string;
                        line1: string;
                        line2?: string;
                        postalCode: string;
                        region: string;
                    };
                    bankAddress: {
                        city: string;
                        line1: string;
                        postalCode: string;
                        state: string;
                    };
                    bankName: string;
                    nameOnAccount: string;
                    routingNumber: string;
                },
            >;
            victorCounterpartyId: string;
        }

      Returns Promise<
          {
              account_name?: string;
              address?: {
                  city: string;
                  country_code?: string;
                  state: string;
                  street_address1: string;
                  street_address2?: string;
                  zip_code: string;
              };
              counterparty_ach_info?: {
                  account_number?: string;
                  account_type?: "CHECKING"
                  | "SAVING"
                  | "GL";
                  routing_number?: string;
              };
              counterparty_rtp_info?: {
                  account_number?: string;
                  routing_number?: string;
              };
              counterparty_wire_info?: {
                  account_number?: string;
                  address_on_account?: {
                      city: string;
                      country_code?: string;
                      state: string;
                      street_address1: string;
                      street_address2?: string;
                      zip_code: string;
                  };
                  bank_address?: {
                      city: string;
                      country_code?: string;
                      state: string;
                      street_address1: string;
                      street_address2?: string;
                      zip_code: string;
                  };
                  bank_name?: string;
                  intermediary_bank_name?: string;
                  intermediary_bank_routing_number?: string;
                  routing_number?: string;
              };
              created_at?: number;
              description?: string;
              updated_at?: number;
              victor_counterparty_id?: string;
          },
      >