Return Payoff Calculation

📘
Supported Regions and Base URLs

👍
Access and Registration
Authentication

Scope

fsi-cards:write

Body Response - Schema

200 OK

Parameter	Type	Description	Required
daily_per_diem	string	The per diem value.	no
payoff_amount	string	The payoff amount calculated by the core.	yes
payoff_amount_details	object	"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

Parameter

Type

Description

Required

daily_per_diem

string

The per diem value.

payoff_amount

string

The payoff amount calculated by the core.

yes

payoff_amount_details

object

"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.

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

Parameter	Type	Description	Required
code	string	n/a	yes
message	string	n/a	yes
description	string	n/a	no
fields	array[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.