Loading...
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 (Drop-In UI), credit and debit processing, Digital Wallets, Card Storage, 3D Secure, Order Management, and Fraud 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 Unified Payments gateway. 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 integrate with Apple Pay, you’ll need to obtain the encrypted payment credentials. To do this, follow the steps in the applicable Apple guide below:
For more Apple Pay setup information, see our Apple Pay article.
To configure this plugin, follow these steps.
The Unified Payments gateway offers payment through credit and debit cards. Additional payment methods like Digital Wallets (Google Pay, Apple Pay, and PayPal), Buy Now Pay Later (Affirm, Clearpay, and Klarna), and Bank Payment (Open Banking) can be enabled via the Unified Payments gateway.
The Unified 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 Unified 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 App Id | 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 App Key | |
| Credentials Check | Validates your credentials. Note: Payment methods will not display at checkout if the credentials are incorrect. |
| Contact Url | A link to an About or Contact page on your website with customer care information (max length: 50). |
| Payment Action | The Sale transaction can be flagged for automatic capture (Charge) or flagged as requiring a separate capture action later (Authorize). |
| 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. |
| Debug | Allows logging of all requests to and from the gateway. Can also log private data. Should only be enabled in a development or stage environment. Logs can be found at var/log/. |
| Order Transaction Descriptor | During a Capture or Authorize payment action, this value is passed along as the transaction-specific descriptor listed on the customer's bank account (max length: 25). |
| Fraud Mode | Enables merchants to automatically Pass, Hold, or Block transactions based on the result of the rules configured via the Fraud Management section in Ecommerce Portal. |
| Enable 3D Secure | Enables the 3D Secure feature. For more details, see the 3D Secure section. |
The Google Pay 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 Google Pay 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., "Pay with Google Pay." The title is also recorded in Adobe Commerce to indicate how the transaction was processed. |
| Payment Action | The Sale transaction can be flagged for automatic capture (Charge) or flagged as requiring a separate capture action later (Authorize). |
| Client ID | The Client ID provided by us. |
| Google Merchant ID | The Merchant ID provided by Google. |
| Google Merchant Display Name | The text displayed to the customer in the Google Pay dialog box. |
| Accepted Cards | Determines what card types can be used at checkout when paying with Google Pay. |
| Allowed Card Authentication Methods | Methods allowed to authenticate a card transaction. Allowed values: PAN_ONLY: This authentication method is associated with payment cards stored on file with the user's Google Account. CRYPTOGRAM_3DS: This authentication method is associated with cards stored as Android device tokens. PAN_ONLY can expose the Funding Primary Account Number (FPAN), which requires an additional Strong Customer Authentication (SCA) step up to a 3DS check. Currently, we don't support the Google Pay SCA challenge with an FPAN. For the best acceptance, we recommend that you provide only the CRYPTOGRAM_3DS option. |
| Button Color | Determines the color of the Google button displayed at checkout. |
The Apple Pay 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 Apple Pay 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., "Pay with Apple Pay." The title is also recorded in Adobe Commerce to indicate how the transaction was processed. |
| Payment Action | The Sale transaction can be flagged for automatic capture (Charge) or flagged as requiring a separate capture action later (Authorize). |
| Apple Merchant ID | The Merchant ID provided by Apple. For more info on creating an Apple Merchant ID, see Apple Pay Programming. |
| Apple Merchant Cert Path | The path for the .crt.pem file. This path is the relative path from the root. For example, if you store this certificate as <magento_location>/.well-known/ApplePay.crt.pem, the path should be .well-known/ApplePay.crt.pem For more Apple Pay setup information, see the Apple Pay credentials section or our Apple Pay article. |
| Apple Merchant Key Path | The path for the .key.pem file. For more Apple Pay setup information, see the Apple Pay credentials section or our Apple Pay article. |
| Apple Merchant Key Passphrase | The encryption key for the .key.pem file. If the .key.pem file is not encrypted, this field must be empty. |
| Apple Merchant Domain | To fill this field, you first need to register and validate your domain in your Apple account. Follow the steps in the Apple Developer Account Help (see the “Register a merchant domain” and “Verify a merchant domain” sections). Once validated, the value that must be inserted in this field is the Domain value you have in your Apple account for the current domain. |
| Apple Merchant Display Name | The text displayed to the customer in the Apple Pay dialog box. |
| Accepted Cards | Determines what types of cards can be used at checkout when paying with Apple Pay. |
| Button Color | Determines the color of the Apple Pay button displayed at checkout. |
The PayPal Settings tab allows you to enter your overall account credentials. These are global settings that 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 Settings tab.
| 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., "Pay with PayPal." The title will also be recorded in Adobe Commerce to indicate how the transaction was processed. |
| Payment Action | The Sale transaction can be flagged for automatic capture (Charge) or flagged as requiring a separate capture action later (Authorize). |
The Affirm Settings tab allows you to enter your overall account credentials. These are global settings that 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 Affirm 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., "Pay with Affirm." The title will also be recorded in Adobe Commerce to indicate how the transaction was processed. |
| Payment Action | The Sale transaction can be flagged for automatic capture (Charge) or flagged as requiring a separate capture action later (Authorize). |
The Clearpay Settings tab allows you to enter your overall account credentials. These are global settings that 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 Clearpay 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., "Pay with Clearpay." The title will also be recorded in Adobe Commerce to indicate how the transaction was processed. |
| Payment Action | The Sale transaction can be flagged for automatic capture (Charge) or flagged as requiring a separate capture action later (Authorize). |
The Klarna Settings tab allows you to enter your overall account credentials. These are global settings that 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 Klarna 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., "Pay with Klarna." The title will also be recorded in Adobe Commerce to indicate how the transaction was processed. |
| Payment Action | The Sale transaction can be flagged for automatic capture (Charge) or flagged as requiring a separate capture action later (Authorize). |
The Bank Payment Settings tab allows you to enter your overall account credentials. These are global settings that 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 Settings tab.
| 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., "Bank Payment." The title will also be recorded in Adobe Commerce to indicate how the transaction was processed. |
| Payment Action | The Sale transaction can be flagged for automatic capture (Charge) or flagged as requiring a separate capture action later (Authorize). Currently, the Authorize mode is not supported. |
| Account Number | Account number for bank transfers within the United Kingdom (UK-to-UK bank). Only required if no bank details are stored on the account. |
| Account Name | The name of the individual or business on the bank account. Only required if no bank details are stored on the account. |
| Sort Code | Six digits that identify the bank and branch of an account. Included with the account number for UK-to-UK bank transfers. Only required if no bank details are stored on the account. |
| IBAN | Key field for bank transfers for Europe-to-Europe transfers. Only required if no bank details are stored on the account. Only required for EUR transacting merchants. |
| Countries | Allows you to input a COUNTRY or string of COUNTRIES to limit what is shown to the customer. Including a country overrides your default account configuration. Format: List of ISO 3166-2 (two characters) codes separated by a | Example: FR|GB|IE |
| Currencies | The payment method is displayed at checkout only for the selected currencies. |
| Sort Order | Checkout sort order. |
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.
For a full list of test cards, see our Test Cards article.
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:
Go to Production with Google Pay:
Go to Production with Apple Pay:
Go to Production with PayPal:
Go to Production with Affirm:
Go to Production with Clearpay:
Go to Production with Klarna:
Go to Production with Bank Payment:
This section contains information on payment solutions such as Hosted Fields and Hosted Payment Page, risk management solutions such as 3D Secure and Fraud Management, as well as expanded features such as Card Management and Order Management.
For the Buy Now Pay Later payment methods (Affirm, Clearpay, and Klarna), additional information on checkout flow can be found in the Async Payment Methods section.
For information on our PCI DSS requirement-reducing hosted solution, Hosted Fields (Drop-In UI), see our Hosted Fields - Overview page.
For information on our Hosted Payment Page for Unified Payments REST API integrators, see our Hosted Payment Page - Overview page.
For information on our 3D Secure solutions, see our 3D Secure - Overview page. We provide a Simulator Issuer Access Control Server that allows you to test different 3D Secure scenarios. For more information, see the 3D Secure section of our Test Cards article.
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.
Because these payment methods are handled by third-party services and require further processing from these third parties, the checkout flow has some differences compared with the Unified Payments or Digital Wallets ones.
When a customer clicks the Place Order button, the order is placed with a Pending Payment status.
Once the order has been created, an Initial Payment request type will occur.
If the Initiate Payment request is successful, the customer will be redirected to the third-party service to pay.
Third-Party Service Example
If the customer decides to cancel the payment using the option provided by the third-party service (for example, clicking the X button on top left of the screen), they will be redirected to the cart page. Also, the order that was previously created will be canceled.
The order canceling will not be processed on your website if the customer decides to leave the page using another option (for example, browser back button, browser X button, closing the tab, and so forth). Therefore, the order will still have the Pending Payment status in these cases.
In cases where the orders are stuck in a Pending Payment status, we provide a Get Transaction Details button.
Clicking the Get Transaction Details button fetches all the information about the current transaction and displays it in a pop-up window.
Based on the Transaction Status, you can manually cancel the order or just continue with the normal flow.
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. Transaction ID: “TRN_ULgzHnUq0IZfGpjuE20WVrG4dqMlrG_1626167155”
If you select Invoices from the left menu now, you’ll see the invoice associated with the order.
Once an order is successfully settled with your Acquirer, you can rebate the customer for 0% to 115% of the original order value. To do this, you must create a Credit Memo in Adobe Commerce.
Important Note: 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. For example: We refunded £2.17 online. Transaction ID: "TRN_YSaaHfsEfOFp9UB0tlHIUkBkqzaIIJ_1626167155"
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.
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. For example: Voided authorization. Amount: $38.00. Transaction ID: "TRN_gZU2tA3oku6WGjzlS7vNmdvzFo4u0p_1643794511-void"
Our Fraud Filter enables merchants to automatically Pass, Hold, or Block transactions based on the result of one or more rule results. This functionality is configured via the Fraud Management section in Ecommerce Portal.
It is important to note that any changes made to the Fraud Filter in Ecommerce Portal will impact the result returned in the API response. You will need to ensure that any changes don't adversely affect transaction processing in your application. For example:
In this case, the transaction will pass, and it will follow the normal flow in Adobe Commerce.
In this case, the transaction will pass, and it will follow the normal flow in Adobe Commerce.
In this case, the transaction will follow the normal flow in Adobe Commerce.
In this case, the transaction will follow the normal flow in Adobe Commerce.
When Fraud Mode is set to Off, the rules will not be executed.