Package io.moov.sdk

Class Institutions

    • Method Detail

      • searchInstitutions

        public SearchInstitutionsRequestBuilder searchInstitutions()
        Search for financial institutions by name or routing number.

        This endpoint returns metadata about each matched institution, including basic identifying details (such as name, routing number, and address) and information about which payment services they support (e.g., ACH, RTP, and Wire).

        This can be used to validate a financial institution before initiating payment activity, or to check which payment rails are available for a given routing number.

        To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/institutions.read` scope.

        Returns:
        The call builder

      • searchInstitutionsDirect

        public SearchInstitutionsResponse searchInstitutionsDirect()
                                                    throws java.lang.Exception
        Search for financial institutions by name or routing number.

        This endpoint returns metadata about each matched institution, including basic identifying details (such as name, routing number, and address) and information about which payment services they support (e.g., ACH, RTP, and Wire).

        This can be used to validate a financial institution before initiating payment activity, or to check which payment rails are available for a given routing number.

        To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/institutions.read` scope.

        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails

      • searchInstitutions

        public SearchInstitutionsResponse searchInstitutions​(java.util.Optional<java.lang.String> xMoovVersion,
                                                     java.util.Optional<java.lang.String> name,
                                                     java.util.Optional<java.lang.String> routingNumber,
                                                     java.util.Optional<java.lang.Long> limit)
                                              throws java.lang.Exception
        Search for financial institutions by name or routing number.

        This endpoint returns metadata about each matched institution, including basic identifying details (such as name, routing number, and address) and information about which payment services they support (e.g., ACH, RTP, and Wire).

        This can be used to validate a financial institution before initiating payment activity, or to check which payment rails are available for a given routing number.

        To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/institutions.read` scope.

        Specified by:
        searchInstitutions in interface SDKMethodInterfaces.MethodCallSearchInstitutions
        Parameters:
        xMoovVersion - Specify an API version. API versioning follows the format `vYYYY.QQ.BB`, where - `YYYY` is the year - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10) - `BB` is the build number, starting at `.01`, for subsequent builds in the same quarter. - For example, `v2024.01.00` is the initial release of the first quarter of 2024. The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.
        name - Name of the financial institution. Either `name` or `routingNumber` is required.
        routingNumber - Routing number for a financial institution. Either `routingNumber` or `name` is required.
        limit - Maximum results returned by a search.
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails

      • search

        public ListInstitutionsRequestBuilder search()
        Search for institutions by either their name or routing number.

        To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/fed.read` scope.

        Returns:
        The call builder

      • search

        public ListInstitutionsResponse search​(ListInstitutionsRequest request)
                                throws java.lang.Exception
        Search for institutions by either their name or routing number.

        To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/fed.read` scope.

        Specified by:
        search in interface SDKMethodInterfaces.MethodCallListInstitutions
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails