Overview
The JH PayCenter Routing Number Eligibility API enables Financial Institutions (FIs) and their partners to verify routing number eligibility across supported instant payment networks. This helps ensure accurate payment routing and prevents failures during payment initiation.
1. Routing Number Eligibility API
This API allows FIs and their partners to identify which payment networks support a specific routing number before sending a payment.
Workflow
- A GET API request is sent with the required query parameters along with authorization.
- The API validates the incoming request parameters.
- The system performs an eligibility lookup based on the provided parameters:
- If only the routingnumber query parameter is provided, the API returns all supported networks and their associated payment capabilities.
- If both routingnumber and network query parameters are provided, the API returns eligibility details for the specified network.
- If the routing number is eligible, detailed information is returned.
- If validation or lookup fails, the API returns an error response with appropriate error codes.
Parameters
| Parameter | Type | Description | Max Len | Req/Opt | Location |
|---|---|---|---|---|---|
| routingnumber | String | The routing number to validate | 9 | Required | Query |
| network | String | Network name (e.g., FedNow, RTP) | 20 | Optional | Query |
Success Response Fields
| Fields | Type | Description | Path |
|---|---|---|---|
| Name | String | Financial Institution name | FinancialInstitutions[].Name |
| Name | String | Network name (e.g., FedNow, RTP) | FinancialInstitutions[].Networks[].Name |
| RoutingNumber | String | The routing number | FinancialInstitutions[].Networks[].RoutingNumbers[].RoutingNumber |
| IsActive | Boolean | Indicates whether the routing number is active | FinancialInstitutions[].Networks[].RoutingNumbers[].IsActive |
| Type | String | Service type (e.g., CRDT, RFP) | FinancialInstitutions[].Networks[].RoutingNumbers[].Services[].Type |
| Description | String | Service description | FinancialInstitutions[].Networks[].RoutingNumbers[].Services[].Description |
| IsEnabled | Boolean | Indicates whether the service is enabled | FinancialInstitutions[].Networks[].RoutingNumbers[].Services[].IsEnabled |
NOTE
- The routingnumber parameter must be a valid 9-digit number.
- Supported network values are FedNow and RTP.
- The API returns eligibility only for networks currently supported by PayCenter.
- Service Types returned in the response:
- CRDT – Indicates the FI is enabled to receive Credit Transfers.
- RFP – Indicates the FI is enabled to receive Requests for Payment.
- Refer to the API Reference for full specifications and testing.