Payitoff

Payitoff Documentation

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

We'll get you working with Payitoff and Nexus as quickly as possible.

Get Started    API Reference

Nexus

Get to know Nexus, our drop-in JavaScript widget.

👍

Check out our One-day Integration Guide

While this page documents how to include, initialize, and use Nexus, we highly recommend reading our One-day Integration Guide to familiarize yourself with the Payitoff domain, and how you can use Nexus with our API to give your products student loan superpowers.

If you want to jump right into coding, we'll take you from Zero to Integration Hero in a day.

Include Nexus script tag

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

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

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.

Going to production?

When you're ready to go to production with your Nexus-powered integration, you'll need a production 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. and you'll want to update your script tag's src property to use the production URL:

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

🚧

Don''t have your Nexus Key?

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

Initialize Nexus

With your 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., and the Nexus script tag in your page, you can now initialize Nexus in your app. Nexus works on behalf of your Borrowers to enable linking every ServicerServicer - A financial institution to whom a Borrower pays their monthly student loan payment(s). they have relationships with, providing Assessments, creating 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., and more in the future.

let widget = Nexus({
  nexus_key: 'GIVINGHERALLSHESGOT',
  borrower: '72edfd83-eca2-4383-a015-ff7a230504c2'
})

❗️

Avoid initializing Nexus inside event listeners

When you initialize, Nexus may connect to Payitoff to check what capabilities it can support for the Borrower.uuid you've provided. These capabilities depend on that state your Borrower is in, whether they've linked Servicers, what LoanLoan - A subsidized or unsubsidized federal student loan. data has already been found, and other factors. Under normal circumstances, this may take up to a few hundred milliseconds. However, you should ensure you're providing the best possible experience, plan for unexpected latency and delays, and always initialize Nexus outside any click handlers to minimize any delays for your Borrowers.

Note: You'll know you're invoking a workflow before capabilities are known if you receive an error like TypeError: undefined is not an object (evaluating result.metadata)—or, in some browsers Cannot read property metadata of undefined. You may want to check the widget's canLinkServicers and canEnroll properties before invoking either workflow, especially if you decide to initialize Nexus in an event handler. These properties help avoid this gotcha while Nexus is in beta, but should not be relied upon as they may be removed in a future release. The proper course of action is to have Nexus initialized before you invoke a workflow in response to user interaction.

📘

The instantiated Nexus object can only operate on a single Borrower at a time.

Updated about a month ago



Nexus


Get to know Nexus, our drop-in JavaScript widget.

Suggested Edits are limited on API Reference Pages

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