Skip to main content
GET
Get payment eligibility
This feature is in Beta and not ready for production integration.

Authorizations

Authorization
string
header
required

Application (M2M) OAuth2 access token (client credentials).

Path Parameters

routingNumber
string
required

The 9-digit ABA (American Bankers Association) routing number of the bank to receive the payment.

Response

Returns the Instant Payment Eligibility.

Which instant payment rails a routing number's bank can receive a credit on.

availableRails
enum<string>[]
required

The rails whose eligibility is ELIGIBLE. Empty when there are none.

An instant payment rail.

Available options:
RTP,
FED_NOW
rails
object[]
required

The answer for each rail, RTP first.

routingNumber
string
required

The routing number looked up.

bankName
null | string

The bank's name as the RTP participant list gives it, else as the FedNow list does. Absent when the routing number is on neither list.