Known installation issues

You may encounter Column not found SQL errors during installation. Ensure that you have the correct permissions to update the core Magento database tables. Because the installation process updates many of the database tables, you’ll need to re-index the flat category table to resolve any SQL errors that occur during installation by doing the following:

Go to System > Configuration > Catalog pane > Frontend

Set Use Flat Catalog Category to Yes

Click Save Config

Go to System > Configuration > Index Management

Click Reindex Data for Category Flat Data

You may need to run the re-index command via shell:

php indexer.php --reindexall

2. Configure Affirm as a payment method

After installing the extension, enable Affirm as a payment method by updating Magento’s configurations:

Sign in to your Magento admin portal

Go to System > Configuration > Sales > Payment Methods > Affirm

Set Enabled to Yes

Keep Mode set to Sandbox (for development and testing)

Enter the Public API Key and Secret Key (private key) you retrieved from the Affirm sandbox merchant dashboard

If your checkout process automatically captures the charge, set Payment Action to Authorize and Capture

Enter the dollar amount values for Minimum Order Total and Maximum Order Total that displays Affirm as a payment option to your customers when checking out (optional)

If you want to change the order of displaying Affirm as a payment option during checkout, enter a Sort Order value greater than 0

If you want to disable Affirm when a backordered item is in the cart, set Disable for backordered items to Yes

If you want to display Affirm as text instead of a logo during checkout, set Plain Text Appearance to Yes

If you want to customize the default Affirm logo and subtext (Affirm must approve), you can add in-line HTML to Affirm Payment Method HTML (requires Plan Text Appearance set to No)

Set Enabled Checkout Button to Yes to display the Affirm button on the cart page (you can update the Affirm button URL in the Checkout Button Code)

Keep checkout uses xhr set to Auto Detect

Keep Create orders after Affirm confirmation set to Yes (No creates orders as soon as the user begins the Affirm checkout)

You can optionally enter a Promo ID value in Data Promo ID (contact the Affirm Client Success team for more information about Promo ID’s)

Use Multiple Financing Programs

Multiple Financing Programs (MFPs) allow you to offer custom financing programs to your customers based on rules you define in Magento. To use MFPs in Magento, you must be running version 3.3.0 or higher of the extension. To learn more about MFPs and how to set them up in Magento, contact your Client Success Manager.

4. Add the Confirmation Page function

In the Enhanced Analytics section, set Enable pixel for confirmation page to Yes

5. Review your order management functions

Processing orders (authorize, void, invoice, or credit memo) in Magento updates the order status in the Affirm dashboard. While you can process orders in the dashboard, we strongly recommend using Magento to keep order status synced with Affirm. Click here for more information.

6. Test your integration

After completing your integration, do a thorough testing of both your front-end and order management functions in our sandbox to ensure that everything works as expected. Click here for our recommended test plan. However, you’ll need to tailor your testing plan to your specific systems, processes, and integration.

7. Deploy to production

Coordinate testing with Affirm

Before deploying the Affirm integration to your production site, Affirm will need to test it in your development or staging environment connected to our live environment. Contact your Client Success Manager to coordinate this test.

Connect to the live Affirm environment

Enter the Public API Key and Secret Key (private key) you just retrieved from the Affirm merchant dashboard

Launch to production

After you’ve connected to our live environment and we’ve tested your integration, you’re ready to deploy to your production environment and offer Affirm as a payment option to your customers.

FAQ

How do I update my merchant or brand name in the Affirm checkout flow if multiple sites operate under same Affirm account?

If you have multiple sites operating under a single Affirm account, you can override the external company or brand name that the customer sees by adding a name field to the checkout object in the Magento extension payment.php file. This affects all references to your company name in the Affirm UI.

How do I modify the monthly payment messaging placement on the product detail page?

You can use a different reference name to place monthly payment messaging on the product detail page based on the page’s layout. You’ll need to modify reference name in your affirm.xml layout file by replacing the product.info.extrahint reference name with any other reference name based on your layout structure. If you’re looking for a way to position blocks before or after other blocks in the layout, you can modify the before and after block attributes. Some reference name examples to use instead of product.info.extrahint from the standard product page layout structure include alert.urls, product.info.social, and product.info.addtocart.

You may need to adjust the styles based on your layout structure and theme templates.