HomeGuidesAPI Reference
Guides

How To: Use the Guidance API (beta)

Suggest Edits

Payitoff’s Guidance API offers comprehensive debt guidance across a consumer’s entire portfolio, unlocking savings and putting it to work improving their financial wellbeing.

🚧

This is under construction. The API capabilities and it’s Response will continue to change.

👍

If you'd like to join our beta program, please reach out to [email protected]

Steps to Implementation

Once you create a Consumer in Payitoff, we offer multiple options to import their debts. After that, you’ll use our Guidance API to find opportunities for the Consumer as well as fill in missing information to reduce assumptions and take action.

1. Create Your Consumer and Their Debts

Option 1: Via API

If you already know your Consumer’s Debts, you can import them via our API

  1. Create a Consumer via API (More details). You can create a Consumer with no information, but we recommend filling in as much as you can to get the most accurate guidance.
  2. Create their Debts via API (More details)

Option 2: Via Nexus

If you’d like your Consumer to link their Debts, use our interactive Nexus widget. Nexus will create the Consumer for you when launched:

2. Get Guidance

With your Consumer and their Debts successfully imported, you're ready to find out the Debt Guidance options available to them:

curl --request GET \
     --url https://payitoff-sandbox.io/api/v3.0.0/consumers/50885f44-a4a5-4787-b530-47bf56b86739/guidance \
     --header 'Authorization: Bearer $YOUR_API_KEY'
     --header 'Accept: application/json'

Response:

{
  "data": {
    "assumptions": {
      "debts": {
        "019a7850-cc85-49d2-a374-8fd717498068": {
          "strategy": "minimums"
        },
        "031042bd-0ff2-482e-851f-c69fe56f8f3f": {
          "strategy": "minimums"
        },
        "0826d8ce-5d30-4f0f-804f-0e95875308b6": {
          "strategy": "minimums"
        },
        "19dca395-c4e0-460c-b343-fdcbe144f511": {
          "strategy": "minimums"
        },
        "428c510f-37f5-4ee3-939f-826c6eb53561": {
          "strategy": "minimums"
        },
        "42b057f7-e2f0-42f4-8aa0-e20557819009": {
          "strategy": "minimums"
        },
        "440c3baa-147e-4aa5-b852-24af9a2aae58": {
          "strategy": "minimums",
          "apr": "23.38"
        },
        "602d12a5-5ad8-4432-b436-3b80a4d152aa": {
          "strategy": "minimums"
        },
        "60a50829-9ee0-4cbc-a47c-1d1bafd6c210": {
          "strategy": "minimums",
          "apr": "23.38"
        },
        "78d3230b-ee42-4a30-865b-3cf3fa92014a": {
          "strategy": "minimums",
          "apr": "23.38"
        },
        "9f753eb9-b945-42e2-9f5a-ac8512457bc3": {
          "strategy": "minimums"
        },
        "ae094cee-f616-4f33-b966-b22a384664bf": {
          "strategy": "minimums"
        },
        "b2cc3f33-6d8c-418d-826b-441fcf11a9cf": {
          "strategy": "minimums"
        },
        "dece7e40-d327-4ad0-b75f-370175c1c853": {
          "strategy": "minimums"
        },
        "e3de8474-d494-4de7-864a-bb6362b27b29": {
          "strategy": "minimums"
        },
        "f328a33a-d641-427f-afc9-08539627cc65": {
          "strategy": "minimums"
        },
        "ff9af2e6-18d4-49c9-9711-5059159703fd": {
          "strategy": "minimums"
        }
      },
      "filing_status": "single",
      "family_size": 1,
      "available_extra_funds": "0"
    },
    "best_current_forecast": {
      "actions": [
        {
          "name": "cc_consolidation",
          "description": "Apply for a personal consolidation loan to pay off that amount in credit-card debt",
          "changes": {
            "consolidate": [
              "60a50829-9ee0-4cbc-a47c-1d1bafd6c210",
              "78d3230b-ee42-4a30-865b-3cf3fa92014a"
            ],
            "new_debts": [
              {
                "type": "PERSONAL_LOAN",
                "term": 60,
                "balance": "35000",
                "uuid": "03706d2e-487a-447a-a5d5-d313a15e7ac9",
                "apr": "17.9",
                "lender": null,
                "minimum_payment": "886.87",
                "opened_on": null,
                "sub_type": null
              }
            ]
          },
          "total_savings": "537212.60",
          "monthly_savings": "-186.87"
        },
        {
          "name": "idr_enrollment",
          "description": "Enroll eligible student loans in the SAVE repayment plan",
          "changes": {
            "enroll": [
              "019a7850-cc85-49d2-a374-8fd717498068",
              "031042bd-0ff2-482e-851f-c69fe56f8f3f",
              "0826d8ce-5d30-4f0f-804f-0e95875308b6",
              "19dca395-c4e0-460c-b343-fdcbe144f511",
              "428c510f-37f5-4ee3-939f-826c6eb53561",
              "42b057f7-e2f0-42f4-8aa0-e20557819009",
              "602d12a5-5ad8-4432-b436-3b80a4d152aa",
              "9f753eb9-b945-42e2-9f5a-ac8512457bc3",
              "ae094cee-f616-4f33-b966-b22a384664bf",
              "b2cc3f33-6d8c-418d-826b-441fcf11a9cf",
              "dece7e40-d327-4ad0-b75f-370175c1c853",
              "e3de8474-d494-4de7-864a-bb6362b27b29",
              "f328a33a-d641-427f-afc9-08539627cc65",
              "ff9af2e6-18d4-49c9-9711-5059159703fd"
            ]
          },
          "total_savings": "0.00",
          "monthly_savings": "0.00"
        },
        {
          "name": "snowball",
          "description": "Pay off debts in order of smallest balance to largest",
          "changes": {
            "snowball": [
              "03706d2e-487a-447a-a5d5-d313a15e7ac9",
              "440c3baa-147e-4aa5-b852-24af9a2aae58",
              "60a50829-9ee0-4cbc-a47c-1d1bafd6c210",
              "78d3230b-ee42-4a30-865b-3cf3fa92014a"
            ]
          },
          "total_savings": "295980.86",
          "monthly_savings": "0.00"
        }
      ],
      "total_savings": "833193.46",
      "new_monthly_payment": "3281.31",
      "monthly_savings": "-186.87",
      "new_total_cost": "315952.67"
    }
  }
}

3. Pay It Off

Updated 2 months ago