Skip to main content

PayCenterFinancialInstitutionsAPI

API is used to get all available financial institutions details in the RTP network. This API can also be used with query string parameter to filter financial institutions by Routing Number or Participant ID.

Success Scenario:

  • Send API request with the authorization, headers, and query string parameter (if needed).
  • Query string parameter if any is validated in the business layer.
  • If valid query string parameter, then retrieve and return the financial institution details based on the query string parameter.
  • If no query string parameter found, then retrieve and return all the available financial institutions details.

Failure Scenario 1:

  • Send API request with the authorization, headers, and query string parameter (if needed).
  • Query string parameter if any is validated in the business layer.
  • If invalid query string parameter name / value found, then response with error code & error message.

Failure Scenario 2:

  • Send API request with the authorization, headers, and query string parameter (if needed).
  • Query string parameter if any is validated in the business layer.
  • If any error occurred while processing the request, then response with error code & error message.

Parameters

TYPENAMEDESCRIPTION
PayCenterFinancialInstitutionsAPIRequestrequest

Returns

TYPEDESCRIPTION
PayCenterFinancialInstitutionsAPIResponse