2022 Nov BFCM Marketplace Sale

  1. Documentation /
  2. Affirm Payments

Affirm Payments

The Affirm payment method lets your store accept monthly payments for purchases.

  • Set a minimum/maximum spend to use Affirm as an option
  • Select whether to promote Affirm as a payment method

Requirements

↑ Back to top
  • An SSL Certificate.
  • An Affirm account.
  • Your store currency must be set to USD or CAD.
  • Customer address must be U.S. or Canada address to see Affirm options.

Installation

  1. Purchase the product from WooCommerce.com
  2. Download the ZIP file from your WooCommerce.com dashboard
  3. Go to Plugins > Add New > Upload and select the ZIP file you just downloaded
  4. Click Install Now and then Activate.
  5. Read on to learn how to set up and configure the product.

More information at: Install and Activate Plugins/Extensions.

Setup and Configuration

↑ Back to top
  1. Head to: WooCommerce > Settings > Payments.
  2. Select Affirm.
  3. Enable/Disable – Enable to use. Disable to turn off.
  4. Enter a Title and Description shown to customers during checkout (optional).
  5. Select Expand to show Affirm Account Settings
  6. Enable Affirm Sandbox if developing or testing before going live. Remember to disable when done.
  7. Enter your Region.
  8. Affirm account must be approved for LIVE mode to work.
  9. Enter the Public API Key and Private API Key from your Affirm account.
    • Affirm account must be approved for LIVE mode to work.
  10. Choose whether Language Selector should be based on Site Language or Browser Language. (For US, select Site Language)
  11. Select Transaction Mode
    • Authorize obtains payment authorization only
    • Authorize and Capture obtains authorization and captures funds.
  12. Enable Partial Capture only if instructed by Affirm support.
  13. Select Checkout Mode
    • Modal triggers a pop-up during checkout
    • Redirect takes the customer offsite to check out
    • Enable/Disable Inline checkout value props on the checkout page when Affirm is selected as a payment method
  14. Enable Inline Checkout to enable inline visibility of value props on the checkout page.
  15. Select Cancel Affirm Page
    • Cart Page – takes customer to cart
    • Payment Page – takes customer back to payment
    • Custom URL – Takes customer back to a specific location
  16. Enter Custom URL in Permalink/Custom Cancel URL when Custom URL is set as Cancel Affirm Page
  17. Select Expand to show Affirm Promotional Messaging Settings
  18. Promo Messaging – untick all boxes (recommended if you offer other preferred payment methods); tick boxes if you wish to promote Affirm as a payment:
    • Category
    • Product
    • Cart (see example in Customer Usage)
  19. Select an Affirm Color Blue, Black or White for the logo.
  20. Show Learn More to display a link in Affirm monthly payment messaging.
  21. Enter your Affirm Promo ID (optional) to display Affirm with different styling, messaging, or loan terms. Contact Affirm for a Promo ID.
  22. Select Expand to show Affirm Advance Settings
  23. Set Order Minimum (optional) – numerical value.
  24. Set Order Maximum (optional) – numerical value.
  25. Enable Debug if troubleshooting. Otherwise, leave disabled.
  26. Leave box unticked for Enable Enhanced Analytics.
  27. Enable Display Affirm fee to show Affirm Merchant fees
  28. Save changes.

Sandbox Test Values

↑ Back to top
  • When checking out with Affirm Sandbox, use your real name. Trying things like “Mister Panda” will not work. As Affirm’s name filter takes out prefixes like Mister and will throw an error when you try to pass things like “Mister Panda” as the name. Try a regular name and it should work fine.
  • Use a real cell phone number
  • Use a real birthday
  • Use 1234 for the last 4 of the SSN
  • Use 1234 for the pin

Customer Usage

↑ Back to top

What customers see on the front end when checking out.

Customers (U.S. only) can see promo messaging in cart, if you ticked the box for Cart page.

