HomePaymentsPlatformsGlobal Integration
DocsRecipesAPI referenceChangelog
HomePaymentsPlatformsGlobal IntegrationLog In

## Overview

This guide provides step-by-step instructions for installing and configuring our payment gateway within WooCommerce. After you have successfully set up Affirm, your WooCommerce site will:

  • Present Affirm as a payment option during the checkout process.

  • Seamlessly handle Affirm charges within your order management system.

  • Showcase Affirm's promotional messaging.

Once the Affirm extension is installed, this guide will further assist you in customizing Affirm's diverse features to elevate the overall customer experience.

## Install the Affirm WooCommerce extension

  1. Download the extension [here](🔗).

  2. In your WordPress dashboard, navigate to **Plugins > Add New**.

  3. Click the **Upload Plugin** button and click **Choose File** to select the file you just download.

  4. Click **Install Now** then **Activate**.

## Configuration

Follow the steps below to configure your general Affirm settings.

  1. Navigate to **WooCommerce > Settings > Payments** and select **Affirm**. This takes you to the Settings screen.



_Payments_ was formerly called _Checkout_ prior to WooCommerce 3.4.



  1. **Enable/Disable** – Enable to use. Disable to turn off.

  2. _If displayed_, leave the **default title** as “**Affirm Pay over time**” and **description** as “**You will be redirected to Affirm to securely complete your purchase. It's quick and easy—get a real-time decision!**” unless instructed by Affirm.



  1. Select **Expand** to show **Affirm Account Settings**.

  2. Enable **Affirm Sandbox** if developing or testing before going live. Remember to disable when done.

Affirm Sandbox

Disable when done.

  1. Set your **Region** to **US** for a US store.

  2. Enter the **Public Key** from your [Affirm dashboard](🔗). (_If testing, use your [Affirm sandbox public key](🔗)_).

  3. Enter the **Private API Key** from your [Affirm dashboard](🔗). (_If testing, use your [Affirm sandbox private key](🔗)_).

  4. Choose whether **Language Selector** should be based on **Site Language** or **Browser Language**. (_For US store, leave this as Site Language_.)

  5. Select a **Transaction Mode**:

  • Authorize obtains payment authorization only.

  • Authorize and Capture obtains authorization and captures funds.

  1. Enable **Partial Capture** _only_ if instructed by Affirm support.

  2. Select a **Checkout Mode**:

  • Modal triggers a pop-up during checkout.

  • Redirect takes the customer offsite to check out.

  1. Select **Inline Checkout Messaging** to enable Inline checkout value props on the checkout page.

  2. Select a **Cancel Affirm Page**:

  • Cart Page – takes customer to cart.

  • Payment Page – takes customer back to payment.

  • Checkout Page - takes customer back to checkout.

  • Custom URL - takes customer to custom URL.

  1. Enter **Permalink/Custom Cancel URL** _only_ if you selected **Custom URL** for Cancel Affirm page.



  1. Select **Expand** next to **Promotional Messaging Settings**.

  2. Check to **Enable category promotional messaging** to include promotional messaging on category level pages.

  3. Check to **Enable product promotional messaging** to include promotional messaging on product level pages and select placement of product page messaging. (_if unsure, select After Product Price_.)

  4. Check to **Enable cart promotional messaging** to include promotional messaging on category level pages.

  5. Select an **Affirm Color** – **Blue, Black or White for the logo**.

  6. Check **Show Learn More** to display a link in Affirm monthly payment messaging.

  7. Enter your **Affirm Promo ID** (_optional_) to display Affirm with different styling, messaging, or loan terms. Only enter a Promo ID if instructed by Affirm.



  1. Select **Expand** next to **Advanced Settings**.

  2. Set **Order Minimum** – set minimum cart total to display Affirm as a payment option. If unsure, leave the default value of $50.

  3. Set **Order Maximum** – set maximum cart total to display Affirm as a payment option. If unsure, leave the default value of $30000.

  4. Select **Enable Debugging messages** if troubleshooting. Otherwise, leave disabled.

  5. Leave **Enable Enhanced Analytics unchecked**.

  6. Check to **Display Merchant Fee**. If unsure, leave the default.



  1. Click **Save changes**.

## How inline checkout works

Inline support

  • Inline is available for our **Installment**, **<<glossary:Pay in 4>>** and **Hybrid** financing options.

  • **Affirm Lite** and **Adaptive Checkout** are not supported at this time.

When a customer selects Affirm as a payment option, the view expands and renders the following information in your site:

  • **Value props**: Highlights some of the benefits of paying with Affirm.

  • **Learn more about Affirm**: A learn more link that opens our educational modal.

  • **Payment timelines**: The timeline and amount for each payment.

This image displays the Inline flow for Split pay and Installment options


This image displays the Inline flow for <<glossary:Pay in 4>> and Installment options.