Query the directory
In this tutorial, you'll learn how to:
✅ See which Instant Payments receive services are available to the creditor banks from either TCH or FedNow.
If you are new to Instant Payments we recommend you read the Instant Payments overview before starting this tutorial
The tutorial assumes you have a knowledge of APIs and how they work. Refer to the API overview page for more details
The tutorial uses this API endpoint:
API | Description |
Returns the Instant Payments receive services available |
Make sure you have:
For FedNow, an FI must register each RTN separately. An FI can have some but not all RTNs registered for FedNow.
In this tutorial you will investigate which services are available for City National Bank. The call returns a list of service codes. If the bank supports both TCH and FedNow Instant Payments, the call returns service codes for each network.
Call GET /rtp/v1/directory?{queryParam}={queryParamValue} . For this call, include at least one query parameter to control the data returned. The possible query parameters available for this call are:
| |
filter.name | The official name for the FI |
filter. routingNumber | The routing number of the specific account the money is going to (Best practice is to filter on this value) |
filter.participantId | The participant ID of the FI |
filter.institutionRoutingNumber | The routing number of the FI |
In this case, enter the routing number 021000021 either as the routingNumber or as the institutionRoutingNumber.
A successful API call returns a JSON response with the codes indicating the Instant Payments services supported by routing number 021000021, associated with Chase bank, listed in the receiveServices object. The networkPlatform attribute indicates the Instant Payments network. If the bank is a member of both networks, the response includes a separate list of services for each network.
Although a financial institution may list a specific service, it does not guarantee that the creditor/debtor account at that financial institution is eligible for that service.
Available Instant Payments services for TCH
Receive Service | Description |
ACK | Acknowledgment message |
CRDT | Credit transfer |
RFI | Request for information |
RFIR | Request for information response |
RMT | Remittance message |
Available Instant Payments services for FedNow
Receive Service | Description |
ACK | Acknowledgment message |
CTRO | Credit transfer receive only |
CTSR | Credit transfer send and receive |
RFI | Request for information |
RFIR | Request for information response |
RMT | Remittance message |