Skip to main content

Merchant Help

 

Affirm Merchant Help

Kibo (Mozu) Integration

Overview

This guide describes how to integrate Affirm into the Kibo (Mozu) eCommerce platform so you can provide Affirm as a payment option to your customers. After integrating Affirm, your Kibo 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. Install Affirm
  2. Configure Affirm as a payment method
  3. Review your order management functions
  4. Add the Confirmation Page function
  5. Test your integration
  6. Deploy to production

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. Install Affirm

To install the Pay with Affirm Application by Kibo eCommerce on your site, do one of the following:

We recommend either of the first 2 options. Only build the application if you need a highly customized integration. However, we still recommend working with a professional services partner when doing so. Building the application requires that you have Arc.js installed on your site. Talk to your sales or services representative for more information.

Update your Kibo theme

After installing Affirm, you’ll need to merge the Affirm theme with your current Kibo theme. This adds the Affirm payment option during checkout and adds Affirm promotional messaging on your product and cart pages.

  1. Download the Affirm theme
  2. Review and apply the changes to your current Kibo theme
  3. Install the updated Kibo them to the sandbox
  4. On the Kibo admin page, go to Main > Site Builder > Themes
  5. Click the options menu (3 horizontal dots) and click Apply

2. Configure Affirm as a payment method

  1. Sign in to your Kibo admin portal
  2. Go to System > Settings > Payments
  3. In the PayWithAffirm section, click Enable
  4. Set Environment to Sandbox (for development and testing)
  5. Set Affirm Custom Enable Status to
  • Yes to enable promotional messaging and the Affirm checkout payment option
  • Testing to enable promotional messaging and the Affirm checkout payment option only when the URL includes the parameter affirm.test=true
  1. Enter the Public API Key and Private API Key you retrieved from the Affirm sandbox merchant dashboard
  2. You can optionally enter a Promo ID value in Affirm Promo ID and a minimum order value that displays Affirm as a payment option to your customers during checkout in Affirm Amount Threshold (the Affirm Client Success team provides both values).
  3. Set Order Processing to
  • Authorize and Capture on Order Placement to authorize and capture payment when a customer places an order
  • Authorize on Order Placement and Capture on Order Shipment to authorize payment when a customer places an order, but captures the payment only when the order ships
  1. Set Allow refund amount to be less than capture amount to
  • Yes to enable partial refunds
  • No to ensure that the refund amount always equals the captured amount
  1. In Message: Checkout - Affirm Selected, enter the message shown on the checkout page when the customer selects Affirm (entering no message displays,“Continuing will take you to the Review Order page. You will then be redirected to Affirm to securely complete your purchase.”)
  2. In Message: Checkout - Affirm Disabled, enter the message shown on the checkout page when the Affirm option is not available because the order amount does not exceed the Affirm Amount Threshold (entering no message displays, “Monthly Payments with Affirm for single-item carts ${0}+”)
  3. In Message: Checkout - Affirm Selected, enter the message shown in the checkout review step after the customer selects Affirm in the previous step (entering no message displays, “You will be redirected to Affirm to securely complete your purchase. It's quick and easy--get a real-time decision!”)
  4. Click Save
  5. In the Kibo admin main page, go to System > Customization > Applications
  6. Select the Affirm Payments application
  7. Click Enable App

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

Use Multiple Financing Programs

Multiple Financing Programs (MFPs) allow you to offer custom financing programs to your customers based on rules you define in Kibo. To learn more about MFPs and how to set them up in Kibo, contact your Client Success Manager.

3. Review your order management functions

Processing orders (authorize, void, refund, and partial refund) in Kibo updates the order status in the Affirm dashboard. While you can process orders in the dashboard, we strongly recommend using Kibo to keep order status synced with Affirm. For more information on processing orders in Kibo, refer to their documentation.

4. Add the Confirmation Page function

When a customer completes their purchase, you can send their order and product information to Affirm for A/B testing, which will help you optimize your site. Send this information by adding the Confirmation Page function to your payment confirmation page. We only require orderId, total, productId, and quantity for A/B testing.

Click here for all the Confirmation Page function parameters.

affirm.analytics.trackOrderConfirmed({
    "orderId": "T12345",
    "total": 3739
}, [{
    "productId": "SKU-1234",
    "quantity": 1
}, {
    "productId": "SKU-5678",
    "quantity": 1
}]);

Required function parameters

Order object

Parameter Type Description
orderId string Your internal unique identifier representing the order. Maximum 500 characters.
total integer The total amount of the transaction, including tax and shipping, stated in USD cents (e.g., $100 = 10000).

Product object

Parameter Type Description
productId string Your internal unique identifier representing the product, such as the SKU or an internal database identifier. Maximum 500 characters.
quantity integer The quantity of the purchased product.

5. Test your integration

After completing your integration, do a thorough testing of both your front-end and order management functions in our sandbox to ensure that everything works as expected. Click here for our recommended test plan. However, you’ll need to tailor your testing plan to your specific systems, processes, and integration.

6. Deploy to production

Coordinate testing with Affirm

Before deploying the Affirm integration to your production site, Affirm will need to test it in your development or staging environment connected to our live environment. Contact your Client Success Manager to coordinate this test.

Connect to the live Affirm environment

  1. Retrieve your live API keys at https://affirm.com/dashboard/#/apikeys
  2. In the Kibo admin portal, go to System > Settings > Payments
  3. Set Environment to Production
  4. Enter the Public API Key and Private API Key you retrieved from the Affirm merchant dashboard

Launch to production

After you’ve connected to our live environment and we’ve tested your integration, you’re ready to deploy to your production environment and offer Affirm as a payment option to your customers.