Loading...
By integrating with our WooCommerce 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, and Order Management.
Click the button below to download this plugin and view any related documentation available.
Go to Plugin/MarketplaceOur WooCommerce 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.
Log in to the Admin panel for WooCommerce.
Navigate to WooCommerce > Settings > Payments.
From here, you can click Manage to configure the Unified Payments gateway as well as the various payment methods supported by WooCommerce.
Note: If this is your first time activating this plugin, the Settings page will appear first.
The Unified Payments gateway offers payments through credit and debit cards as part of the basic configuration for the Adobe Commerce plugin.
You can also enable the below additional payment methods via the Unified Payments gateway:
The Unified Payments Settings tab allows you to enter your overall account credentials.
The following table describes the fields that appear on the Unified Payments Settings tab for WooCommerce.
| Field | Description |
|---|---|
| Enable/Disable | Determines if the payment method is available at your WooCommerce store’s checkout. |
| Title | Description of the payment method displayed to the customer at checkout, e.g.,"Credit Card." The title is also recorded in WooCommerce to indicate how the transaction was processed. |
| Live Mode | Allows you to switch between the Live and Sandbox versions of your account with us. |
| Sandbox/Live 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/Live App Key | Use the App Id and App Key to obtain a bearer access token to execute API actions. For more information, see the Sandbox credentials section. |
| Credentials Check | Determines if your credentials are valid. Note: The payment methods will not be displayed at checkout if the credentials are not correct. |
| 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. |
| Enable Logging | 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 WooCommerce > Status > Logs. |
| Contact Url | A link to an About or Contact page on your website with customer care information (maxLength: 50). |
| Enable 3D Secure | Enables the 3D Secure feature. For more details, see the 3D Secure section. |
| Payment Action | The sale transaction can be flagged for automatic capture (Authorize + Capture) or flagged as requiring a separate capture action later (Authorize only). |
| Order Transaction Descriptor | During a Capture or Authorize payment action, this value will be passed along as the transaction-specific descriptor listed on the customer's bank account. |
| BLIK | Enables the BLIK payment method and determines if the payment method is available at time of checkout. |
| Bank Select | Enables the Bank Select payment method and determines if the payment method is available at time of checkout. |
The Google Pay Settings tab allows you to enter your overall account credentials. The following table describes the fields that appear on the Google Pay Settings tab for WooCommerce.
| Field | Description |
|---|---|
| Enable/Disable | Determines if the payment method is available at your WooCommerce 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 WooCommerce to indicate how the transaction was processed. |
| Client ID | The Client ID provided by us. |
| Google Merchant ID | The Merchant ID provided by Google. |
| Google Merchant Display Name | 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 Auth Methods | Methods allowed to authenticate a card transaction. 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 Pay button displayed at checkout. |
| Payment Action | The Sale transaction can be flagged for automatic capture (Charge) or flagged as requiring a separate capture action later (Authorize). |
The Apple Pay Settings tab allows you to enter your overall account credentials. The following table describes the fields that appear on the Apple Pay Settings tab for WooCommerce.
| Field | Description |
|---|---|
| Enable/Disable | Determines if the payment method is available at your WooCommerce 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 WooCommerce to indicate how the transaction was processed. |
| 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 <wordpress_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. |
| Payment Action | The Sale transaction can be flagged for automatic capture (Charge) or flagged as requiring a separate capture action later (Authorize). |
The Paypal Settings tab allows you to enter your overall account credentials. The following table describes the fields that appear on the Settings tab.
| Field | Description |
|---|---|
| Enable/Disable | Determines if the payment method is available at your WooCommerce store’s checkout. |
| Title | Description of the payment method displayed to the customer at checkout, e.g., "Pay with Affirm." The title is also recorded in WooCommerce 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. The following table describes the fields that appear on the Clearpay Settings tab for WooCommerce.
| Field | Description |
|---|---|
| Enable/Disable | Determines if the payment method is available at your WooCommerce store’s checkout. |
| Title | Description of the payment method displayed to the customer at checkout, e.g., "Pay with Clearpay." The title is also recorded in WooCommerce 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. The following table describes the fields that appear on the Settings tab.
| Field | Description |
|---|---|
| Enable/Disable | Determines if the payment method is available at your WooCommerce store’s checkout. |
| Title | Description of the payment method displayed to the customer at checkout, e.g., "Pay with PayPal." The title is also recorded in WooCommerce 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. The following table describes the fields that appear on the Settings tab.
| Field | Description |
|---|---|
| Enable/Disable | Determines if the payment method is available at your WooCommerce store’s checkout. |
| Title | Description of the payment method displayed to the customer at checkout, e.g., "Pay with Klarna." The title is also recorded in WooCommerce 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. The following table describes the fields that appear on the Settings tab.
| Field | Description |
|---|---|
| Enable/Disable | Determines if the payment method is available at your WooCommerce store’s checkout. |
| Title | Description of the payment method displayed to the customer at checkout, e.g., "Bank Payment." The title is also recorded in WooCommerce to indicate how the transaction was processed. |
| Account Number | Account number, for bank transfers within the United Kingdom (UK-to-UK bank). Required only if no bank details are stored on the account. |
| Account Name | Name of the individual or business on the bank account. Required only 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. Required only if no bank details are stored on the account. |
| IBAN | Key field for bank transfers for Europe-to-Europe transfers. Required only if no bank details are stored on account. Required only 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 will be displayed at checkout only for the selected currencies. |
| 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. |
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 and tested the plugin, 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
Going to Production with Affirm:
Going to Production with Clearpay:
Going to Production with Klarna:
Go to Production with Bank Payment
Go to Production with BLIK
Set up the store information in the WooCommerce Settings > General and Save changes
Note: For BLIK to work properly, you must configure the country and currency for Poland. WooCommerce > Settings > General
Go to Production with Bank Select
Set up the store information in the WooCommerce Settings > General and Save changes
Note: For Bank Select to work properly, the country and currency must be configured for Poland. WooCommerce > Settings > General
This section contains information on payment solutions such as Hosted Fields and our Hosted Payment Page, as well as how to enable Click to Pay.
You can also find information about 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.
Registered customers can save their card information by selecting the “Save to account” checkbox in the checkout form. The WooCommerce plugin securely stores card data with us and receives a token representation of the card, which is stored in the WooCommerce vault, with no increased PCI compliance requirements.
The customer can choose from the list of their stored cards.
Registered customers can see the list of their stored cards under My Account > Payment Methods.
Registered customers can add new payment methods by navigating to My Account > Payment Methods > Add Payment Method. A validation of the payment method is done to ensure it can be used to create a transaction at a later time and the card data is received through Hosted Fields.
Our Global Payments WooCommerce plugin supports Click to Pay when using the Global Payments Unified Payments gateway with the Hosted Payment Pages (HPP) integration.
To enable Click to Pay:
Log in to the WordPress Admin dashboard for the WooCommerce store.
Go to WooCommerce > Settings > Payments.
Select the Global Payments payment method.
Confirm that the payment method is enabled and that the account credentials for the Global Payments Unified Payments gateway are entered correctly.
Set the integration or payment form option to Hosted Payment Pages (HPP).
In the wallets or alternative payment methods configuration, enable Click to Pay.
Save your changes.
Your customer proceeds to checkout, selects card payment through HPP, and is redirected to the Global Payments Hosted Payment Page. Our HPP automatically checks whether your customer has saved Click to Pay cards associated with their profile.
If your customer is recognized, the Click to Pay verification modal is displayed so they can access their saved cards. They enter the 6-digit one-time passcode (OTP) sent to their registered email / mobile number and click Verify & Continue.
After your customer selects a saved card or confirms the payment, the transaction is submitted for authorization.
Your customer should remain on the Hosted Payment Page while authorization is completed.
Once authorized, our HPP displays the Payment Successful screen.
Your customer is automatically redirected back to your WooCommerce store’s order received or order confirmation page.
If Click to Pay is not visible in WordPress Admin, verify that:
If Click to Pay is not displayed on the Hosted Payment Page, verify that:
If your customer is not prompted for Click to Pay verification:
If your customer is not redirected back to WooCommerce after payment, confirm that:
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.
If the Initiate Payment request is successful, the customer is 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 are redirected to the cart page and the order that was previously created is canceled.
The order canceling is not processed in your website if the customer decides to leave the page using another option (for example, browser back button, browser X button, or closing the tab); therefore, the order still has the “Waiting for payment” status in these cases.
In cases where the orders are stuck in a Pending Payment status, we provide a View Transaction Info button.
Clicking View Transaction Info 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.
Detailed information relating to the transaction outcome is available in the Orders section for WooCommerce.
Merchants who use “Authorize only” at checkout will authorize the funds on your 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 your customer's card may vary between different issuers and acquirers. Card brands like Visa and Mastercard have their own rules around how long transactions can wait to be captured.
You can view the Transaction ID returned by us under the order details.
If successfully authorized, the funds are 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. Once the acquirer has captured the transaction, the funds are deducted from the customer's account and settled into your account.
To capture a transaction, on the right-hand menu, go to Order actions. Select Capture credit card authorization to send the request to us.
When finished, click Update. A Capture request with the total amount authorized will now be sent.
Once complete, the result of the Settle request is displayed as a comment in the Order notes. For example: Transaction captured. Transaction ID for the capture: TRN_Q5LIgwyAGg19h6OSmTWPSHTtygss5c_0426b98fcb98).
Once the acquirer has successfully settled an order, you can rebate your customer for 0% to 115% of the original order value. To do this, you must do a Refund in WooCommerce.
Navigate to WooCommerce > Orders, and select the order you want to rebate.
You can edit the amount to rebate by editing the adjustment fields provided by WooCommerce.
Once complete, the result of the Refund request is displayed as a comment in the Order notes. For example: €10.00 was reversed or refunded. Transaction ID: TRN_USaGaxBIRCQajDlqcqPolBkUwfRAL4_0426b98fcb98.