Using Partial Capture in SFCC

🚧

Important

Before proceeding with the change in settings, reach out to [email protected] to verify if your account is enabled for Partial Capture.

Overview

This guide assumes that the existing storefront has a working integration with the Affirm cartridge which accepts payment via the Affirm payment processor. Therefore, the transaction management module is only applicable for orders processed by the Affirm payment processor and not via the VCN integration.

Steps

1. Download the Affirm cartridge

1. Download the latest version of Affirm cartridge from the Salesforce LINK Marketplace.
2. Upload the cartridge into the SFCC server for the code version of your current workspace and environment.

2. Import the metadata

After you upload the cartridge, you must import the metadata that’s in the following directory: metadata/affirm/meta/system-objecttype-extension.xml.

1. In the Business Manager, go to Administration > Site Development > Site Import & Export.
2. Select the local radio button.
3. Click Choose File and select the XML file in the directory: metadata/affirm/meta/system-objecttype-extension.xml.
4. Once the upload finishes, click Import to complete importing the metadata.

3. Activate the Business Manager module

1. In the Business Manager, go to Administration > Sites > Manage Sites > Manage the Business Manager Site.
2. In the cartridge input field, add bm_affirm:int_affirm.
3. Click Apply.

Transaction Management

To manage transactions for partial capture:

1. Go to Merchant Tools and select Transaction Management under the Affirm submenu.

2. On the Order List page in Transaction Management, click on an order to view details or search for an order by the Affirm transaction ID.

3. In the Order Details page, you can perform three types of charge actions:
   1. Capture (including partial capture)
      1. You can perform the Capture action when the order status is New or Open, and the payment status is Not Paid or Part Paid.
      2. You can capture either the full amount or a partial amount.
      3. Authorization balance, which represents the difference between authorization amount and the current capture amount, is the maximum amount that can be entered as the capture amount.
   2. Refund
      1. You can perform the Refund action when the order status is Open or Complete, and the payment status is Part Paid or Paid.
      2. Any amount above USD 0.01, and up to the currently captured amount, can be entered as the refund amount.
   3. Void (Cancel)
      1. When the Affirm transaction status is Authorized, you can void the charge. This changes the order status to Canceled and the payment status to Not Paid.

Mapping order/payment status to Affirm transaction status