Skip to main content

Merchant Help


Affirm Merchant Help

Magento Telesales Integration

NOTE : This module is an add-on of Affirm's Marketplace Module. To use this module, you must have downloaded and installed Affirm's Marketplace Module first.

Download the Magento Telesales extension

Go to our GitHub site to download the Magento Telesales extension. 

Install the Magento Telesales extension

Use one of the following methods to install the Magento extension:

modman clone

To update:

modman update Magento1_Affirm_Telesales
  • Install using Magento Connect Manager
  1. Download the latest package release (compressed TGZ file)
  2. In the Magento admin panel, go to System > Magento Connect > Magento Connect Manager
  3. Upload the Magento1_Telesales_Affirm package

composer require affirm/magento1-telesales

Upgrade the Magento Telesales Extension

These instructions are only applicable if you already have Affirm Magento Telesales extension installed and you are upgrading to a new version of the extension.

Upgrade using modman
<code>cd MAGENTO_ROOT modman clone

To update:

<code>modman update Magento1_Affirm_Telesales
Upgrade using Magento Connect Manager
  1. In the Magento admin panel, go to System > Magento Connect > Magento Connect Manager
  2. Under Manage Existing Extensions, select Uninstall under Actions for Affirm_Telesales package name
  3. Complete the uninstallation by clicking on Commit Changes
  4. Download the latest package release (compressed TGZ file)
  5. In the Magento admin panel, go to System > Magento Connect > Magento Connect Manager
  6. Upload the Magento1_Affirm_Telesales package

Retrieve keys

  1. Sign in to
  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.

Configure the Affirm payment method

Once you've installed the Affirm extension, Affirm can be easily enabled as a payment method by updating the following configurations:

  1. Log in to your Magento Admin portal
  2. Visit System > Configuration > Sales > Payment Methods > Affirm Telesales
  3. Set Enabled to Yes 
  4. Keep the Mode set to Sandbox for development and testing 
  5. Enter the Public API Key that you retrieved from the Affirm Merchant Dashboard
  6. Enter the Private API Key that you retrieved from the Affirm Merchant Dashboard
  7. If you currently automatically capture, change the Payment Action to Authorize and Capture
  8. Enter Company Name,  a company/brand name that the customer sees for Telesales communication.

Screen Shot 2018-06-12 at 11.47.16 AM.png

If you have problems with the changes not showing up immediately
  1. Visit System > Cache Management
  2. Click Flush Magento Cache
  3. Log out and log back in to reset permissions

Order Processing

Whenever an authorize, void, invoice or credit memo is applied to an order in Magento, the request is sent to Affirm to update order status in Affirm Merchant Dashboard. See Daily Operations for details.

Test your Affirm configuration

Test your configuration to ensure that everything is working before you go live. Contact Us with a link to your test site so that we can verify your configuration and provide you with production keys.

  1. Create an order from your order management admin dashboard
  2. During checkout, enter customer's valid U.S. addresses and mobile-phone information. Affirm cannot test if the address or phone information is fake.
  3. Select Affirm as the payment option.
  4. Create order in pending state and send checkout to Customer, Affirm will send a text and email to the billing phone number/email provided, which will link the consumer to their online application.
  5. Test the Affirm checkout flow your customer will go through:
    1. Sandbox transactions
      1. Once you initiate checkout, you'll see the account creation screen.
        • If you've already created an account, click the 'Log In' button
        • If you haven't created an account, create one now.
          • Any First and last name
          • Valid email address format
          • Valid (random) US cell phone number
          • Birthdate longer than 18 years ago
          • Any four digits
      2. You'll be asked to enter a PIN number, use '1234'. We do not text you a PIN number in the Sandbox environment
      3. You will always see 3, 6, and 12 month terms.
      4. Once you click the 'Confirm' button, you'll be redirected to the merchant site confirmation page.
  6. Charge authorization occurs after a user has successfully completed the Affirm checkout flow and returns back to the merchant site. Authorizing the charge generates the charge ID that will be used to reference this charge moving forward. A charge is not fully created before being authorized, and thus is not visible in the 'read charge' response, nor in the User/Merchant Dashboard.
  7. You will see order as processed or complete in your order management dashboard
  8. Verify that the transaction appears in your platform's admin panel and on

Note: The Telesales API will send SMS text messages only in the Affirm Live environment. During Sandbox environment testing, please rely on email messages to receive the checkout URL.

Note: The URL indicates that you are in the testing environment.

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 Contact Us for help with completing this process.


Screen Shot 2018-06-12 at 11.49.45 AM.png

Screen Shot 2018-06-12 at 11.52.45 AM.png

Screen Shot 2018-06-12 at 11.53.17 AM.png

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.

    Note: The work email address that you use to sign-in to the Affirm Dashboard must be granted access by your Dashboard's administrator, or your Affirm contact.
  2. Retrieve your live API keys.
  3. Enter the live API keys into your integration/platform.
  4. Update the Mode to Production in System > Configuration > Sales > Payment Methods > Affirm Telesales.