Affirm-developers

BigCommerce integration

Integrate Affirm into your BigCommerce platform.

Overview

This guide walks you through integrating Affirm with your BigCommerce platform.

ūüďė

Using Blueprint?

Checkout out our documentation on integrating Affirm on BigCommerce Blueprint.

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. Confirm your site is using Optimized one-page checkout

First, confirm that the Optimized one-page checkout is enabled. The Affirm integration for BigCommerce requires the use of the Optimized one-page checkout.

Go to Advanced Settings > Checkout. If you do not see the Checkout Type setting, you're already using the Optimized one-page checkout and can proceed to the next step.

If you are on a legacy checkout, you'll see the Checkout Type field available with either Single-page express checkout or Multiple-page checkout selected. To enable Affirm, you will need to select Optimized one-page checkout and click Save. (Details on Optimized one-page checkout can be found here)

2. Enable Affirm as an online payment method

1. Go to¬†Store Setup¬†‚Äļ¬†Payments¬†and find¬†Affirm¬†on the list of Online Payment Methods.
2.Click Set up.

3. From the Affirm Settings tab, enter the credentials from your Affirm merchant account into the corresponding fields.

FieldDescription
Public KeyThe Public Key from your Affirm dashboard.
Private KeyThe Private Key from your Affirm dashboard.
Minimum Order ValueThe minimum order amount (before taxes and discounts) that must be met before Affirm displays as an option at checkout. If blank, Affirm will be displayed for all orders over $50.
Transaction TypeCan be set to Authorize & Capture or Authorize Only.
* Authorize & Capture: will capture your Affirm charge and your order will have the status of Awaiting Fulfillment in BigCommerce.
* Authorize Only allows you to capture the funds manually. Your order will have the status of Awaiting Payment in BigCommerce. Once you manually capture the order in BigCommerce, the charge will be captured automatically in Affirm. See Manually Capturing Transactions (Authorize Only) to learn more on how to manually capture transactions within BigCommerce.
Test ModeDetermines whether your store is in Test Mode. Make sure this is enabled until you are ready to take payments.

3. Install the Affirm Marketing App

You can find the Affirm Marketing App for BigCommerce can on the BigCommerce marketplace. You can also install the app from your BigCommerce dashboard by going to Apps and searching for Affirm. Once you click on install and confirm the terms and conditions, The Affirm Marketing app will be installed in your store.

Updated 7 months ago


Related topics

Congrats! You've successfully set up your BigCommerce integration. Next, configure your promotional messaging start providing details on our flexible payment options to your customers.

Stencil promotional messaging integration
Blueprint promotional messaging integration

BigCommerce integration


Integrate Affirm into your BigCommerce platform.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.