Skip to main content

Merchant Help

 

Affirm Merchant Help

Kibo NG (Mozu) Integration

Overview

Affirm Kibo NG app enables the Affirm payment method in checkout, as well as the promotional messages on the product and cart pages.


Installation

Install the Affirm Application

There are two options for adding Affirm functionality to your tenant:

  1. (Recommended) Contact your Kibo eCommerce sales or professional services representative to install the Pay with Affirm Application by Kibo eCommerce on your tenant.
  2. Build the application from the Kibo eCommerce-provided code on GitHub - https://github.com/Affirm/KiboNG_Affirm and install it in Dev Center. This option requires that you have Arc.js enabled on your tenant, and is only recommended if you are working with Kibo eCommerce Professional Services or a Kibo eCommerce Partner and need a highly customized integration. Contact your Kibo sales or professional services representative for more information.
Update Your KiboNG Theme

The Affirm theme should be merged with your current KiboNG theme to support Affirm on your storefront. It enables the payment promotional messages on your Product and Cart pages, and adds the Affirm option into the Payment step in Checkout. 

To install the Affirm Payment theme: 

  1. Get the Affirm Payment theme from: https://github.com/Affirm/KiboNG_theme_Affirm , which contains the full source files for the Kibo eCommerce Core 9 theme, with the required changes to enable Pay with Affirm.
  2. Review and apply the changes to your own theme.
  3. Install the updated theme to your sandbox.
  4. Apply the updated theme to your storefront: 
    • In Admin, go to Main → Site Builder → Themes
    • Click the options menu (three horizontal dots) next to the new theme and select Apply.

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.

Configuration

Once your Affirm Payment App is installed, you must configure your Affirm account credentials and promotional messaging into your payment settings in Admin

  1. In Admin, go to System → Settings → Payments.
  2. Locate the PayWithAffirm section and click Enable.
  3. Select the Affirm environment to use:
    • Sandbox: Use Affirm’s sandbox environment for testing.
    • Production: Use Affirm’s production environment.
  4. Set the Affirm Custom Enable Status. This configuration allows a soft deploy of the Affirm features into production environments:
    • Yes: Enables Affirm Promotional messaging and the checkout payment option on the storefront.
    • Testing: Enables testing mode handled by the storefront URL requests. Affirm testing mode allow a soft move to production of the module. When this configuration is set, Affirm will be enabled into the storefront when the url includes the parameter affirm.test=true. This parameter can be added manually in the browser url on each request to test the Affirm behavior in the live site.
    • No: Disable Affirm Promotional messaging and the checkout payment option on the storefront.
  5. Set the following values (from your Affirm account dashboard):
    • Public API key
    • Private API key
  6. The Affirm Customer Manager will provide the following data:
    • Affirm Promo ID: Value provided by Affirm. Optional
    • Affirm Amount Threshold: All orders over the amount indicated will be able to use Affirm payment type. Optional
  7. Select the Order Processing method to use:
    • Authorize and Capture on Order Placement: Authorize AND capture payment when an order is placed.
    • Authorize on Order Placement and Capture on Order Shipment: Authorize payment when an order is placed, but do not capture the payment until the order has shipped.
  8. Allow refund amount to be less than capture amount:
    • Yes: Enable Partial Refunds, allow the admin user to Refund amounts less than capture amount
    • No: Refund amount should always be equal to the amount captured
  9. Set the Storefront Configurable messages:
    1. Message: Checkout - Affirm Selected: This message is shown on the checkout page when the Affirm option is selected. If it's empty, the default message will be used: Continuing will take you to the Review Order page. You will then be redirected to Affirm to securely complete your purchase.
    2. Message: Checkout - Affirm Disabled: This message is shown on the checkout page when the Affirm option is not available to the shopper because the order is not over the amount threshold. If it's empty, the default message will be used: Monthly Payments with <span class='affirm-logo-local color f-14'>Affirm</span> for single-item carts ${0}+
    3. Message: Checkout - Review Step: This message is displayed in the checkout review step when Affirm is selected in the previous step. If it's empty, the default message will be used: You will be redirected to Affirm to securely complete your purchase. It's quick and easy--get a real-time decision!
  10. Click Save to save your Affirm settings.

Picture4.png

 

After completing the configurations, enable the Affirm Application in KiboNG to apply its functionality to your tenant:

  1. In Admin, go to System > Customization > Applications.
  2. Select the Affirm Payments Application.
  3. Click Enable App on the app page.
Multiple Financing Programs (Optional)

Multiple Financing Programs (MFPs) allow you to selectively offer a specific custom financing program to consumers based on product or cart attributes that are defined in the Kibo NG platform. MFP setup is optional and the values are provided by Affirm. For more information, please visit Kibo NG Multiple Financing Programs documentation.


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