Payoffs
The payoffs endpoint
Payoffs
The payoffs endpoint
The Payoffs endpoint retrieves a payoff quote in real-time from the Account’s financial institution / lender.
Payoffs are currently only available for Auto Loan accounts
The Payoff endpoint is available as a:
| Type | Use-Case |
|---|---|
Product | On-Demand retrieval of auto loan payoff (amount, per diem, etc) from the Account’s financial institution |
Payoff Objects
id
string
Unique identifier for the Payoff.
account_id
string
The ID of the associated Account.
status
enum
Status of the Payoff.
amount
number
The payoff amount.
term
number
The term length of the payoff in years.
per_diem_amount
number
The daily interest charge amount.
error
object | null
An object representing an error that occurred while processing this Payoff. See Payoff errors.
created_at
string
Timestamp of when the Payoff was created.
updated_at
string
Timestamp of when the Payoff was last updated.
Webhook Payload
The Webhook payload will contain the following information:
{
"id": "string",
"type": "payoff.create" | "payoff.update",
"path": "/accounts/<acc_id>/payoffs/<pyf_id>",
}