Payitoff

Payitoff Documentation

Explore our guides, examples, and documentation to integrate Payitoff into your products.

We'll get you up and running in an afternoon - or we owe you a beer / mocktail!

Get Started    API Reference

Integrate in 10 Minutes

Don't have the time for API-based integration? Nexus has you covered.

If you're looking to add some quick coverage of student loan functionality to your product or platform, but aren't ready to spend the time designing, architecting, and building your own customized borrower experience, Nexus has you covered.

What you'll need

  • A Nexus KeyNexus Key - A special identification and authentication key that must be provided when initializing the Nexus widget. This key is considered public because it will be visible in client-side code and/or markup.
  • A few lines of JavaScript

🚧

Don't have your Nexus Key?

Please contact [email protected] and we'll get that sorted.

What we'll do

  • Add the Nexus script tag to a page in your site
  • Initialize Nexus to create a borrower record for you without our API
  • Add a click event listener to trigger the Nexus widget
  • Rely on Nexus to link servicers, provide an assessment, and enroll your borrower in an Income-Driven Repayment PlanIncome-Driven Repayment Plan - A Repayment Plan that factors in a Borrower's discretionary monthly income, personal financial hardships, family size, tax filing statuses, and total federal loan obligations to determine an affordable payment schedule.
  • Do something meaningful with the results

Let's get started

Add the Nexus script tag

You must include the NexusNexus - An easy-to-use drop-in JavaScript widget from Payitoff that enables your Borrowers to connect directly to their Servicers, getting you the most accurate student loan data without having to do all the work yourself. script tag in your app's markup. Where you place it in your markup is up to you, of course, but you must ensure it is included and loaded before any event handlers are triggered.

<script src="https://payitoff-cdn.io/sandbox/nexus/js/v1"></script>

📘

Integration begins in the Payitoff Sandbox

For local development, staging, and testing environments, you'll want to include the sandbox version of Nexus.

Payitoff's Sandbox is your development playground—it will never connect to live ServicerServicer - A financial institution to whom a Borrower pays their monthly student loan payment(s). websites, it won't submit real Enrollment RequestsEnrollment Requests - When a Borrower is ready to switch Repayment Plans, they must create an Enrollment Request. This is easiest with Nexus, or you can submit an Enrollment Request via our API., it always returns dummy data where necessary, and you'll use a Sandbox Nexus KeyNexus Key - A special identification and authentication key that must be provided when initializing the Nexus widget. This key is considered public because it will be visible in client-side code and/or markup. that only works in our Sandbox environment.

Initialize Nexus with your own Borrower IDs

The Nexus experience is unique to each of your borrowers based on their loan portfolios, so it requires a borrower identifier on init. To ease API-free integration, you can provide your own unique borrower identifier when initializing Nexus. If we've never seen that borrower before, Nexus will create a new Borrower record for you. If we have seen the borrower with your unique external ID before, Nexus will recognize that, find the borrower, and load workflows for their situation.

Nexus({
  nexus_key: 'GIVINGHERALLSHESGOT',
  borrower: 'jamestkirk1966'
})

Triggering Nexus on a click event

Let's assume we have a button in the page that is meant to trigger opening the Nexus widget:

<a id="nexus" class="button">Enroll via Nexus</a>

Given this button-styled a tag in your page, let's write a simple click handler that can open Nexus, telling Nexus we want our borrower to be enrolled in an Income-Driven Repayment PlanIncome-Driven Repayment Plan - A Repayment Plan that factors in a Borrower's discretionary monthly income, personal financial hardships, family size, tax filing statuses, and total federal loan obligations to determine an affordable payment schedule. of their choosing. To do this, we'll also want to provide an onSuccess and onExit callback function so we can inspect the response from Nexus when the borrower exits the widget.

let nexusButton = document.querySelector('#nexus')

// Attach click handler to invoke Nexus.enroll with callback functions
nexusButton.addEventListener('click', e => {
  Nexus.enroll({
    // the function to call when borrower is done
    onSuccess: function(response) {
        // we'll just console.log our response so we can inspect it
      console.log(response)
    },
    // the function to call when borrower quits or error occurs
    onExit: function(response) {
        // we'll just console.log our response so we can inspect it
      console.log(response)
    },
  })
})

That's it!

When the Nexus widget is dismissed, it will call the onSuccess or onExit callback functions you provided—onSuccess if the borrower completed the requested workflow, or onExit if they canceled out and dismissed the widget without completing or some other error occurs.

Ready to learn more about Nexus workflows, callbacks, and responses? Head over to our Nexus pages for all you need to know to better understand how Nexus works, and how you can put it to work in your products and platforms.

Updated 3 months ago


What's Next

Nexus

Integrate in 10 Minutes


Don't have the time for API-based integration? Nexus has you covered.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.