This guide will help you identify the steps required to implement the Flexiti Online Credit Application & Purchase flow using the Flexiti Online API.
The Flexiti Online API revolves around a single REST API endpoint (POST /systems/init) that generates a redirection URL connected to the Flexiti Online checkout experience. The redirection URL can be hosted by the merchant eComm site in a modal/browser window to process a Flexiti Application, Buy, and Apply-then-Buy flow.
After the customer completes the Online Flexiti flow, the Flexiti-hosted UI will return to a callback URL designated by the merchant to process a Flexiti Success/Failure depending on the transaction status returned by Flexiti (through the GET /notifications endpoint).
The Flexiti Online API uses API keys to authenticate requests. Your keys consist of a Client ID and a Client Secret. You can view and manage your API keys in our Developer Portal.
Every account is provided with two sets of keys. One for testing in our MERCHANT INTEGRATION environment and one for running live transactions in our PRODUCTION environment. You will first implement in the MI environment and will then transition to Prod once you have passed successful testing with the Implementation Team.
Obtaining your Merchant Integration Flexiti API Keys
Go to our Developer Portal
Create a Developer Portal Account
Step 1: Click Sign in
Step 2: Click Create one
Upon setting up your account you will be provided with a set of API keys (Client Secret and Client ID) for our MI environment. You will use these keys during your implementation, and any applications generated using these keys will be for testing purposes only.
NOTE: Be sure to keep the Client ID & Client Secret secure! You should ensure that the keys are not exposed on your website. We suggest that you perform any oauth/token calls from the server-side to accomplish this.
Next, enter the URL of your development/staging environment in the Trust URL field.
This should be your e-commerce platform URL. If you are using a test version of your website, it should have the test site’s base URL
Format: e.g.
For this implementation, make sure your Trust URL does not contain a forward slash. (ie. https://example.com not https://example.com/ )
Next you want to set up the redirection URLS.
This is where the application form will redirect once the applicant is completed.
The customer will be redirected to the Success redirection URL once they complete the Flexiti checkout flow successfully
The customer will be redirected to the Error redirection URL if the customer cancels the application or failed to complete the Flexiti payment (most Merchants set these URLs back to their cart)
From the SUCCESS/ERROR Redirect URLs, you can call the GET /notifications/order-id/{order-id} API endpoint to get the status & transaction information on the latest transaction attempted.
Implementation Process
Follow these steps to implement the Online API on the site:
The Online API contains a number of endpoints which will allow you to implement the Online API in a manner that fits your business needs. You are required to build the following 3 endpoints:
· Authentication (POST /oauth/token)
· Integration (POST /systems/init)
· Retrieve Information (GET /notifications/order-id/{order-id})
These endpoints will allow you to call the API to allow the customer to either apply or use an existing account to checkout using Flexiti
The Order Information Endpoint will be used once the order has been successfully placed to determine the AVS values for the billing and shipping addresses for the order. This endpoint is necessary to determine liability on the order as Flexiti will only take on the liability for orders in which the shipping address matches the Flexiti billing address.