Install and configure Affirm

Overview

This guide describes how to integrate Affirm into your Lightspeed e-commerce platform so that you can provide Affirm as a payment option to your customers.

Step 1: Install Affirm on Lightspeed Ecommerce

1. Find the app in the Lightspeed App Store here.
2. Click Install.
3. Log into Lightspeed and select your store.
4. Click Install App within Lightspeed Ecom.
5. Enter the credentials you use to log in to store.shoplightspeed.com and click Next.

6. Follow the remaining steps. During the install, you'll be forwarded to our app management site to either login to an existing account (if you've purchased a Lightspeed eCom app from AdVision before) OR create a new account with AdVision to install and manage this and any future apps you may purchase.

Once you've created an account or logged into your existing account, the app installs automatically, after which you'll be forwarded to the shops list, which displays a list of Lightspeed eCom shops registered with your account and any apps installed with those shops.

To finish the installation of this app, click on "Affirm" under the appropriate shop. This will take you to the settings for the app.

Step 2: Configure Affirm

1. Enable Affirm: Determines if Affirm should show in your checkout as a payment option. Check this box and save changes to show, uncheck box and save changes to hide.
2. Mode: If you want to perform test transactions with Affirm, set Mode to Test. If you want to take real payments, set Mode to Live.

Configure your API settings

Set your API keys, enter your Merchant Name, and set your Payment action. See below for descriptions of the API settings.

API Settings

Field	Description
Live Public API Key	The production public API key found in your Affirm dashboard.
Live Private API Key	The production private API key found in your Affirm dashboard.
Test Public API Key	The sandbox public API key found in your Sandbox Affirm dashboard.
Test Private API Key	The sandbox private API key found in your Sandbox Affirm dashboard.
Merchant Name	Your business name.
Payment Action	Authorize Only: Authorize the payment when the customer places their order. Authorize and Capture: Immediately captures the payment after authorization.

Configure your Site Settings

You can define your Site Settings with this app with the following configuration options:

Field	Description
Include Affirm Enhanced Analytics	Adds Affirm's enhanced analytics code to be included on the final page (order receipt display) of your checkout. The app will include tracking code on your website.
Minimum Order Threshold	This is the minimum order amount required for Affirm to be displayed as a checkout option. This number must be higher than $50. If blank, the default value of $50 will be used. If a customer's order total is less than this minimum, Affirm will not be shown as a payment option in your store's checkout.
Maximum Order Threshold	Set the maximum order total needed to make payment via Affirm. If a customer's order total is more than this maximum, Affirm will not be shown as a payment option in your store's checkout.

Configure your Payment Page and Load Page settings

Configure your payment page and load page settings with the following options:

Payment Page

Field	Description
Do NOT Auto Generate Order	Don't show instructions with Create Affirm Order button on page, just attempt to automatically start the Affirm payment process. Only select this if you are using the AdVision Gift Card payment app.

Loading Page Settings (optional)

Field	Description
Logo URL	Provide full (absolute) URL (web address) to the logo you'd like to display on any of this app's loading page.
Background Color	Select the background color you'd like for any of this app's loading page.
Text Color	Select the text color you'd like to use for any text displayed on this app's loading page.
Custom CSS	Only for users with advanced experience working in CSS code. Any CSS provided here will load on any of the app's loading page. Improper use of this field may cause the app to not function correctly.
Custom Javascript	Only for users with advanced experience working in Javascript. Any Javascript provided here will load on any of the app's loading page. Improper use of this field may cause the app to not function correctly.

Save your settings

If you make changes to any of these settings fields, be sure to click the Save Settings button to save your changes. After you saving your changes, be sure to scroll to the bottom of the page and click Check Install (Publish Changes), to ensure any changes you've made that require publishing, are published to the eCom website. It can take several minutes for Lightspeed to publish changes.