Skip to main content

Merchant Help

 

Affirm Merchant Help

Web Shop Manager Integration

Overview

This guide describes how to integrate Affirm into the Web Shop Manager platform so you can provide Affirm as a payment option to your customers. After integrating Affirm, your Web Shop Manager site will:

  • Offer Affirm as payment option on the checkout page
  • Process Affirm charges in your order management system
  • Display Affirm promotional messaging

The integration steps are:

  1. Contact Web Shop Manager
  2. Configure Affirm as a payment method
  3. Test your integration
  4. Set live

Before you begin

Before beginning integration, you should review:

Sandbox development

You should have received an email inviting you to create an Affirm account. Click here for information about accessing your account.

Develop and test the Affirm integration in your development environment connected to our sandbox. To use our sandbox, retrieve your sandbox API keys at https://sandbox.affirm.com/dashboard/#/apikeys for use during integration.

After development and testing, you'll need to update your integration to use your live API keys, which you can find at https://affirm.com/dashboard/#/apikeys.

1. Contact Web Shop Manager

To use Affirm with Web Shop Manager, contact your Web Shop Manager account manager to have them enable it for you.

2. Configure Affirm as a payment method

  1. Sign in to your Web Shop Manager admin portal
  2. Go to System > Configuration > Payment & Processing > Payment Method > Affirm
  3. Enter the Affirm Public Key and Affirm Private Key (private key) you retrieved from the sandbox merchant dashboard
  4. Enter the dollar amount values for Minimum Price that displays Affirm as a payment option to your customers when checking out (optional)
  5. Check the Affirm Messaging checkbox and enter a data-promo-id value (default value is promo_set_default_fp)
  • Shopping Cart Messaging - Displays Affirm promotional messaging on the cart page
  • Product Messaging - Displays Affirm promotional messaging on the product pages
  • Category Messaging - Displays Affirm promotional messaging on the category pages
  1. Modify Affirm Promotional Messaging Customization to customize the promotional messaging on the cart, product, and category pages
  • Message Type (logo or text) Display
  • Affirm Logo Color (blue or black)
  • Enable Learn More Popup link
  1. Coordinate with Web Shop Manager to add the following affirm_header Smarty widget tag into the head of the site templates:
<!DOCTYPE html>
<!--[if lt IE 7]> <html class="no-js lt-ie9 lt-ie8 lt-ie7" lang="en">
<![endif]-->
<!--[if IE 7]> <html class="no-js lt-ie9 lt-ie8" lang="en">
<![endif]-->
<!--[if IE 8]> <html class="no-js lt-ie9" lang="en"> <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en"> <!--<![endif]-->
<head>
{{ affirm_header }}
</head>

If you’re using Cloudflare’s CDN, Web Shop Manager will need to purge the cache after you finish configuring Affirm.

Screen Shot 2018-07-24 at 3.32.25 PM.png

3. Test your integration

After configuring Affirm, contact your Affirm Client Success Manager to place a test order.

4. Set live

After testing, set your Web Shop Manager store to our live environment.

  1. Retrieve your live API keys at https://affirm.com/dashboard/#/apikeys
  2. Sign in to your Web Shop Manager admin portal
  3. Go to System > Configuration > Payment & Processing > Payment Method > Affirm
  4. Enter the Affirm Public Key and Affirm Private Key (private key) you retrieved from the live merchant dashboard