Affirm and Spree integration
Affirm is a financial services company that offers installment loans to consumers at the point of sale. Its aim is to improve the banking industry to be more accountable and accessible to consumers.
Founded in 2012, Affirm lets shoppers pay for purchases across multiple months with transparent, fairly-priced fees built into every payment, and increases conversion and basket size for e-tailers at less than the cost of credit cards.
The integration of Affirm with your Spree Commerce store can be done quickly and easily following the guidelines mentioned below.
The benefits of using Affirm for your eCommerce business
Large customer network
When you partner with Affirm, you’ll reach the company’s rapidly growing network of millions of customers.
Zero risk to you
Affirm settles within one business day and takes on risk, from costly chargebacks to fraud.
Flexibility to fit your business
With Affirm, you have the power to tailor your shopping experience to any customer, channel, or price point.
How to integrate Affirm with Spree
Before you begin
Before beginning integration, you should review:
- The transaction flow when buying with Affirm
- Your current checkout process to understand how Affirm will affect operations and customer experience
- Settlement reports to know how to reconcile transactions with the deposits into your bank account
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 the Spree extension
- Download the Spree extension
- Add the following line to your Spree Gemfile:
1 | gem 'spree_affirm', :github => "affirm/spree_affirm" |
- Install the gem with Bundler:
1 | bundle install |
2 | bundle exec rails g spree_affirm:install |
- Restart your Spree server
2. Configure Affirm as a payment method
- Sign in to the Spree admin page
- Go to Configurations > Payment Methods
- Click New Payment Method
- Set PROVIDER to Spree::Gateway::Affirm
- Enter Affirm Monthly Payments for NAME
- Click Create
- Keep SERVER set to sandbox.affirm.com for testing
- Check the TEST MODE box for testing
- Enter the API Key (public key) and Secret Key (private key) you retrieved from the Affirm sandbox merchant dashboard
- If your checkout process automatically captures the charge, set AUTO CAPTURE to Yes
- Set ACTIVE to Yes to enable Affirm as a payment method.
- Click Update
3. Add Affirm promotional messaging
Affirm promotional messaging components—monthly payment messaging and educational modals—show customers how they can use Affirm to finance their purchases. Properly placed promotional messaging helps drive increased AOV and conversion.
Adding Affirm promotional messaging is a required integration step, and you should complete it before testing your integration. Click here for information about adding Affirm promotional messaging.
4. Review your order management functions
Processing orders (authorize, void, refund, and partial refund) in Spree updates the order status in the Affirm dashboard. While you can process orders in the dashboard, we strongly recommend using Spree to keep order status synced with Affirm. For more information on processing orders in Spree, refer to their documentation.
5. 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.
01 | affirm.analytics.trackOrderConfirmed({ |
02 | "orderId": "T12345", |
03 | "total": 3739 |
04 | }, [{ |
05 | "productId": "SKU-1234", |
06 | "quantity": 1 |
07 | }, { |
08 | "productId": "SKU-5678", |
09 | "quantity": 1 |
10 | }]); |
Required function parameters
Order object
| 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
| 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. |
6. 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.
7. 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
- Retrieve your live API keys at https://affirm.com/dashboard/#/apikeys
- In the Spree admin panel, go to Configurations > Payment Methods
- Select Affirm Monthly Payments
- Set SERVER set api.affirm.com
- Enter the API Key (public key) and Secret Key (secret key) you just retrieved from the Affirm merchant dashboard
- Uncheck the TEST MODE box
- Click Update
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.
Example of Affirm and Spree integration
FORM is a beauty brand belonging to Walker and Company, a firm that is reinventing the way consumers of color learn about, purchase and enjoy health and beauty products. The company uses Spree for their beautiful website with some really cool features like customized Gift Cards, product reviews and featured testimonials from Twitter. The integration with Affirm allows FORM’s customers to pay with 3 interest-free payments.
Read more: FORM Success Story
