- 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
you'll need to specify the /institutions.read scope.
search- This endpoint has been deprecated and will be removed in a future release. Use /institutions.
Search for institutions by either their name or routing number.
To access this endpoint using an access token
you'll need to specify the /fed.read scope.
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
you'll need to specify the /institutions.read scope.
package hello.world;
import io.moov.sdk.Moov;
import io.moov.sdk.models.components.Security;
import io.moov.sdk.models.operations.SearchInstitutionsResponse;
import java.lang.Exception;
public class Application {
public static void main(String[] args) throws Exception {
Moov sdk = Moov.builder()
.security(Security.builder()
.username("")
.password("")
.build())
.build();
SearchInstitutionsResponse res = sdk.institutions().searchInstitutions()
.call();
if (res.institutionsSearchResponse().isPresent()) {
System.out.println(res.institutionsSearchResponse().get());
}
}
}| Parameter | Type | Required | Description |
|---|---|---|---|
name |
Optional<String> | ➖ | Name of the financial institution. Either name or routingNumber is required. |
routingNumber |
Optional<String> | ➖ | Routing number for a financial institution. Either routingNumber or name is required. |
limit |
Optional<Long> | ➖ | Maximum results returned by a search. |
| Error Type | Status Code | Content Type |
|---|---|---|
| models/errors/APIException | 4XX, 5XX | */* |
This endpoint has been deprecated and will be removed in a future release. Use /institutions.
Search for institutions by either their name or routing number.
To access this endpoint using an access token
you'll need to specify the /fed.read scope.
⚠️ DEPRECATED: This will be removed in a future release, please migrate away from it as soon as possible.
package hello.world;
import io.moov.sdk.Moov;
import io.moov.sdk.models.components.Security;
import io.moov.sdk.models.errors.GenericError;
import io.moov.sdk.models.operations.ListInstitutionsResponse;
import java.lang.Exception;
public class Application {
public static void main(String[] args) throws GenericError, Exception {
Moov sdk = Moov.builder()
.security(Security.builder()
.username("")
.password("")
.build())
.build();
ListInstitutionsResponse res = sdk.institutions().search()
.call();
if (res.financialInstitutions().isPresent()) {
System.out.println(res.financialInstitutions().get());
}
}
}| Parameter | Type | Required | Description |
|---|---|---|---|
name |
Optional<String> | ➖ | Name of the financial institution. Either name or routingNumber is required. |
routingNumber |
Optional<String> | ➖ | Routing number for a financial institution. Either routingNumber or name is required. |
state |
Optional<String> | ➖ | The state where a financial institution is based. |
limit |
Optional<Long> | ➖ | Maximum results returned by a search. |
| Error Type | Status Code | Content Type |
|---|---|---|
| models/errors/GenericError | 400 | application/json |
| models/errors/APIException | 4XX, 5XX | */* |