The payoffs endpoint

{
  "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"
}

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:

Type	Use-Case
`Product`	On-Demand retrieval of auto loan payoff (amount, per diem, etc) from the Account’s financial institution

Payoff Objects

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

List all Attributes Create a Payoff

⌘I

API Reference

Entities

Accounts

Wallet

Payments

Files

Opal

Elements

Events

Supporting Endpoints

Payoff Objects

Webhook Payload

​Payoff Objects

​Webhook Payload

Payoff Objects

Webhook Payload