Skip to main content

Merchant Help

 

Affirm Merchant Help

Monthly Payment Messaging API

Overview

Email Service Providers can include Affirm Monthly Payment Messaging in email templates using the Affirm Monthly Payment Messaging API. This document is intended to instruct an ESP on what a direct integration with Affirm looks like, how to complete that integration, and how to best highlight those benefits for their merchant clients.

Integrate Affirm into your ESP platform

  1. Create a proof of concept (POC) using the Integration instructions below.
  2. Create Affirm tags that clients can insert into their email templates
  3. Store merchant-specific Affirm API credentials for making requests to the Monthly Payment Messaging API.
  4. Implement server-side logic that dynamically populates those tags using responses from the the Affirm Monthly Payment Messaging API.
  5. Test the implementation.
  6. Become certified as an Affirm Marketing Partner (AMP).

Develop marketing collateral

Affirm is a natural compliment to ESPs, as both businesses can bolster the success of our mutual merchant clients. Affirm increases the value that an ESP can offer by providing additional incentives that can be presented to the customer. These benefits are best articulated through marketing collateral, such as white papers or solution designs, that is developed as a joint effort between Affirm and your team.

Integration

  1. Collect the loan amount, APR, and loan term length.
  2. Make a call to the Monthly Payment Messaging API using curl.
  3. Parse the JSON response. Pull out the monthly price and related messaging.
  4. Include that Monthly Payment Messaging in your email template.

Collect the loan details

  • Amount
    • Expressed in integer USD cents.
    • e.g.,$535.49 -> 53549
    • Maximum: 3000000
    • Minimum: 5000
       
  • APR
    • Expressed as a decimal percentage.
    • e.g., 10% -> 0.10
    • Should remain constant for a given merchant or merchant promotion
    • Maximum: 0.30
    • Minimum: 0.00
       
  • Term length
    • Expressed in months.
    • e.g., 12 months -> 12
    • Should remain constant for a given merchant or merchant promotion
    • Maximum: 18
    • Minimum: 3

Make the API call

Extracting the monthly price, terms, and disclosures

The response from the Monthly Payment Messaging API will look like this:

{"disclosure": "Based on the purchase price of $1352.00 at 10% APR for 12 months", "months": 12, "payment_string": "119", "payment": 11886}
  • Terms and disclosures are specific to the loan parameters (amount, APR, and term length)
  • Loan parameters depend on the financing programs that the merchant has available.
  • Any monthly payment price should also include in-line descriptions or a link to descriptions of the price calculation, such as:

    "Starting at $44 a month with Affirm for a product price of $500 and 10% APR over 12 months."

Tracking Affirm promotions

To track what financing programs are available at a given time, and what loan parameters can be specified, the merchant will need to proactively communicate that information to you. Merchants will be aware of what financing programs are active at a given time.

In addition, you should provide an ability to add tracking parameters to all the outgoing links that have Affirm branded messaging within the email template. Below is the list of parameters that can be appended as query parameters to the outgoing links (Ex: Affirm promotional messaging sends the customers to a cart page, the string used within the email template should add these parameters, https://www.example.com/cart?aff_cid=unique_value&aff_fm=t)

  • aff_cid="unique_value" (Required) - Unique value, either already available or created, which provides tracking information about the email service provider and/or the merchant
  • aff_fm="t" (Optional) - Forces the Affirm educational modal to open when a customer lands on the page where Affirm promotional messaging is available

Compliance

  • We all are responsible for making sure that financing programs are kept up-to-date, so that 0% loan parameters are not communicated to users when that program is unavailable on the merchant's site.
  • Examples of financing program depdendencies:
    • A merchant offers only standard terms of 10-30% APR, then monthly prices can assumed to be calculated at 10% APR at 12 months. (6 months if between $50-100)
    • A merchant offers 0% APR, then monthly prices can assumed to be calculated at 0% APR at 12 months when their 0% financing program is active.
  • Any time a monthly price is communicated to users, it must have accompanying disclosures or information that explain how that monthly price was calculated.
  • As a result, any monthly price should also include in-line descriptions or a link to descriptions of the price calculation, such as:

    "Starting at $44 a month with Affirm for a product price of $500 and 10% APR over 12 months."

Marketing to merchants

Benefits of combining Affirm and your Email Service

  • Monthly price for the customer's product or shopping cart lowers barriers for purchase
  • Existing Affirm customers can checkout more quickly
  • Bundling products and showing a monthly price for the entire shopping cart leads to higher AOV

Requirements

  • Coordinate with your Email Service Provider to provide them with your:
    • Affirm public API key
    • Current loan parameters (APR, term length)
  • Update your abandonment/retargeting emails to include the Affirm Monthly Payment Price