Overview

With Orum's Instant Rail Eligibility endpoint, you can find out whether one or more routing numbers are eligible to receive instant RTP push payments. The endpoint can be leveraged to check the RTP eligibility status of up to 1,000 routing numbers per API request.

Using the Instant Rail Eligibility Endpoint

Knowing whether your customers are RTP 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 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 (via RTP). 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 RTP eligible and will, therefore, benefit from faster payments.

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

Testing

Sandbox

The Instant Rail Eligibility endpoint works similarly in sandbox to how it works in production. 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, we recommend testing with these routing numbers to mimic the potential responses that you might receive in production:

Production

Many customers like to conduct production testing before going live. If you want to know which accounts you are testing with have eligible RTP routing numbers, call this endpoint to determine which accounts will be best suited to test RTP transfers.

Errors

Example

Request Body:

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

Response Body:

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