Class PayCenterFinancialInstitutionsAPIResponse

---

Response entity fields

Parameter	TYPE	Description
FinancialInstitutions		Array of financial institutions.
Paging		Pagination object. Provides pagination details for current request.
Links		Links object. Provides previous / next page links for current request.

Financial Institution object fields

Parameter	TYPE	Description
FinancialInstitutions	Integer	Unique PayCenter financial institution id
ParticipantId	String	Participant Id on the RTP network
FinancialInstitutionName	string	Name of the financial institution
RoutingNumbers		Array of routing numbers

Routing Number object fields

Parameter	TYPE	Description
RoutingNumber	String	RTN number.
ReceivingConnection	String	Name of the connection where routing number associated with in RTP network.
isActive	Boolean	Status of the routing number. (determined by the following conditions:- Respective FI must be signed on RTP network (AND) Respective connection must be available (AND) RTP network must be available)
isJHA	Boolean	Denotes whether the connection belongs to JHA.
Services		Array of service object. Enabled & disabled list of services for the current routing number.

Service object fields

Parameter	TYPE	Description
Type	String	Type of service. (possible values are:- (any of the below) CRDT RFP ACK RMT RFI RFRF RFPR RFIR RFRFR)
Description	String	Description of the service
isEnabled	Boolean	Denotes whether the service is enable for the routing number

Paging object fields

Parameter	TYPE	Description
Results	Integer	Number of financial institutions in the current page. (default number of items per page is: 50)
Total	Integer	Total number of financial institutions in the Paycenter RTP network
NextOffset	Integer	Current page number

Links object fields

Parameter	TYPE	Description
Prev	String	Previous page link
Next	String	Next page link

Failure Response - Response entity and it's object fields

Parameter	TYPE	Description
Message	String	Type of error message. (Validation failed / execution failed).
Code	String	Error code
Description	String	Error description

Successful Response – 1 (all financial institutions details)

{
    "FinancialInstitutions": [
        {
            "Id": integer,
            "ParticipantId": string,
            "FinancialInstitutionName": string,
            "RoutingNumbers": [
                {
                    "RoutingNumber": string,
                    "ReceivingConnection": string,
                    "isActive": boolean,
                    "isJHA": boolean,
                    "Services": [
                        {
                            "Type": string,
                            "Description": string,
                            "isEnabled": boolean
                        }
                    ]
                }
            ]
        }
    ],
    "Paging": {
        "Results": integer,
        "Total": integer,
        "NextOffset": integer
    },
    "links": {
        "prev": string,
        "next": string
    }
}

Successful Response – 2 (financial institution details by Routing Number or Participant Id)

{
    "FinancialInstitutions": [
        {
            "Id": integer,
            "ParticipantId": string,
            "FinancialInstitutionName": string,
            "RoutingNumbers": [
                {
                    "RoutingNumber": string,
                    "ReceivingConnection": string,
                    "isActive": boolean,
                    "isJHA": boolean,
                    "Services": [
                        {
                            "Type": string,
                            "Description": string,
                            "isEnabled": boolean
                        }
                    ]
                }
            ]
        }
    ],
    "Paging": {
        "Results": integer,
        "Total": integer,
        "NextOffset": integer
    },
    "links": {
        "prev": string,
        "next": string
    }
}

Response 1: Sample

{
  "FinancialInstitutions": [
    {
      "Id": 3,
      "ParticipantId": "800000001T1",
      "FinancialInstitutionName": "JHA Episys Certification CU ",
      "RoutingNumbers": [
        {
          "RoutingNumber": "800000001",
          "ReceivingConnection": "JHA",
          "isActive": true,
          "isJHA": true,
          "Services": [
            {
              "Type": "ACK",
              "Description": "Permits receipt of Payment Acknowledgement camt.035",
              "isEnabled": true
            },
            {
              "Type": "CRDT",
              "Description": "Permits receipt of Credit Transfer pacs.008",
              "isEnabled": true
            },
            {
              "Type": "RFI",
              "Description": "Permits receipt of Request for Information camt.026",
              "isEnabled": true
            },
            {
              "Type": "RFIR",
              "Description": "Permits receipt of Request for Information Response camt.028",
              "isEnabled": true
            },
            {
              "Type": "RFP",
              "Description": "Permits receipt of Request for Payment pain.013",
              "isEnabled": true
            },
            {
              "Type": "RFPR",
              "Description": "Permits receipt of Request for Payment Response pain.014",
              "isEnabled": false
            },
            {
              "Type": "RFRF",
              "Description": "Permits receipt of Request for Return of Funds camt.056",
              "isEnabled": true
            },
            {
              "Type": "RFRFR",
              "Description": "Permits receipt of Request for Return of Funds Response camt.029",
              "isEnabled": false
            },
            {
              "Type": "RMT",
              "Description": "Permits receipt of Remittance Advice remt.001",
              "isEnabled": true
            }
          ]
        }
      ]
    }
  ],
  "Paging": {
    "Results": 1,
    "Total": 1,
    "NextOffset": 0
  },
  "links": {
    "prev": "",
    "next": ""
  }
}

Response 2: Sample

{
  "FinancialInstitutions": [
    {
      "Id": 3,
      "ParticipantId": "800000001T1",
      "FinancialInstitutionName": "JHA Episys Certification CU ",
      "RoutingNumbers": [
        {
          "RoutingNumber": "800000001",
          "ReceivingConnection": "JHA",
          "isActive": true,
          "isJHA": true,
          "Services": [
            {
              "Type": "ACK",
              "Description": "Permits receipt of Payment Acknowledgement camt.035",
              "isEnabled": true
            },
            {
              "Type": "CRDT",
              "Description": "Permits receipt of Credit Transfer pacs.008",
              "isEnabled": true
            },
            {
              "Type": "RFI",
              "Description": "Permits receipt of Request for Information camt.026",
              "isEnabled": true
            },
            {
              "Type": "RFIR",
              "Description": "Permits receipt of Request for Information Response camt.028",
              "isEnabled": true
            },
            {
              "Type": "RFP",
              "Description": "Permits receipt of Request for Payment pain.013",
              "isEnabled": true
            },
            {
              "Type": "RFPR",
              "Description": "Permits receipt of Request for Payment Response pain.014",
              "isEnabled": false
            },
            {
              "Type": "RFRF",
              "Description": "Permits receipt of Request for Return of Funds camt.056",
              "isEnabled": true
            },
            {
              "Type": "RFRFR",
              "Description": "Permits receipt of Request for Return of Funds Response camt.029",
              "isEnabled": false
            },
            {
              "Type": "RMT",
              "Description": "Permits receipt of Remittance Advice remt.001",
              "isEnabled": true
            }
          ]
        }
      ]
    }
  ],
  "Paging": {
    "Results": 1,
    "Total": 1,
    "NextOffset": 0
  },
  "links": {
    "prev": "",
    "next": ""
  }
}

Failure Response

{
	"message": string,
	"Error": {
		"Code": string,
		"Description": string
		}
}

Error Response Sample

{
  "message": "Validation Failed",
  "Error": {
    "Code": "ER1000001019",
    "Description": "Invalid Parameter"
  }
}