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

    Class SwiftCodesValidationClient

    Client for validating various bank wire routing codes and identifiers.

    const client = new BankRoutingCodeValidationClient({
      baseUrl: 'https://swiftcodesapi.com/v1',
      apiKey: 'your-api-key'
    });
    Index

    Constructors

    constructor

    Methods

    getBic getBsb getClabe getCrn getIban getIfsc getNcc

    Constructors

    Methods

    • Retrieves BIC (Bank Identifier Code) / SWIFT code information

      Parameters

      • params: { bic: string }

        The parameters object

        • bic: string

          The BIC/SWIFT code to validate

      Returns Promise<
          | {
              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,
      >

      The BIC information if successful, null otherwise

    • Retrieves BSB (Bank State Branch) information for Australian banks

      Parameters

      • params: { bsb: string }

        The parameters object

        • bsb: string

          The BSB code to validate

      Returns Promise<
          | {
              address?: string;
              bank?: { code?: string; country_id?: string; id?: string; name?: string };
              branch_name?: string;
              id?: string;
              peh?: string;
              postcode?: string;
              state?: string;
              suburb?: string;
          }
          | null,
      >

      The BSB information if successful, null otherwise

    • Retrieves CLABE (Clave Bancaria Estandarizada - Standardized Banking Code) information

      Parameters

      • params: { clabe: string }

        The parameters object

        • clabe: string

          The CLABE code to validate

      Returns Promise<
          | {
              account_number?: string;
              bank?: { code?: string; country_id?: string; id?: string; name?: string };
              cities?: { country_id?: string; id?: string; name?: string }[];
              city_code?: string;
              id?: string;
          }
          | null,
      >

      The CLABE information if successful, null otherwise

    • Retrieves CRN (Canadian Routing Number) information

      Parameters

      • params: { crn: string }

        The parameters object

        • crn: string

          The CRN code to validate

      Returns Promise<
          | {
              address?: string;
              bank?: { code?: string; country_id?: string; id?: string; name?: string };
              branch_name?: string;
              city?: string;
              id?: string;
              institution_type?: number;
              postcode?: string;
              province?: string;
          }
          | null,
      >

      The CRN information if successful, null otherwise

    • Retrieves IBAN (International Bank Account Number) information

      Parameters

      • params: { iban: string }

        The parameters object

        • iban: string

          The IBAN to validate

      Returns Promise<
          | {
              account_number?: string;
              country?: { id?: string; name?: string };
              id?: string;
              national_bank_code?: string;
              national_branch_code?: string;
              swift?: {
                  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,
      >

      The IBAN information if successful, null otherwise

    • Retrieves IFSC (Indian Financial System Code) information

      Parameters

      • params: { ifsc: string }

        The parameters object

        • ifsc: string

          The IFSC code to validate

      Returns Promise<
          | {
              address?: string;
              bank?: { code?: string; country_id?: string; id?: string; name?: string };
              branch_code?: string;
              branch_name?: string;
              city?: string;
              district?: string;
              id?: string;
              phone?: string;
              state?: string;
              std?: string;
          }
          | null,
      >

      The IFSC information if successful, null otherwise

    • Retrieves NCC (National Clearing Code) information

      Parameters

      • params: { ncc: string }

        The parameters object

        • ncc: string

          The NCC code to validate

      Returns Promise<
          | {
              address?: string;
              bank?: { code?: string; country_id?: string; id?: string; name?: string };
              branch_code?: string;
              branch_name?: string;
              city?: string;
              fax?: string;
              id?: string;
              phone?: string;
              pob_location?: string;
              pob_number?: string;
              pob_postcode?: string;
              postcode?: string;
              std?: string;
          }
          | null,
      >

      The NCC information if successful, null otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods