GET Api/FDI?ActiveOnly={ActiveOnly}&IncludeDeleted={IncludeDeleted}&FDICode={FDICode}&Page={Page}&PageSize={PageSize}
Searches for an existing FDI in the system.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| ActiveOnly |
Search for Active FDI Codes only. True by default. |
boolean? |
None. |
| FDICode |
Search by FDI Code. If nothing is provided, all FDI codes will be returned. |
string |
String length: inclusive between 0 and 20 |
| IncludeDeleted |
Include deleted FDI Codes. False by default. |
boolean? |
None. |
| Page |
Specifies the page to return in the result set. Defaults to 1. |
int? |
None. |
| PageSize |
Specifies the number of records to return per-page. Defaults to 50. |
int? |
None. |
Body Parameters
None.
Response Information
Resource Description
Searches for an existing FDI in the system.
APIFDIListResponseModel| Name | Description | Type | Additional information |
|---|---|---|---|
| ErrorCode |
Name of the error condition. See ErrorCode model for details. |
ErrorCode |
None. |
| ErrorID |
Internal error identification number that uniquely identifies this specific error that occurred. |
string |
None. |
| ErrorNum |
Numeric value of the ErrorCode |
int |
None. |
| Errors |
List of errors that occurred when performing the fdi request. |
Collection of string |
None. |
| Result | APIFDIListModel |
None. |
|
| Success |
Indicates success or failure of the REST request. |
boolean |
None. |
Response Formats
application/json, text/json
{
"ErrorCode": "None",
"ErrorID": "sample string 1",
"ErrorNum": 0,
"Errors": [
"sample string 1",
"sample string 2"
],
"Result": {
"Count": 1,
"Codes": [
{
"Active": true,
"Default": true,
"Deleted": true,
"dtCreate": "2026-06-18T21:50:51.5030106Z",
"dtUpdated": "2026-06-18T21:50:51.5030106Z",
"FDICode": "sample string 6",
"ID": 7,
"RTPDisplayAccountNumber": "sample string 8",
"ACHPassword": "sample string 9",
"ACHURL": "sample string 10",
"ACHUsername": "sample string 11",
"CCClientID": "sample string 12",
"CCMerchantKey": "sample string 13",
"CCURL": "sample string 14",
"CCUsername": "sample string 15",
"CCPassword": "sample string 16",
"ACHCompanyID": "sample string 17",
"ACHCompanyName": "sample string 18",
"DepositoryDDA": "sample string 19",
"Description": "sample string 20",
"DepositoryRoutingNumber": "sample string 21",
"DDAAccountType": 1,
"ElavonBankNumber": "sample string 22",
"PrincipleMID": "sample string 23",
"PaymentConsolidatorMerchantID": "sample string 24",
"PCCompanyID": "sample string 25",
"PCCompanyName": "sample string 26",
"PCDDAAccountType": 1,
"PCDepositoryDDA": "sample string 27",
"PCDepositoryRoutingNumber": "sample string 28",
"RTPClientID": "sample string 29",
"RTPRoutingNumber": "sample string 30",
"RTPUltimateClientKey": "sample string 31",
"RTPAddress": "sample string 32",
"RTPCountry": "sample string 33",
"RTPCity": "sample string 34",
"RTPState": "sample string 35",
"RTPZipCode": "sample string 36"
},
{
"Active": true,
"Default": true,
"Deleted": true,
"dtCreate": "2026-06-18T21:50:51.5030106Z",
"dtUpdated": "2026-06-18T21:50:51.5030106Z",
"FDICode": "sample string 6",
"ID": 7,
"RTPDisplayAccountNumber": "sample string 8",
"ACHPassword": "sample string 9",
"ACHURL": "sample string 10",
"ACHUsername": "sample string 11",
"CCClientID": "sample string 12",
"CCMerchantKey": "sample string 13",
"CCURL": "sample string 14",
"CCUsername": "sample string 15",
"CCPassword": "sample string 16",
"ACHCompanyID": "sample string 17",
"ACHCompanyName": "sample string 18",
"DepositoryDDA": "sample string 19",
"Description": "sample string 20",
"DepositoryRoutingNumber": "sample string 21",
"DDAAccountType": 1,
"ElavonBankNumber": "sample string 22",
"PrincipleMID": "sample string 23",
"PaymentConsolidatorMerchantID": "sample string 24",
"PCCompanyID": "sample string 25",
"PCCompanyName": "sample string 26",
"PCDDAAccountType": 1,
"PCDepositoryDDA": "sample string 27",
"PCDepositoryRoutingNumber": "sample string 28",
"RTPClientID": "sample string 29",
"RTPRoutingNumber": "sample string 30",
"RTPUltimateClientKey": "sample string 31",
"RTPAddress": "sample string 32",
"RTPCountry": "sample string 33",
"RTPCity": "sample string 34",
"RTPState": "sample string 35",
"RTPZipCode": "sample string 36"
}
]
},
"Success": true
}