REST Method: |
https://catweb.sba.gov/rest/fta/LoanList/ |
SOAP Method: |
https://catweb.sba.gov/ftadistapps/1502gateway/ws/LoanListWS.wsdl
|
Keys of the Input Structure: |
CLSUsername |
Mandatory. CLS login’s username with update permissions in FTA Portal. |
CLSPassword |
Mandatory. CLS login’s password with update permissions in FTA Portal. |
CLSPIN |
Mandatory. PIN generated by Generate_PIN using the same login. |
SoftwareVendorCode |
Mandatory. A private code that authorizes use of SoftwareVendorName. |
SoftwareVendorName |
Mandatory. Value from Code Tables, Vendor Table. |
FormatIn |
Optional. Format of RequestData, if any. XML or JSON. See Format IN/OUT Defaults |
FormatOut |
Optional.“xml” is for XML return format and “json” is for JSON return format. |
ServiceNme |
Mandatory. LoanHeader, LoanPayment, Balance (only one option allowed) |
LoanList |
Mandatory. See Below for requirements based on ServiceNme chosen |
|
LoanHeader (single value). Accepted Type: integer |
|
LoanPayment (single value). Accepted Type: integer |
|
Balance (multiple values comma delimited). Accepted Type: integer |
PasswordUpdateRequired |
Accepted Type: “Yes”, “No” |
Keys of the Output Structure: |
ResponseData |
XML or JSON determined with data type submitted. |
ErrorMessageEnglish |
Should be nullstring. If not, a generally-worded error message. |
ErrorMessageTechnical |
Should be nullstring. If not, a more helpful error message, but scarier to some users. |
PasswordUpdateRequired |
“Yes”, “No”. Indicate if this user needs to update the password |
ServiceNme: LoanHeader |
|
GPNUMBER returned type: STRING |
|
NOTEDATE returned type: DATE |
|
MATURITYDATE returned type: DATE |
|
FLOATDATE returned type: DATE |
|
SETTLEDATE returned type: DATE |
|
PAYMENTFREQ returned type: STRING |
|
NETRATEPCT returned type: DECIMAL |
|
ORIGINATORPCT returned type: DECIMAL |
|
FTAFEEPCT returned type: DECIMAL |
|
PREPAYNOTICE returned type: STRING |
|
STATUS returned type: INTEGER |
|
FLOORPCT returned type: DECIMAL |
|
CAPPCT returned type: DECIMAL |
|
SPREADPCT returned type: DECIMAL |
|
BASIS returned type: DECIMAL |
|
GROSSRATEPCT returned type: DECIMAL |
|
LENDERFEEPCT returned type: DECIMAL |
|
SBAFEEPCT returned type: DECIMAL |
|
ORIGFACEAMTOFCERT returned type: DECIMAL |
|
ADJUSTMENTFREQUENCY returned type: STRING |
|
POSTEDASOF returned type: DATE |
|
ERRORCODE returned type: INTEGER |
|
COMMENTS returned type: STRING |
ServiceNme: LoanPayment |
|
GPNUMBER returned type: STRING |
|
OUTSTANDINGBALANCE returned type: DECIMAL |
|
INTFORMDATE returned type: STRING |
|
INTTODATE returned type: STRING |
|
NUMBEROFDAYS returned type: INTEGER |
|
PRINCIPALPAYMENT returned type: DECIMAL |
|
INTERESTPAYMENT returned type: DECIMAL |
|
TOTALPAYMENT returned type: DECIMAL |
|
ORIGINTFEE returned type: DECIMAL |
|
ERRORCODE returned type: INTEGER |
|
COMMENTS returned type: STRING |
ServiceNme: Balance |
|
SBALOANNO returned type: STRING |
|
INTERESTPAIDTODATE returned type: STRING |
|
CLOSINGBALANCEAMT returned type: DECIMAL |
|
LENDERPCT returned type: DECIMAL |
|
ERRORCODE returned type: INTEGER |
|
ERRORMESSAGE returned type: STRING |