Getting Started

This tutorial walks you through the basic steps of integrating your fintech product with the Upwardli platform.

Authentication

The first step in integrating your product is to configure authentication. All Upwardli components and APIs require Oauth tokens for access.

For a deeper dive into authentication, you can read these further details.

Consumer Onboarding

Once you are able to successfully request and receive authentication tokens, you can start onboarding your end users. Our onboarding process has three main steps:

1. End User KYC
2. View the Offer/Terms
3. Accept the Credit Terms Agreement

These steps are all managed automatically using our onboarding UI component, and you can view a detailed overview of the onboarding process here.

Purchase Flow

The User Purchase Flow is a three stage process:

Recording transactions with Upwardli is a three stage process:

Requesting a Hold

The transaction starts by requesting a hold. If there are sufficient funds in the end user’s account, then a new transaction will be created and the funds will be held until the transaction is completed, or for 1 calendar day. If there are insufficient funds in the account, a 4XX error will be returned with an error description in the body.

Clearing the Transaction

Once a hold is created, you can convert that hold into a transaction by calling the clear endpoint. This will disburse the funds from the end user’s line of credit and create the liability. This step should happen at the time of purchase in your system.

Close the Transaction

In this final step, the transaction is closed and recorded a complete. Successful closes will extinguish the liability that was created in the Clearing step and make those funds available, again, to the end user.

You can view further details about the Purchase Flow, and a detailed overview of the purchase cycle here.

APIs

All of our UI components use the same APIs that we make available to our consumers. You can view our full API documentation here.