Class SwiftRtnDirService

constructor

• new SwiftRtnDirService(
      args: {
          swiftCodesValidationClient: Pick<SwiftCodesValidationClient, "getRtn">;
          valkeyClient: ValkeyClient | null;
      },
  ): SwiftRtnDirService

  Parameters

  • args: {
        swiftCodesValidationClient: Pick<SwiftCodesValidationClient, "getRtn">;
        valkeyClient: ValkeyClient | null;
    }

  Returns SwiftRtnDirService

Staticinstance

getRtn

• getRtn(
      __namedParameters: { rtn: string },
  ): Promise<
      {
          ok: true;
          value: | {
              ach?: {
                  address?: string;
                  bank?: {
                      code?: string;
                      country_id?: string;
                      id?: string;
                      name?: string;
                  };
                  change_date?: string
                  | null;
                  city?: { country_id?: string; id?: string; name?: string };
                  is_main_office?: boolean;
                  new_id?: string | null;
                  phone?: string;
                  postcode?: string;
                  record_type_code?: number;
                  servicing_frb_id?: string;
              };
              id?: string;
              wire?: {
                  bank?: {
                      code?: string;
                      country_id?: string;
                      id?: string;
                      name?: string;
                  };
                  change_date?: string
                  | null;
                  city?: { country_id?: string; id?: string; name?: string };
                  is_funds_transfer_allowed?: boolean;
                  is_securities_transfer_allowed?: boolean;
                  is_settlement_only?: boolean;
                  telegraphic_name?: string;
              };
          }
          | null;
      },
  >

  Look up US ABA/RTN bank info, cached. Returns null when the routing number is unknown (cached as a negative result). Non-functional errors (network, 5xx, bad credentials) propagate as thrown errors.

  Parameters

  • __namedParameters: { rtn: string }

  Returns Promise<
      {
          ok: true;
          value: | {
              ach?: {
                  address?: string;
                  bank?: {
                      code?: string;
                      country_id?: string;
                      id?: string;
                      name?: string;
                  };
                  change_date?: string
                  | null;
                  city?: { country_id?: string; id?: string; name?: string };
                  is_main_office?: boolean;
                  new_id?: string | null;
                  phone?: string;
                  postcode?: string;
                  record_type_code?: number;
                  servicing_frb_id?: string;
              };
              id?: string;
              wire?: {
                  bank?: {
                      code?: string;
                      country_id?: string;
                      id?: string;
                      name?: string;
                  };
                  change_date?: string
                  | null;
                  city?: { country_id?: string; id?: string; name?: string };
                  is_funds_transfer_allowed?: boolean;
                  is_securities_transfer_allowed?: boolean;
                  is_settlement_only?: boolean;
                  telegraphic_name?: string;
              };
          }
          | null;
      },
  >