Tabby works on the Magento 2 platform for all supported countries.
Installation Steps
1
Sign up at merchant.tabby.ai (KSA: merchant.tabby.sa) and fill in all your business details. Your test API keys are then available in the Merchant Dashboard under Business profile → Stores.
2
Install the extension with Composer - the recommended way to install it and to update it later.
3
Configure Tabby as a payment method using your test keys.
4
Place a test order and refund it to confirm that the full flow works.
5
Replace the test keys with your live keys and deploy to production.
Install with Composer
tabby/m2-payments is a metapackage that pulls both Tabby modules: tabby/m2-checkout (payment methods, promotions, webhooks) and tabby/m2-feed (product catalogue).
Update the extension
Run the same sequence withcomposer update to move to the latest release:
Composer reports a higher matching version on packagist.org
Composer reports a higher matching version on packagist.org
If Composer stops with “Higher matching version 7.0.2 of tabby/m2-payments was found in public repository packagist.org”, your project is pinned to an older constraint. Require the version range explicitly and run the update again:
Other Ways to Install
Composer is the supported path. Use one of these only if Composer is not available to you.Manual installation from an archive
Manual installation from an archive
- Download the extension archive.
-
Create the directory
Magento2_root/app/code/Tabby/Checkout/if it does not exist. -
Unpack the archive and move all files into
Magento2_root/app/code/Tabby/Checkout/. -
Verify that Tabby_Checkout appears in the list of disabled modules:
-
Enable the module and rebuild:
Adobe Commerce Marketplace
Adobe Commerce Marketplace
The extension is published as Tabby M2 Payments. Add it to your Adobe Commerce account and install it from your Marketplace purchases. Adobe delivers the same Composer package, so the Magento commands in Install with Composer still apply.
Configure Tabby as a Payment Method
Sign in to your Magento 2 admin portal and go to Stores > Configuration > Sales > Payment Methods > Tabby Payments. In the Tabby Api section:
Then enable the payment method in the Tabby Checkout - Split in 4 section and click Save Config. Saving validates your keys and registers your webhooks with Tabby.
If the changes do not take effect immediately, go to System > Cache Management, click Flush Magento Cache, then sign out and sign back in to reset permissions.
Manage Tabby Product Catalogue Feature
The product catalogue lists your products on the Tabby Shop. Enable it in Stores > Configuration > Sales > Payment Methods > Tabby Payments > Tabby Feed.
Test Your Integration
Place an order with Tabby and refund it (create a Credit Memo) to confirm that the full flow works. When the test order and the refund go through, you can move to the live environment yourself. Tabby does not run a separate sign-off on your integration.Connect to the Live Tabby Environment
1
Copy the live Public and Secret keys from the Merchant Dashboard under Business profile → Stores. If the live keys are not shown there yet, ask Tabby Partner Support at
partner@tabby.ai (or partner@tabby.sa for KSA) to make them visible.2
Enter them in Stores > Configuration > Sales > Payment Methods > Tabby Payments on your production site.
3
Click Save Config. Webhooks are registered per key pair, so this save is what creates your live webhooks - do it on production even if you copied the configuration over from staging and the keys are already in place.
Specific Settings
Promotions Only Mode
If your checkout runs through another provider, the plugin can serve Tabby promotions only: it enables the product and cart page snippets and hides Tabby at checkout. Go to Stores > Configuration > Sales > Payment Methods > Tabby Payments, and set Tabby plugin mode to Promotions only:
Promo only mode
Use Your Own Magento Store Codes
By default there is nothing to send us: with Aggregate store by currency set to Yes, the extension derives the merchant code from the store’s base currency (AE for AED, SA for SAR) and Tabby registers those codes for your account.
Use your Magento store codes instead when you need a separate Tabby merchant code per store group, for example for separate reporting or separate payment plans per brand:
1
In the Magento admin, go to Stores > All Stores and copy the Code of every store group you sell with.

2
Ask Tabby Partner Support at
partner@tabby.ai (or partner@tabby.sa for KSA) to set them up as custom merchant codes, for example website_store_ae. Wait for confirmation that the codes are registered on Tabby’s side.3
Set Aggregate store by currency to No. The extension now sends the store group code as the merchant code.
Sell in Several Currencies
If one store group sells in more than one currency, enable Use local store currency on checkout. The extension then charges in the currency the customer sees and appends it to the merchant code, for exampleSA_SAR. These codes have to be registered on Tabby’s side too, so ask Tabby Partner Support to set them up before you turn this on.