Package io.moov.sdk

Class Institutions

java.lang.Object

io.moov.sdk.Institutions

public class Institutions
extends java.lang.Object

Method Summary

Modifier and Type	Method	Description
ListInstitutionsRequestBuilder	search()	Search for institutions by either their name or routing number.
ListInstitutionsResponse	search(java.util.Optional<java.lang.String> name, java.util.Optional<java.lang.String> routingNumber, java.util.Optional<java.lang.String> state, java.util.Optional<java.lang.Long> limit)	Search for institutions by either their name or routing number.
ListInstitutionsResponse	searchDirect()	Search for institutions by either their name or routing number.
SearchInstitutionsRequestBuilder	searchInstitutions()	Search for financial institutions by name or routing number.
SearchInstitutionsResponse	searchInstitutions(java.util.Optional<java.lang.String> name, java.util.Optional<java.lang.String> routingNumber, java.util.Optional<java.lang.Long> limit)	Search for financial institutions by name or routing number.
SearchInstitutionsResponse	searchInstitutionsDirect()	Search for financial institutions by name or routing number.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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> 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.

Parameters:

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

searchDirect

public ListInstitutionsResponse searchDirect()
                                      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.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

search

public ListInstitutionsResponse search(java.util.Optional<java.lang.String> name,
                                       java.util.Optional<java.lang.String> routingNumber,
                                       java.util.Optional<java.lang.String> state,
                                       java.util.Optional<java.lang.Long> limit)
                                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.

Parameters:

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.

state - The state where a financial institution is based.

limit - Maximum results returned by a search.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails