Loading...
These solutions are available in US and Canada only. For all other regions, please contact us for support.
By integrating with our Adobe Commerce plugin, you'll gain access to the full range of our solutions, including PCI DSS scope reduction via Hosted Fields, credit and debit processing, card storage, and order management.
Click the button below to download this plugin and view any related documentation available.
Go to Plugin/MarketplaceOur Adobe Commerce plugin requires credentials to our API. Test credentials can be obtained after registering with our Developer Portal. Once registration is complete, the required App Key and App Id can be found under your account. For more information and instructions, see Register / Create an App.
To configure this plugin, follow these steps.
The API offers payment through credit and debit cards along with card storage/tokenization.
The Payments Settings tab allows you to enter your overall 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.
| Field | Description |
|---|---|
| Enabled | Determines if the payment method is available at your Adobe Commerce store’s checkout. |
| Title | Description of the payment method displayed to the customer at checkout, e.g., “Credit Card.” The title will also be recorded in Adobe Commerce to indicate how the transaction was processed. |
| Sandbox Mode | Allows you to switch between the Production (Live) and Sandbox version of your account with us. |
| Sandbox Name | Human-readable label for this sandbox account (useful if you manage multiple test accounts). |
| Sandbox Site ID | Your sandbox merchant/site identifier issued by us. Routes test transactions to your account. |
| Sandbox Key | The App Id and App Key are used to obtain a bearer access token to execute API actions. For more information, see the Sandbox credentials section. |
| Sandbox Web API Key | Secret key used by the Adobe Commerce extension for sandbox API calls. Generate it in your sandbox dashboard and keep it private. |
| Payment Action | The sale transaction can be flagged for automatic capture (Authorize + Capture) or flagged as requiring a separate capture action later (Authorize only). |
| Allow Card Saving | Determines whether a customer's card can be saved to our Card Storage solution following a successful transaction. If set to Yes, a checkbox displays on the Hosted Fields form that gives the customer the choice to store their card. If set to No, no checkbox displays, and the card is not stored. |
| New Order Status | The status set on newly placed orders. |
| Debug | Enables request/response logging for troubleshooting. Recommended in Sandbox. |
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.
| Card Number | Card Issuer |
|---|---|
| 4111 1111 1111 1111 | Visa |
| 5105 1051 0510 5100 | Mastercard |
| 6011 0009 9013 9424 | Discover |
| 3782 822463 10005 | American Express |
| Amount | Response Code | Description |
|---|---|---|
| 13.18 | 000 | Triggers an approved transaction with a CardBalance returned. |
| 13.01 | 001 | The transaction was declined, no specific decline reason was given. |
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. For more information, see our Integration Validation to Go Live article.
Connect your integration for Production
Input your Production App Id / App Key into your gateway configuration in the Adobe Commerce Admin panel, and enable the "Live Mode" for the Payments gateway.
This section contains information on payment solutions such as Hosted Fields and as well as expanded features such as card and order management.
For information on our PCI DSS requirement-reducing hosted solution, see Hosted Fields.
All card data is tokenized using our tokenization service. 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.
The customer can choose from the list of their stored cards.
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.
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.
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.
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.
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.
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.
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. For example: Captured amount of £2.17 online.
If you select Invoices from the left menu now, you’ll see the invoice associated with the order.
Once an order is successfully settled, you can refund the customer using a Credit Memo in Adobe Commerce.
Important: The Credit Memo must be linked to a specific invoice, not the overall order.
Navigate to Sales > Orders, and select the order you want to rebate.
Open the relevant invoice, and click Credit Memo.
Under Payment Information, you can review the history of the order before deciding to process the rebate.
You must select Refund as opposed to Refund Offline. This will send the rebate request to us. You can edit the amount to rebate by editing the adjustment fields provided by Adobe Commerce.
Once complete, you will be returned to the Order View tab. A message indicating the outcome of the rebate request is included. A comment indicating the amount captured is included in the order.
You can cancel a transaction before it is sent for settlement. The transaction will be fully reversed. If you already captured (settled) the transaction, see the Create a Credit Memo – refund a captured transaction section.
Navigate to Sales > Orders, and select the order you want to void (reverse).
Click OK to confirm the pop-up message. This will send the Void (Reverse) request to us.
Once complete, a message will display indicating the outcome of the Void (Reverse) request.
A comment indicating the voided (reversed) amount is included with the order.
