For AI agents: the complete documentation index is at /llms.txt, and the full text of every page is at /llms-full.txt. Most pages are also available as Markdown by adding .md to the URL.

WooCommerce

No Code: Customize your online store quickly and easily

These solutions are available in US and Canada only. For all other regions, please contact us for support.

Step 1: Installation

Access plugin

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

Go to Plugin/Marketplace

Credentials

Our WooCommerce plugin requires credentials to our 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.

Configuration

To configure this plugin, follow these steps.

Log in to the Admin panel for WooCommerce.
Navigate to WooCommerce > Settings > Payments.
Under the Sales heading, select the Payment Methods option.
From here, you can click Manage to configure the API as well as the payment methods supported by Adobe Commerce.

Note: If this is your first time activating this plugin, the Settings page will appear first.

Settings

The API offers payment through credit and debit cards along with Card Storage / Tokenization.

Gateway settings

The Unified Payments Settings tab allows you to enter your overall account credentials.

Navigate to WooCommerce > Settings > Payments.
Use the toggle under Enabled to select the REST API Payments gateway.
Note: If this is your first time activating this plugin, the Settings page will appear.
If you already enabled the plugin and want to change the settings, click Manage.
The following table describes the fields that appear on the 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 will also be 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 Merchant Name	Human-readable label for this sandbox account (useful if you manage multiple test accounts).
Sandbox Merchant Site ID	Your sandbox merchant/site identifier issued by us. Routes test transactions to your account.
Sandbox Web API Key	Secret key used by the Woocommerce 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.
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.

Step 2: Test integration

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.

Step 3: Going live

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 WooCommerce Admin panel, and enable the “Live Mode” for the Unified Payments gateway.

Additional information

This section contains information on payment solutions such as Hosted Fields and as well as expanded features such as Card Management and Order Management.

Hosted Fields

For information on our PCI DSS requirement-reducing hosted solution, Hosted Fields (Drop-In UI), see our Hosted Fields - Overview page.

Card Management

All card data is tokenized using our tokenization service.
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.

Alt text:
Stored card.

Registered customers can see the list of their stored cards under My Account > Payment Methods.

Alt text:
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.

Alt text:
Add payment methods.

Order Management

Detailed information relating to the transaction outcome is available in the Orders section for WooCommerce.

Capture a transaction

Merchants who use “Authorize only” 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 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 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.
To capture a transaction, on the right-hand menu, go to Order actions. Select Capture credit card authorization to send the request to us.

Alt text:
Order actions.

When finished, click Update. A Capture request with the total amount authorized will now be sent.
Once complete, the result of the Settle request will be displayed as a comment in the Order notes. For example: Transaction captured.

Alt text:
Order notes.

Refund a captured transaction

Once an order is successfully settled with your Acquirer, you can choose to Refund the customer 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.

Alt text:
Refund transaction.

Once complete, the result of the Refund request will be displayed as a comment in the Order notes. For example: €10.00 was reversed or refunded.