Customers (U.S. only) can select Affirm as a payment method on your store’s checkout page.

They are presented with the Affirm flow to complete payment and will see a screen with payment plans of different duration.

Order Reviews

↑ Back to top

Under WooCommerce > Orders, every order paid with Affirm contains a transaction number with link to the Affirm merchant portal at the top. You can also prompt Affirm to issue refunds from the order view.

affirm-order-view

Split Capture

↑ Back to top
  1. Download and Install the latest version of Affirm extension from the WooCommerce Extension Store.
  2. Once Affirm has been installed and enabled as a payment method, go to WooCommerce settings, Payments tab, and then go to Affirm by clicking on the “Manage” button.
  3. Check “Enable Partial Capture”
    • Important: Before proceeding with the change in settings, please ensure your account is enabled for Partial Capture by reaching out to merchanthelp@affirm.com
  4. Once the change is saved, orders placed with Affirm thereafter will be eligible for requesting multiple captures as long as it doesn’t exceed the authorized amount within a specified authorization window.
  5. In the Order Details page of Woocommerce Orders, click on the “Capture” button along other order action buttons.
  1. Enter Capture amount and click on the “Capture ${capture_amount} via Affirm” button.
  2. Checking “Capture remaining” will allow you to capture all (if any) remaining authorization funds.
  1. The order status will be “On hold” until all authorized funds have been captured unless updated otherwise.
  2. Refunds work the same way as fully charged loans. You can refund any amount up to the captured amount if the loan is partially captured.

Troubleshooting

↑ Back to top

Customer receives an error when attempting to pay via Affirm.

Ensure that you have input the correct keys; and you have entered live (not test) keys when in live mode.

Code Snippets

↑ Back to top

If you’d like to change where Affirm is shown across your site here are some actions to dynamically insert the Affirm payment option on a custom product and category pages:

$affirm = $GLOBALS['wc_affirm_loader'];

Show affirm on single product page

↑ Back to top

echo $affirm->woocommerce_single_product_summary();

Show affirm in the loop

↑ Back to top

$affirm->woocommerce_after_shop_loop_item()

Frequently Asked Questions

↑ Back to top

Affirm is not showing.

↑ Back to top

Confirm that:

  • Your site’s currency is set to USD. Go to: WooCommerce > Settings > General > Currency.
  • Customers have a U.S.-based billing address to use Affirm.
  • SSL is enabled.
  • Your site is in Live (not Test) mode.

Nothing happens when customer attempts to pay with Affirm.

↑ Back to top

This error may be caused by non-standard/poorly coded themes and JavaScript (JS) issues. Common issues include:

  • JavaScript errors on checkout page – To view the error, open your browser error console (in Chrome: View > developer > JavaScript console) and look for red errors. This should indicate where the error is located and lead you to the problem, e.g., Loading jQuery incorrectly
  • Failing to load scripts – Affirm loads JavaScript which it needs to function. If these are not loaded, you will see errors. Most common reasons are:
    • Theme is missing wp_head() or wp_footer() calls.
    • Old overridden template files from WooCommerce inside your theme.
    • Loading headers/footers in a non-standard way. WooCommerce uses get_header()’s get_header action to init the checkout and load scripts. If you are not using get_header() you either need to do so, or you need to trigger the get_header action manually using: do_action( ‘get_header ); in your custom header loader.

Is it possible to override templates on the Affirm pages?

↑ Back to top

No. These are fixed/static pages from Affirm.

Why should the Enhanced Analytics box be unticked?

↑ Back to top

At this time the feature is inactive on stores. The information can only be accessed by an Affirm representative.

Questions and Feedback

↑ Back to top

Have a question before you buy? Please fill out this pre-sales form.

Already purchased and need some assistance? Get in touch with a Happiness Engineer via the Help Desk.

WooCommerce

The most customizable eCommerce platform for building your online business.

  • 30-day money-back guarantee
  • Support teams across the world
  • Safe and secure online payment