v1

latestOpenAPI 3.1.02026-07-26457177.8 KB
Instant Payment Eligibility

Get Account Routing Number Instant Payment Eligibility

📘

You can place your application's client_id into the username field, and your client_secret into the password form field of the Authentication section of this documentation 👉.

Use this endpoint to check if an account is eligible for instant payments.

get/v1/instant-payment-eligibility

Query parameters

routing_numberstring

The routing number of the account

institution_routing_numberstring

The institution routing number

participant_idstring

Identification number assigned to a participant in the payment network

cursor_idstring

The pagination cursor ID. When specified, allows one to navigate between pages. If not specified the first page of results will be returned.

page_sizeinteger

The maximum number of items returned with each request. Defaults to 25 if not specified.

Response

Successfully retrieved instant payment eligibility information

countinteger

Total number of results returned

has_next_pageboolean

Indicates if there are additional results available

next_cursor_idstring

Cursor identifier to retrieve the next page of results