Adobe Commerce

By integrating with our Adobe Commerce plugin, you'll gain access to the full range of our solutions, credit and debit processing, card storage, and order management.

• Categories: Extensions, Payments & Security, Payment Integration
• Platform compatibility: Open Source (CE): 2.4 (current), 2.3 (obsolete); Commerce on prem (EE): 2.4 (current), 2.3 (obsolete); Commerce on Cloud (ECE): 2.4 (current), 2.3 (obsolete)

Access plugin

Click the button below to download this plugin and view any related documentation available.

Sandbox credentials

Our Adobe Commerce plugin requires credentials to our Payments gateway. Test credentials can be obtained after you register with our developer portal. Once your registration is complete, you can find the required Public and Secret Key in your account.

Configuration

To configure this plugin, follow these steps.

1. Log in to the Admin panel for Adobe Commerce.
2. Navigate to Stores > Configuration.
3. Under the Sales heading, select the Payment Methods option.
4. From here, you can configure the Payments gateway as well as the payment methods supported by Adobe Commerce.

Payments settings

The Payments gateway offers payment through credit and debit cards.

The Payments Settings tab allows you to enter your account credentials. These global settings apply to all integration types. You can enter specific credentials for different websites by changing the website scope in Adobe Commerce.

The following table describes the fields that appear on the Payments Settings tab for Adobe Commerce.

Use the test card numbers below to verify that your integration was set up properly. For testing, you can use any cardholder name, any expiry date in the future, and any CVN security code.

You can find a full list of test cards on our Test Cards page.

Now that you’ve successfully installed the plugin and tested to see if it was installed properly, you’re all set to go live in the Production environment.

To do this, you'll need to connect your integration for Production.

1. Input your Production Public and Secret Key into your gateway configuration in the Adobe Commerce Admin panel, and enable the Live Mode for the gateway.

This section contains information on card management and order management payment solutions.

Card management

Registered customers can save their card information by selecting the Save for later use checkbox in the checkout form.
The Adobe Commerce plugin securely stores card data with us and receives a token representation of the card, which is stored in the Adobe Commerce vault, with no increased PCI compliance requirements.

1. The customer can choose from the list of their stored cards.
   
2. Registered customers can see their stored cards under My Account > Stored Payment Methods. They can also add new cards or delete the existing ones from here.
   

Order management

Detailed information on transaction outcome is available in the Orders section for Adobe Commerce.
If the payment was successful, the order status will be set to the New Order Status configured under the relevant configuration section for us.

Create an invoice – capture a transaction

Merchants who use Authorize at checkout will authorize the funds on the customer’s card, but the transaction won’t be placed in the settlement file until we capture it.

The amount of time the funds can remain ring-fenced on the customer's card may vary between different Issuers and Acquirers. Card brands like Visa and Mastercard have their own rules regarding how long transactions can wait to be captured.

1. To view the response returned by us, first open the order and then select the Transactions tab. Select the relevant transaction to view the details of our response.
   
2. If successfully authorized, the funds will be ring-fenced on the customer’s account. When you want to include the transaction in the next settlement file (also known as a batch), you can simply send a Capture (Settle) request. When the transaction is captured with the Acquirer, the funds are deducted from the customer's account and settled into the merchant's account.
3. At this point, if you select Invoices from the left menu, you'll see that there is no invoice associated with the order. This is because we haven't captured it yet.
4. Click Submit Invoice to create a new invoice to be raised against this order. Here, you can review the result of the transaction before deciding to capture the funds.
   
5. You must select Capture Online for the request to be sent to us. Once you click Submit Invoice, a Capture request with the amount specified is sent.
   Once complete, the result of the Settle request is displayed. A comment indicating the amount captured is included in the order.
   If you select Invoices from the left menu now, you’ll see the invoice associated with the order.

Create a credit memo – refund a captured transaction

Once an order is successfully settled with your Acquirer, you can refund the customer for 0% to 115% of the original order value. To do this, you must create a Credit Memo in Adobe Commerce.

1. Navigate to Sales > Orders, and select the order you want to refund.
2. Open the relevant invoice, and click Credit Memo.
3. Under Payment Information, you can review the history of the order before deciding to process the credit.
   
4. You must select Refund as opposed to Refund Offline. This will send the request to us. You can edit the amount to credit by editing the adjustment fields provided by Adobe Commerce.
5. Once complete, you will be returned to the Order View tab. A message indicating the outcome of the request is included. A comment indicating the amount captured is included in the order.

Cancel an order - void (reverse) a transaction

You can cancel a transaction before it is sent for funding. The transaction will be fully reversed. If you already captured (settled) the transaction, see the Create a credit memo – refund a captured transaction section.

1. Navigate to Sales > Orders, and select the order you want to void (reverse).
2. Click OK to confirm the pop-up message. This will send the Void (Reverse) request to us.
3. Once complete, a message will display indicating the outcome of the Void (Reverse) request.
   
4. A comment indicating the voided (reversed) amount is included with the order.