Sign in

v1

latestOpenAPI 3.0.12026-07-26106359429.8 KB
Instant Payments

Check instant payment availability

Check if a given routing number is eligible to receive an instant payment.

post/v1/instant_payments/check_availability

Request body

routing_numberstring required

The routing number of the financial institution where the creditor (payee) holds their account.

Example request

{
  "routing_number": "111000111"
}

Response

Availability check result.

availableboolean required

Whether the financial institution is available to receive instant payments.

routing_numberstring required

The routing number that was checked.

Example response

{
  "available": true,
  "routing_number": "111000111"
}