Overview

Orum's Instant Rail Eligibility endpoint can be used to determine whether a bank account is RTP or FedNow eligible in two different ways:

1. Using a POST request, you can determine whether one or more routing numbers (up to 1,000 per API request) are eligible to receive instant RTP or FedNow payments
2. Using a GET request, you can collect the entire list of RTP and FedNow eligible routing numbers in one API call

Using the Instant Rail Eligibility Endpoint

Knowing whether your customers are RTP/FedNow eligible allows you to tailor their payment experiences in your web or mobile application. This endpoint can be called at any point in your user flow, such as when a user onboard or when they want to withdraw money from your platform. You can also store the information received in the response.

When a user begins a withdrawal, disbursement, or payout process, you can call the Instant Rail Eligibility endpoint to determine if that user’s bank account is eligible for instant payouts. If the routing number is eligible, you can consider offering an "instant withdrawal" option.

Additionally, if you have a list of routing numbers representative of your user base, you can call the API to help gauge what percentage of users are eligible for one of the instant rails.

Orum keeps track of which routing numbers are eligible for RTP and FedNow, so you do not have to maintain an eligibility list on your end.

Testing

Sandbox

For both the POST and GET requests, the responses that you receive in sandbox will be accurate representations of production responses.The endpoint can be called at any point during your user journey, as it is not dependent on creating an account, person, or business.

In sandbox, when you are testing the POST request, we recommend testing with these routing numbers to mimic the potential responses that you might receive in production:

Errors

For the POST request, the following errors are possible:

Example

POST Request Body:

{
    "routing_numbers": ["011000138","011000206","555555555"]
}

POST Response Body:

{
   "routing_numbers":[
       {
           "routing_number": "011000138",
           "eligible": true
       },
       {
           "routing_number": "011000206",
           "eligible": true
       },
       {
           "routing_number": "555555555",
           "eligible": false
       },
   ]
}

GET cURL:

curl --location 'http://api.orum.io/deliver/eligibility' \
--header 'Authorization: ••••••' \
--data ''

GET Response Body:

{
    "011000138": {
        "fed_now": false,
        "rtp": true
    },
    "011000206": {
        "fed_now": false,
        "rtp": true
    },
    "011000390": {
        "fed_now": false,
        "rtp": true
    },
    "011001234": {
        "fed_now": true,
        "rtp": true
    },
}