HomePaymentsPlatformsGlobal Integration

## Overview

Affirm promotional messaging components---monthly payment messaging, Split Pay messaging, and educational modals---show your customers how they can use Affirm to finance their purchases. Our promotional messaging allows you to:

  • Dynamically display payment pricing information which includes monthly and Split Pay loan terms 

  • Offer prequalification

  • Customize messaging and design with co-branded assets

This guide will review Affirm promotional messaging and tell you how to add it to your Shopify site. We also offer this guide **en Français**, which can be accessed [here](🔗).



Manually editing your theme files requires making changes to the code. We recommend using an experienced front-end developer to avoid any potential errors.

## Promotional messaging

Examples of available messaging

**Pay Monthly**:

  • Starting at $88 / month with Affirm. Learn More

  • Starting at $88 per month with Affirm. Prequalify

**Pay in 4**:

  • 4 interest-free payments with Affirm. Learn More

  • 4 interest-free payments of $125 bi-weekly with Affirm. Learn More

Monthly payment and Split Pay messaging consists of concise copy that offers price-specific information and contains a link that triggers an educational product modal.

#### Example of monthly payment message:



#### Example of Split Pay message:



_Please note that this above monthly and Split Pay “as low as” promotional messaging is acceptable for use in Québec as the “Learn more” triggers the educational modal which includes a chart that displays all loan terms. Please refer to the Québec Marketing Guidelines below for more information._



## Educational modals

Educational modals are pop-up windows that offer more information about Affirm. They also provide prequalification, which allows your customers to discover how much they qualify to spend with Affirm on your site early in their shopping process. After completing the application and finishing shopping, the prequalified amount is automatically applied at checkout when they select Affirm as their payment option. There are two types of educational modals:

  • Product modals provide price-specific information. Clicking the monthly payment message triggers the product modal.

  • Site modals offer general information about Affirm and do not include pricing information. Any HTML element can trigger a site modal, though these are typically links on Affirm-related landing pages, site banners, or your home page.





Marketing guidelines

You can review the following marketing guidelines for specific messaging, placement, and layout guidance:

  • [Affirm CA 2022 Brand Guidelines for Merchants](🔗)

  • [Affirm CA 2022 Merchant Transition Toolkit](🔗)

  • [Affirm CA 2022 Québec Marketing Guidelines](🔗)

  • [Affirm CA 2022 Web Info Page Guidelines for Merchants](🔗)



️ Transitioning from PayBright prequalify widget to Affirm

**Note**: If you have previously installed the PayBright prequalify widget, you will need to overwrite the PayBright code with Affirm's code referenced below.

### 1. Add Affirm.js

Add the Affirm.js embeded code at the top of the theme file in your Shopify store.

#### Static country/locale

A static country/`locale` is considered a store that will _only_ operate in **one language**: French _or_ English. The code snippet below is intended for use with a static country/`locale`.


#### Dynamic country/locale
A dynamic country/`locale` is considered a store that will offer **multiple languages** on a single site, allowing their customer to select a language: French _and_ English. The code snippet below is intended for use with a dynamic country/`locale`.

#### Locale
The `locale` parameter allows Affirm to identify which locale you are serving your site in for any particular user. For example, let's say that you're rendering your site in Canadian French; perhaps this occurred because the user's browser setting detected Canadian French. You can provide Affirm with the user's language setting by passing it in the `locale` parameter. Affirm will then read the locale and translate the pages accordingly, thus, matching the language the user had seen on your site. However, we will not attempt to read the user's locale directly.
#### Country_code
The `country_code` parameter represents the country of legal incorporation of your store, which is shown to any given user. So, if you're showing your Canadian website/store to a user and you have a legal presence in Canada, you would pass CAN into the `country_code` parameter. This allows us to determine which regulations to abide by and which banks to partner with for this transaction.
#### Supported values for `locale` and `country_code`
Affirm supports the following combinations for `locale` and `country_code`:
`country_code`:`USA`
`locale`:`en_US`- (Language= English`en`- Country= United States `US`-  for a `locale` that reads `en_US`)
`country_code`:`CAN`
`locale`:`en_CA`- (Language= English`en`- Country= Canada `CA`-  for a `locale` that reads `en_CA`)
`locale`:`fr_CA`- (Language= French`fr`- Country= Canada `CA`-  for a `locale` that reads `fr_CA`)
The following will occur when a `locale` and/or `country_code` is not provided:
  • When a `locale` is _not_ provided, the `locale` will default to `en_US` (English speaking US).
  • When a `country_code` is _not_ provided, the `country_code` will default to `USA`.
1\.  Sign in to your Shopify admin page at **yourstore.myshopify.com/admin/**.
2\.  From the navigation menu on the left, go to **Online Store > Themes**.
3\.  On the menu to the right of the theme, click **Actions**.
4\.  Click **Edit Code**.
5\.  Search for the `theme.liquid` file and add the above `Affirm.js` embed code to it before the closing the </head> tag.
6\.  In the embed code, replace `public_api_key` with your public API key found in the [merchant dashboard](🔗). 
7\.  Click **Save**. 
### 2. Find your Shopify theme files

To add the HTML for Affirm promotional messaging, you'll need to edit your store's theme files. To find them:
1\.  Back on your main page page, go to **Online Store > Themes**.
2\.  On the menu to the right of the theme, click **Actions**.
3\.  Click **Edit Code**.
4\.  Find the file navigation menu on the left side and find the following template files:
  • product.liquid
  • cart.liquid
  • checkout.scss.liquid (Shopify Pro only) 
### 3. Add promotional messaging components

Add an HTML element everywhere you want to display an Affirm promotional messaging component.
To add promotional messaging to your product page:


Add promotional messaging to your cart page:

### 4. Add code to handle price changes

The Shopify product page (`product.liquid`) uses JavaScript to update the product price as the customer changes product options and variants. You can add the following code to the existing `selectCallback` function so to always update the monthly payment messaging:
Notes:
  • Only use the Affirm embed code when using product variant 
  • The selectCallback function might not be in your product.liquid template if the product variants are not used or supported

When using product variants in your shop, use the following code to dynamically update your Monthly Payment Messaging when the customer selects a different product variant:

The Shopify mini-cart and cart page (cart.liquid) use AJAX to keep pricing up to date. Therefore, there is no need to hook into the selectCallback JavaScript function.
## Troubleshooting
**Price variables**
The variable that you use for product prices and cart totals may vary, based on your current Shopify theme and functionality.
**Product page** 

Learn more about product.liquid
Learn more about the `product.liquid` file [here](🔗).
**Shopping cart**

Learn more about cart.liquid
Learn more about the `cart.liquid` file [here](🔗).