Method Settlement Express 1086/Note

*Loan Doc Packs need to be submitted to SettlementExpress@sba.gov after API successful submission for the FTA to review*
  • API submissions & Loan Doc Packs received prior to 2pm ET will be reviewed the next Business Day.
  • API submissions & Loan Doc Packs received after 2pm ET will be reviewed within 2 Business Days.
  • Settlement Express 1086/Note Web Service attempts to input one or more report(s) in a structured format.

    API Documentation
    REST Method: https://catweb.sba.gov/rest/fta/SettlementsExpress/1086note
    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.
  • PasswordUpdateRequired
  • Accepted Type: “Yes”, “No”
  • Version
  • Mandatory. "1"
  • GPNumber
  • Mandatory type: STRING
  • SBAGuarantyFeePaidOn
  • Optional type: Date, format "mm/dd/yyyy"
  • InitialDisbursementDate
  • Mandatory type: Date, format "mm/dd/yyyy"
  • FinalDisbursementDate
  • Mandatory type: Date, format "mm/dd/yyyy"
  • IntPaidToDate
  • Mandatory type: Date, format "mm/dd/yyyy"
  • GuaranteedFixedVariableRate
  • Mandatory type: "fixed" or "variable"
  • UnGuaranteedFixedVariableRate
  • Mandatory type: "fixed" or "variable"
  • IntAccrualMethod
  • Mandatory type: "30/360" or "Actual/365"
  • PurchaserPriceAmount
  • Mandatory type: Numeric, format 2 decimals
  • PurchaserPricePct
  • Mandatory type: Numeric, format up to 5 decimals
  • LendersInitialFee
  • Optional type: Numeric, format up to 5 decimals
  • LendersPermanentFee
  • Mandatory type: Numeric, format up to 5 decimals
  • CertFixedRate
  • Mandatory if fixed, type: Numeric, format up to 5 decimals
  • CertVariableRate
  • Mandatory if variable, type: Numeric, format up to 5 decimals
  • CertCap
  • Mandatory if variable, type: Numeric, format up to 5 decimals
  • CertFloor
  • Mandatory if variable, type: Numeric, format up to 5 decimals
  • ConstantPrepayRate
  • Mandatory type: Numeric, format up to 5 decimals
  • MortgageYieldFixRate
  • Mandatory if fixed, type: Numeric, format up to 5 decimals
  • MortgageYieldVariableRate
  • Mandatory if variable, type: Numeric, format up to 5 decimals
  • BondYieldFixRate
  • Mandatory if fixed, type: Numeric, format up to 5 decimals
  • BondYieldVariableRate
  • Mandatory if variable, type: Numeric, format up to 5 decimals
  • PoolType
  • Mandatory for lender pool: "Standard" or "WAC"
  • ClientRef
  • Mandatory for lender pool: STRING
  • NoteDate
  • Mandatory type: Date, format "mm/dd/yyyy"
  • NoteBorrowerPaymentDate
  • Mandatory type: Date, format "mm/dd/yyyy"
  • NotePaymentDueOn
  • Mandatory type: Numeric
  • NotePaymentFrequency
  • Mandatory: "M","Q","S","A" or "O"
  • NotePaymentAmount
  • Mandatory type: Numeric, format 2 decimals
  • NoteMaturityDate
  • Mandatory type: Date, format "mm/dd/yyyy"
  • NoteRateIndex
  • Mandatory type: STRING
  • NoteInitialFixRate
  • Mandatory type: Numeric, format up to 5 decimals
  • NoteFirstChangeDate
  • Mandatory if variable, type: Date, format "mm/dd/yyyy"
  • NoteFrequencyOfChange
  • Mandatory if variable, type: STRING. Mandatory: "M","Q","S","A" or "O"
  • NoteSpreadPct
  • Mandatory if variable, type: Numeric, format up to 5 decimals
  • NoteCap
  • Mandatory if variable, type: Numeric, format up to 5 decimals
  • NoteFloor
  • Mandatory if variable, type: Numeric, format up to 5 decimals
  • NotePaymentFrequencyOther
  • Mandatory if NotePaymentFrequency = "O", type: STRING
  • NoteAdjustmentFrequencyOther
  • Mandatory if NoteFrequencyOfChange = "O", type: STRING
    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