Skip to main content

Merchant Help

 

Affirm Merchant Help

Zoey Integration

Overview

The Affirm Zoey integration:

  • Enables the Affirm payment method in your checkout
  • Adds Affirm promotional marketing messages to your product, category and cart pages
  • Manages orders paid with Affirm

Retrieve keys

  1. Sign in to https://sandbox.affirm.com/dashboard
  2. Retrieve API keys
    1. Hover over the profile icon area at the lower-left of the page.
      Screen Shot 2016-03-22 at 7.56.58 AM-2.png
    2. Click the API Keys link that appears.
      Screen Shot 2016-03-22 at 7.56.20 AM.png
    3. Copy the public, private, and financial product keys.

Install Affirm

Affirm App Installation
  1. Visit https://www.zoey.com/apps/affirm and click on Get App
Affirm as a payment method
  1. In your Zoey admin, visit Set-up > Payment > Affirm > Set-up
  2. Set Enabled to Yes 
  3. Keep the Mode set to Sandbox for development and testing 
  4. Enter the Public API Key that you retrieved from the Affirm Merchant Dashboard
  5. Enter the Secret Key that you retrieved from the Affirm Merchant Dashboard
  6. Enter the Financial Product Key that you retrieved from the Affirm Merchant Dashboard
  7. If you currently automatically capture, change the Payment Action to Authorize and Capture
  8. Adjust the order-total minimum and maximum options to control when Affirm is shown to your customers
  9. If you want to change the order of displaying Affirm as a payment method during checkout, enter a number in Sort Order greater than 0
  10. If you want to disable Affirm when a backordered item is in the cart, change the Disable for backordered items to Yes
  11. If you want to change the appearance of Affirm to display as text instead of a logo during checkout, change Plain Text Appearance to Yes
  12. In-line HTML can be used to update the default Affirm logo and sub-text in the Affirm Payment Method HTML (Only available if Plain Text Appearance is set to No)
  13. Change the Enabled Checkout Button to Yes to display Affirm button on the cart page. Affirm Button URL can be updated in the Checkout Button Code
  14. Keep checkout uses xhr as Auto Detect
  15. Keep Create orders after Affirm confirmation as Yes. If you select No, orders are created as soon as a user begins the Affirm checkout flow

zoey-settings.png

 

Affirm Promotional Messaging

To enable Affirm promotional banners on various pages across your site:  

  1. Visit Set-up > Payment > Affirm Promos > Set-up
  2. In the General Settings, enter the Affirm Promo Key
  3. Change Enabled to Yes 
  4. Customize the Promo Size and Promo Position under individual Page Settings with any of the pre-defined values

    zoey-banner.png

 

To enable monthly payment pricing and modal on product description, category and shopping cart pages:

  1. Visit Set-up > Payment > Affirm Promos > Set-up
  2. In the As Low As Functionality settings, select Yes for Enable for Product PDP, Enable For Category PLP, Enable for Shopping Cart  to enable monthly payment pricing on product, category and cart pages
  3. Enter a MPP min amount value to set a minimum threshold amount for displaying monthly payment pricing.  Ex: Setting 100 as the value here will only display monthly payment pricing for products above $100
  4. Optional: Add a promo-id value in Default Affirm Promo ID (provided by the Affirm Client Success Team) 

zoey-ala.png

Multiple Financing Programs 

Multiple Financing Programs (MFP) allows you to selectively offer a specific custom financing program to consumers based on product or cart attributes that are defined in Zoey. MFP setup is optional and the values are provided by Affirm. Zoey integration uses our Affirm Magento extension and information on MFP setup can be found here - Magento Multiple Financing Programs. Note: Category based MFP is unavailable as category attribute is not available for customization on the Zoey platform.


Test your Affirm configuration

Test your configuration to ensure that everything is working before you go live. Email  merchanthelp@affirm.com with a link to your test site so that we can verify your configuration and provide you with production keys.

  1. Add an item to the cart on your test site.
  2. Proceed to checkout.
  3. During checkout, enter valid U.S. addresses and mobile-phone information. Affirm cannot test your configuration if the address or phone information is fake.
  4. Select Affirm as the payment option.
  5. Proceed to Affirm's testing environment checkout.

Note: The URL https://sandbox.affirm.com indicates that you are in the testing environment.

6. When prompted for your security PIN, enter 1234.

7. Select terms.

8. Confirm your loan.

 

9. Wait to ensure that you have been redirected to your confirmation page.

10. Verify that the transaction appears in your platform's admin panel and on  sandbox.affirm.com/dashboard

Note: When a customer completes checkout with Affirm as the payment method, Affirm authorizes a charge for the amount of the order. The charge appears in a pending state on the customer’s Affirm account. Authorized transactions expire if they are not captured before the capture deadline. The default capture deadline is specified in your partnership agreement with Affirm. If you did not specify your authorization-period requirements because of inventory, pre-orders, or shipping time in your onboarding form, please email merchanthelp@affirm.com for help with completing this process.


Go live with Affirm financing

After you verify that your configuration is working properly in the Affirm Sandbox environment, your Affirm Client Success Manager will activate your Affirm Live environment access. This will allow you to sign into the Live version of the Merchant Dashboard, as well as access your Live API keys.

Retrieve Live API keys

  1. Go to the API keys page in the Affirm dashboard.
  2. Retrieve your live API keys.
  3. Enter the live API keys into your integration/platform.

Note: The email address that you use to access the dashboard must be registered as a Google account. Check to see if your existing email address is a Google account or create a new Google account. You can link your existing work email address to a Google account by signing up without Gmail.

Update Affirm URL and script references

  1. Affirm JS URL: https://cdn1.affirm.com/js/v2/affirm.js
  2. Affirm API base URL: https://api.affirm.com