How to use the RTP directory API

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.

The tutorial uses this API endpoint:

Before you begin

Make sure you have:

• API credentials

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.

a. To access the directory

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:

In this case, enter the routing number 021000021 either as the routingNumber or as the institutionRoutingNumber.

1
2
3
4
5
curl -X GET /rtp/v1/directory

'https://sandbox.crbcos.com/Rtp/v1/directory?filter.routingNumber=021000021'

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.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
{
      "networkPlatform": "TCH",
      "routingNumber": "021000021",
      "participantId": "200000020T1",
      "name": "ACI",
      "institutionRoutingNumber": "200000020",
      "institutionName": "ACI",
      "receiveServices": [
        "ACK",
        "CRDT",
        "RFI",
        "RFIR",
        "RFP",
        "RFPR",
        "RFRF",
        "RFRFR",
        "RMT"
      ],
      "receivingConnection": "ACI2",
      "participantActivationDate": "4/30/2019 12:00:00 AM",
      "extractionDateTime": "9/29/2022 7:00:00 AM",
      "lastModifiedAt": "2022-09-29T14:23:01.9180766-04:00",
      "onlineStatus": 1,
      "onlineStatusChangedAt": "2022-09-15T12:22:04.9180766-04:00"
    },
    {
      "networkPlatform": "FedNow",
      "routingNumber": "200000009",
      "participantId": null,
      "name": "ACI",
      "institutionRoutingNumber": null,
      "institutionName": null,
      "receiveServices": [
        "RFPR",
        "CTSR"
      ],
      "receivingConnection": null,
      "participantActivationDate": null,
      "extractionDateTime": null,
      "lastModifiedAt": "2022-09-29T14:23:01.9180766-04:00",
      "onlineStatus": 1,
      "onlineStatusChangedAt": "2022-09-15T12:22:04.9180766-04:00"
    }

Available Instant Payments services for TCH

Available Instant Payments services for FedNow