Payoff
Get the payoff amount for an account.
The payoff endpoint returns the amount required to pay off the account. The response will contain all outstanding balances across Fees, Interest, and Principal including all past-due balances and accrued interest. In addition to the account payoff amount, the amortization schedule for a loan account or multiple amortization schedules for an account with multiple loans will be returned.
Response Definitions:
total_payoff: the amount needed to pay off the loan(s)total_imputed_interest: any applicable imputed interestunpaid_payoff_amount: the sum of past-due balancesimputed_interest_from_unpaid_balances: any applicable imputed interest on past-due balances
Example Response:
{
"account_id": "can_37",
"effective_at": "2023-11-14T08:00:00.001000Z",
"account_aggregate": {
"total_payoff_amount": 1003332,
"total_imputed_interest": 0,
"unpaid_payoff_amount": 84999,
"imputed_interest_from_unpaid_balances": 0
},
"payoff_amounts_by_loan": {
"can_1025": {
"total_payoff_amount": 1003332,
"total_imputed_interest": 0,
"unpaid_payoff_amount": 84999,
"imputed_interest_from_unpaid_balances": 0,
"amortization_forecast": [
{
"line_item_id": "can_1025",
"cycle_exclusive_end": "2023-11-11T08:00:00Z",
"min_pay_due_at": "2023-11-14T08:00:00Z",
"am_min_pay_cents": 84999,
"am_fees_cents": 0,
"am_interest_cents": 1666,
"am_deferred_cents": 0,
"am_principal_cents": 83333,
"am_cycle_payment_cents": 0,
"am_start_principal_balance_cents": 1000000,
"am_start_total_balance_cents": 1000000,
"am_end_principal_balance_cents": 1000000,
"am_end_total_balance_cents": 1001666,
"paid_on_time": false,
"created_at": "2023-12-12T23:23:53.295324Z"
},
{
"line_item_id": "can_1025",
"cycle_exclusive_end": "2023-11-18T00:00:00-08:00",
"min_pay_due_at": "2023-11-21T00:00:00-08:00",
"am_min_pay_cents": 169998,
"am_fees_cents": 0,
"am_interest_cents": 3332,
"am_deferred_cents": 0,
"am_principal_cents": 166666,
"am_cycle_payment_cents": 0,
"am_start_principal_balance_cents": 1000000,
"am_start_total_balance_cents": 1001666,
"am_end_principal_balance_cents": 833334,
"am_end_total_balance_cents": 833334,
"paid_on_time": null,
"created_at": null
},
{
"line_item_id": "can_1025",
"cycle_exclusive_end": "2023-11-25T00:00:00-08:00",
"min_pay_due_at": "2023-11-28T00:00:00-08:00",
"am_min_pay_cents": 84999,
"am_fees_cents": 0,
"am_interest_cents": 1666,
"am_deferred_cents": 0,
"am_principal_cents": 83333,
"am_cycle_payment_cents": 0,
"am_start_principal_balance_cents": 833334,
"am_start_total_balance_cents": 833334,
"am_end_principal_balance_cents": 750001,
"am_end_total_balance_cents": 750001,
"paid_on_time": null,
"created_at": null
},
{
"line_item_id": "can_1025",
"cycle_exclusive_end": "2023-12-02T00:00:00-08:00",
"min_pay_due_at": "2023-12-05T00:00:00-08:00",
"am_min_pay_cents": 84999,
"am_fees_cents": 0,
"am_interest_cents": 1666,
"am_deferred_cents": 0,
"am_principal_cents": 83333,
"am_cycle_payment_cents": 0,
"am_start_principal_balance_cents": 750001,
"am_start_total_balance_cents": 750001,
"am_end_principal_balance_cents": 666668,
"am_end_total_balance_cents": 666668,
"paid_on_time": null,
"created_at": null
},
{
"line_item_id": "can_1025",
"cycle_exclusive_end": "2023-12-09T00:00:00-08:00",
"min_pay_due_at": "2023-12-12T00:00:00-08:00",
"am_min_pay_cents": 84999,
"am_fees_cents": 0,
"am_interest_cents": 1666,
"am_deferred_cents": 0,
"am_principal_cents": 83333,
"am_cycle_payment_cents": 0,
"am_start_principal_balance_cents": 666668,
"am_start_total_balance_cents": 666668,
"am_end_principal_balance_cents": 583335,
"am_end_total_balance_cents": 583335,
"paid_on_time": null,
"created_at": null
},
{
"line_item_id": "can_1025",
"cycle_exclusive_end": "2023-12-16T00:00:00-08:00",
"min_pay_due_at": "2023-12-19T00:00:00-08:00",
"am_min_pay_cents": 84999,
"am_fees_cents": 0,
"am_interest_cents": 1666,
"am_deferred_cents": 0,
"am_principal_cents": 83333,
"am_cycle_payment_cents": 0,
"am_start_principal_balance_cents": 583335,
"am_start_total_balance_cents": 583335,
"am_end_principal_balance_cents": 500002,
"am_end_total_balance_cents": 500002,
"paid_on_time": null,
"created_at": null
},
{
"line_item_id": "can_1025",
"cycle_exclusive_end": "2023-12-23T00:00:00-08:00",
"min_pay_due_at": "2023-12-26T00:00:00-08:00",
"am_min_pay_cents": 84999,
"am_fees_cents": 0,
"am_interest_cents": 1666,
"am_deferred_cents": 0,
"am_principal_cents": 83333,
"am_cycle_payment_cents": 0,
"am_start_principal_balance_cents": 500002,
"am_start_total_balance_cents": 500002,
"am_end_principal_balance_cents": 416669,
"am_end_total_balance_cents": 416669,
"paid_on_time": null,
"created_at": null
},
{
"line_item_id": "can_1025",
"cycle_exclusive_end": "2023-12-30T00:00:00-08:00",
"min_pay_due_at": "2024-01-02T00:00:00-08:00",
"am_min_pay_cents": 84999,
"am_fees_cents": 0,
"am_interest_cents": 1666,
"am_deferred_cents": 0,
"am_principal_cents": 83333,
"am_cycle_payment_cents": 0,
"am_start_principal_balance_cents": 416669,
"am_start_total_balance_cents": 416669,
"am_end_principal_balance_cents": 333336,
"am_end_total_balance_cents": 333336,
"paid_on_time": null,
"created_at": null
},
{
"line_item_id": "can_1025",
"cycle_exclusive_end": "2024-01-06T00:00:00-08:00",
"min_pay_due_at": "2024-01-09T00:00:00-08:00",
"am_min_pay_cents": 84999,
"am_fees_cents": 0,
"am_interest_cents": 1666,
"am_deferred_cents": 0,
"am_principal_cents": 83333,
"am_cycle_payment_cents": 0,
"am_start_principal_balance_cents": 333336,
"am_start_total_balance_cents": 333336,
"am_end_principal_balance_cents": 250003,
"am_end_total_balance_cents": 250003,
"paid_on_time": null,
"created_at": null
},
{
"line_item_id": "can_1025",
"cycle_exclusive_end": "2024-01-13T00:00:00-08:00",
"min_pay_due_at": "2024-01-16T00:00:00-08:00",
"am_min_pay_cents": 84999,
"am_fees_cents": 0,
"am_interest_cents": 1666,
"am_deferred_cents": 0,
"am_principal_cents": 83333,
"am_cycle_payment_cents": 0,
"am_start_principal_balance_cents": 250003,
"am_start_total_balance_cents": 250003,
"am_end_principal_balance_cents": 166670,
"am_end_total_balance_cents": 166670,
"paid_on_time": null,
"created_at": null
},
{
"line_item_id": "can_1025",
"cycle_exclusive_end": "2024-01-20T00:00:00-08:00",
"min_pay_due_at": "2024-01-23T00:00:00-08:00",
"am_min_pay_cents": 84999,
"am_fees_cents": 0,
"am_interest_cents": 1666,
"am_deferred_cents": 0,
"am_principal_cents": 83333,
"am_cycle_payment_cents": 0,
"am_start_principal_balance_cents": 166670,
"am_start_total_balance_cents": 166670,
"am_end_principal_balance_cents": 83337,
"am_end_total_balance_cents": 83337,
"paid_on_time": null,
"created_at": null
},
{
"line_item_id": "can_1025",
"cycle_exclusive_end": "2024-01-27T00:00:00-08:00",
"min_pay_due_at": "2024-01-30T00:00:00-08:00",
"am_min_pay_cents": 85003,
"am_fees_cents": 0,
"am_interest_cents": 1666,
"am_deferred_cents": 0,
"am_principal_cents": 83337,
"am_cycle_payment_cents": 0,
"am_start_principal_balance_cents": 83337,
"am_start_total_balance_cents": 83337,
"am_end_principal_balance_cents": 0,
"am_end_total_balance_cents": 0,
"paid_on_time": null,
"created_at": null
}
]
}
}
}
Related Articles
Updated 9 months ago