Skip to main content
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 and Mortgage accounts
The Payoff endpoint is available as a:
TypeUse-Case
ProductOn-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.
in_progress
The real-time payoff information sync is in progress.completed
The payoff information was successfully synced.failed
The payoff information failed to sync.
​
amount
number
The payoff amount.
​
term
number
The number of days this payoff quote is valid for.
​
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>",
}

{
  "id": "pyf_ELGT4hfikTTCJ",
  "status": "completed",
  "amount": 6083988,
  "term": 15,
  "per_diem_amount": null,
  "error": null,
  "created_at": "2024-03-14T01:41:28.434Z",
  "updated_at": "2024-03-14T01:41:28.655Z"
}