HomePaymentsPlatformsGlobal Integration
DocsRecipesAPI referenceChangelog
HomePaymentsPlatformsGlobal IntegrationLog In

Important

Before proceeding with the change in settings, please ensure your account is enabled for Partial Capture by reaching out to [[email protected]](🔗).

## Overview

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



### 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.

### Import the metadata

Once you have uploaded the cartridge, make sure to import the metadata found in the following directory: `metadata/affirm/meta/system-objecttype-extension.xml`

  1. Go to **Business Manager > Administration > Site Development > Site Import & Export**.

  2. Make sure the **local** radio button is selected.

  3. Click **Choose File** and select the XML file in the above directory.

  4. After finishing the upload, click **Import** to complete importing the metadata.

### Activate the Business Manager module

  1. Go to **Business Manager > 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

### Perform Transaction actions

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

1085


  1. In the_ Order List_ page of _Transaction Management_, you can click on an individual order to view details or search for an order by the Affirm transaction ID.

1484


  1. In the **Order Details** page, you can perform three types of charge actions:

**Capture (including Partial Capture)**

  • If the order status is **NEW** or **OPEN**, and the payment status is **Not Paid** or **Part Paid**, then you can perform the capture action.

  • Either the full amount or a partial amount can be captured.

  • 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.

**Refund**

  • If the order status is **OPEN** or **COMPLETE**, and the payment status is **Part Paid** or **Paid**, then refund action can be performed.

  • Any amount above USD 0.01 and up to the currently captured amount can be entered as the refund amount.

**Void (Cancel)**

If the Affirm transaction status is “authorized,” the charge can be voided and the order status will change to **CANCELED** and payment status to **Not Paid**.

1408


### Mapping order/payment status to Affirm transaction status

Payment stateAffirm Transaction StatusSFCC Order Status / Payment StatusAvailable Action(s)
Authorized`authorized`OPEN / NOTPAIDCapture Void
Voided`voided`CANCELLED / NOTPAIDNone
Partially captured`partially_captured`OPEN / PARTPAIDCapture Refund
Fully captured`captured`COMPLETED / PAIDRefund
Fully refunded`refunded`CANCELLED / NOTPAIDNone