Class SwiftBicDirService

constructor

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

  Parameters

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

  Returns SwiftBicDirService

Staticinstance

getBic

• getBic(
      __namedParameters: { bic: string },
  ): Promise<
      {
          ok: true;
          value: | {
              address?: string;
              bank?: { code?: string; country_id?: string; id?: string; name?: string };
              branch_code?: string;
              branch_name?: string;
              city?: { country_id?: string; id?: string; name?: string };
              country?: { id?: string; name?: string };
              id?: string;
              postcode?: string;
          }
          | null;
      },
  >

  Look up SWIFT/BIC bank info, cached. Returns null when the code is unknown or malformed (cached as a negative result). A fault (network, an upstream outage) propagates as a thrown error.

  Parameters

  • __namedParameters: { bic: string }

  Returns Promise<
      {
          ok: true;
          value: | {
              address?: string;
              bank?: { code?: string; country_id?: string; id?: string; name?: string };
              branch_code?: string;
              branch_name?: string;
              city?: { country_id?: string; id?: string; name?: string };
              country?: { id?: string; name?: string };
              id?: string;
              postcode?: string;
          }
          | null;
      },
  >