Setup Checklist
This section is a comprehensive and high level summary of all tasks and prerequisites required for this feature to function properly. This section is purposed for use after an administrator is familiar with configuring this feature as an “audit” checklist. For detailed set-up instructions, jump down to “Prerequisite Tasks” and “Detailed Setup Guide” and then follow up with this checklist to ensure all steps are completed.
1. POS Tasks | |
|---|---|
1. Set up Products in your POS REQUIRED
| PREREQUISITE |
2. Infrastructure Tasks | |
| PREREQUISITE |
3. Commerce Tasks | |
1. Ensure that Affirm Payment Provider Plugin is Installed REQUIRED 2. Set the Affirm widget to Active REQUIRED 3. Configure the Affirm payment method REQUIRED 4. Add the Is Affirm Eligible Classification REQUIRED | PREREQUISITE |
Language String, Setting, HTML widget OPTIONAL
| PREREQUISITE |
1. Configure Affirm Product REQUIRED
2. Assign Is Affirm Eligible Product Classification REQUIRED | DETAILED SETUP |
Prerequisite Tasks
This section describes all requirements that must be completed before you can begin setting up this feature. Once these tasks are complete continue to the next section.
Complete contracting with Affirm
You must have signed a contract and been onboarded with Affirm to begin configuration. Be sure you have your API Key and Private API Key from Affirm, as well as your login to the Affirm dashboard.
If you’re interested in signing up with Affirm, read the attached Aspenware sales sheet below. Then, email johnston@affirm.com and copy your Aspenware client services representative to get started with the contract process. For more general information about Affirm, see https://www.affirm.com.
Infrastructure Tasks
RTP
Work with your Aspenware representative to ensure that the ‘CanUpdateAlternateIdProfile’ setting in the rtp-config.json file in Unity is set to true.
Note: Affirm requires the collection and of phone numbers, which Aspenware Commerce uses to update the POS. For RTP, failure to set this to true will result in errors on the payment step in checkout.
Commerce Tasks
1. Ensure that Affirm Plugin is Installed
Ensure that the Affirm plugin has been installed by your Aspenware Representative. Go to Configuration > Local Plugins search for the Affirm plugin. If plugin is not installed (matches image below), contact your Aspenware Service Representative.
2. Set the Affirm widget to active
Ensure that the Affirm widget is set to active. Go to Configration > Widgets.
Select edit in the Affirm Payment Provider row, and check the Is active column.
3. Configure the Affirm payment method
Go to Configuration > Payment methods
Select Configure in the Affirm Payment Provider row.
For a test store, select Use Sandbox. For a production store, leave this deselected
Input your Public API Key and your Private API Key. You can find these by logging into your Affirm portal and navigating to the API Keys tab
Input your Minimum Cart Value into the Plugins.Payments.Affirm.Fields.MinimumCartValue field.
IMPORTANT: The minimum cart value will restrict customers from using Affirm if their cart total does not meet or exceed the value entered in this field.
4. Add the Is Affirm Eligible product classification
Add the Is Affirm Eligible classification if not already set up as a product classification. Check that the Is Affirm Eligible classification is not already set up before adding a new one.
Go to Aspenware Commerce > Product Classifications.
Select Add Classification in the upper right-hand corner.
Enter the following on the Classifications page:
Name: Is Affirm Eligible
Description: Assign this classification to qualifying Affirm products only
Is Affirm Ellible: Check
Leave all other checkboxes unchecked.
Click Add, which will appear after all the required items are complete (above).
Settings, Language Strings and/or HTML Widgets for this Feature
This feature may require updates to the following settings, language strings and/or HTML Widgets. Learn more about how to update and create Settings, Language Strings, and HTML widgets follow the links to the respective section.
Language Strings
Updating the content for the area of My Account where guests can manage and view their subscription credit card.
Go to Configuration > Languages page in Admin.
Click Edit in the English row.
From the Edit Language details - English page, click the String Resources tab.
The following content is configurable through Language String resources.
Language String | Value | Location |
|---|---|---|
affirm.payment.paneltext | Pay over time with Affirm | Within checkout on the payment screen. This is the text associated to for the Affirm payment option. |
affirm.payment.text | You will be redirected to Affirm to securely complete your purchase. Just fill out a few pieces of basic information and get a real-time decision. Checking your eligibility won't affect your credit score. | Within checkout on the payment screen. This is the description for the Affirm payment selection. |
affirm.confirm.checkoutbuttontext | Pay over time with | Within the confirm Affirm payment screen. This is the button to accept Affirm payments. The Affirm logo will always display after this text. |
affirm.confirm.backbuttontext | You have no subscription products. | Within the confirm Affirm payment screen. This is the button to go back to the payment screen. |
affirm.confirm.text | If you finance your purchase with Affirm, the first payment date is only an estimate. Your loan and payment schedule will be finalized 5 days before delivery or 90 days after checkout, whichever comes first. | Within the confirm Affirm payment screen. This is the description for Affirm payments. |
Detailed Setup Guide
Configure Affirm Product
Assign Is Affirm Eligible Product Classification
1. Configure Affirm Product
Affirm payments can be configured on almost any product in your store products are set up similarly to other products. There are no attribute or add-on requirements or disqualifiers (aside from the below).
NOTE: Remember that gift cards and resort charge products cannot be paid for with Affirm. Do not add the Is Affirm Eligible product classification to these products.
2. Assign Is Affirm Eligible Product Classification
Affirm products require the Is Affirm Eligible Product Classification is added.
Go to Aspenware Commerce > Product Classifications.
Select Add Assignment.
Find the desired Category and then Product from the drop-down.
If the Affirm eligibility changes depending on the attribute value, check the specific attribute value (e.g. Adult) as well.
Select the ‘Assign’ checkbox next to the Is Affirm Eligible classification.
Scroll to the bottom and click Add.
HINT: Affirm payments can be used to pay for products as long as every product in the cart is eligible for Affirm. If any products are added to cart which are not eligible, Affirm will be removed as an available payment method (that is, the entire cart must have only Affirm-eligible products or Affirm cannot be used as a payment method).