HomeGuidesAPI Reference

ForgivenessOptions

Payitoff API: ForgivenessOptions Schema

There are many student loan forgiveness programs at federal, state, and lower levels available to borrowers. Our API surfaces two of the largest programs—PSLF and TCLI—and support for more forgiveness programs will continue to increase in the future.

When you query our Get Forgiveness Options API endpoint, you'll receive a JSON response with an array of ForgivenessOption objects.

Schema Definition

Property

Type

Format

Description

forgiveness_options

array

ForgivenessOption

An array of ForgivenessOption objects.

Example

An example response from our Get Forgiveness Options API endpoint:

[
  {
    "amount_forgiven": 0.00,
    "eligible_loans": [],
    "ineligible_loans": [],
    "ineligible_reasons": [],
    "matching_institutions": [
      {
        "city": "albemarle",
        "is_school": false,
        "name": "city of albemarle",
        "state_code": "NC"
      }
    ],
    "metadata": {},
    "name": "Public Service Loan Forgiveness",
    "savings": 0.00,
    "total_cost": 0.00,
    "total_paid": 0.00,
    "type": "pslf"
  },
  {
    "amount_forgiven": 0.00,
    "eligible_loans": [],
    "ineligible_loans": [],
    "ineligible_reasons": [
      "Does not work for qualifying employer"
    ],
    "matching_institutions": [],
    "metadata": {
      "qualifying_start_date": "2015-12-10"
    },
    "name": "Teacher Loan Forgiveness",
    "savings": 0.00,
    "total_cost": 0.00,
    "total_paid": 0.00,
    "type": "tcli"
  }
]

Did this page help you?