Return Payoff Calculation

Returns the payoff calculation for an FSI account based on a provided future date.

📘

Supported Regions and Base URLs

👍

Access and Registration

Authentication

Scope

fsi-cards:write

Body Response - Schema

200 OK

ParameterTypeDescriptionRequired
daily_per_diemstringThe per diem value.no
payoff_amountstringThe payoff amount calculated by the core.yes
payoff_amount_detailsobject"payoff_amount_details" subdivides into:

"principal_payment" (string)
The principal payment of the payoff amount.

"interest_payment" (string)
The interest payment of the payoff amount.

"monthly_escrow_payment" (string)
The monthly escrow payment of the payoff amount.

"fee" (string)
The fee payment of the payoff amount.
no

401 (unauthorized), 403 (forbidden), 404 (not found)

ParameterTypeDescriptionRequired
codestringn/ayes
messagestringn/ayes
descriptionstringn/ano
fieldsarray[object]"fields" subdivides into:

"name" (string)

"description" (string)
yes (name and description)

❗️

API Availability

The FSI Integrations API has been in General Availability since January 2023.

🚧

Troubleshooting

If you have any questions regarding the usage of this API, or if you’re having any technical issues, please open a ticket using this form.

Language
Authorization
Header
Click Try It! to start a request and see the response here!