Skip to content

Plugins

On this page

Magento 2 Plugin

Install the Paymos module for Magento 2 or Adobe Commerce, connect test and live credentials, and verify the order-to-invoice status flow.

1. Requirements

  • Magento Open Source or Adobe Commerce 2.4.x and command-line access
  • A Paymos account with a project selected in the dashboard
  • The module itself: through Composer from the Adobe Commerce Marketplace, or the official ZIP from GitHub Releases

Official packages are identical for every merchant and contain no API keys, API secrets, project IDs, webhook secrets, OAuth tokens, or device codes.

2. Install

Magento has no admin uploader for extensions, so either path ends at the same console commands. First pick how the files arrive.

Adobe Commerce Marketplace. When the extension is listed there, Composer brings the module and the Paymos PHP SDK together:

composer require paymos/magento2-payment

Dashboard ZIP. Take paymos-magento2-<version>.zip from GitHub Releases or the CMS integration panel in the Paymos dashboard, and extract it at the Magento root. Entries are laid out as app/code/Paymos/Payment/… with the SDK vendored inside, so nothing has to be moved and no Composer step is needed.

Finish either path with the same commands:

bin/magento module:enable Paymos_Payment
bin/magento setup:upgrade
bin/magento setup:di:compile   # production mode only
bin/magento cache:clean

setup:upgrade creates two tables: paymos_payment_invoice, one snapshot per order, and paymos_payment_event, the webhook de-duplication ledger. Then open Stores → Configuration → Sales → Payment Methods → Paymos and click Connect Paymos.

3. Connect

  1. Open the project you want to connect in the Paymos dashboard. The plugin uses that current project automatically; it never asks you to select it again.
  2. Click Connect Paymos in Magento 2.
  3. Approve the displayed store URL and current project in Paymos. There is no second project selector.
  4. Return to the CMS after the connected status appears.

For Sandbox and Live, Paymos reuses the merchant's single active Payment key or creates one when none exists. It reuses a webhook only when the exact callback URL, Invoice category, and current project match; otherwise it creates a dedicated Invoice webhook. A conflicting webhook at the same URL is never silently overwritten:

https://your-store.example/paymos/payment/callback

OAuth device authorization is only the one-time delivery channel. The short-lived token is discarded; runtime Merchant API calls remain HMAC signed.

4. Secret storage

Credentials and temporary device state are stored in core_config_data encrypted through Magento EncryptorInterface and its installation encryption key. Saved secrets are not rendered back into the administration page.

5. Test and go live

Select Sandbox, place a test order, and confirm the invoice and webhook-driven status update. Switch the same installation to Live when ready; reconnect only after changing the store URL, revoking a Payment key, or rotating a webhook secret.