VibeFox Paysera for OpenCart — Help

Requirements

OpenCart: 3.0.x (tested on 3.0.5.0) or 4.0.2 and later (tested on 4.1.0.3).

PHP: 8.0 or later.

Paysera project: you need the project ID and the project password (sign key) of your Paysera project. The payment methods the customer sees are the ones enabled in this project. Nothing has to be configured in Paysera for the callback: its URL is sent with every payment request.

Reachable store: orders get their status from the Paysera callback, so your store must be reachable from the internet, not behind a login, basic authentication or a firewall. The callback itself works while the store is in maintenance mode.

VibeFox license key: bought on vibefox.net. One key works on one domain.

Installation

The download is one zip file with the packages for both OpenCart versions. Unpack it on your computer. It contains README.txt, the OpenCart 3 package wcp_paysera_payment-oc3-(version).ocmod.zip and the OpenCart 4 package wcp_paysera_payment.ocmod.zip. Install only the package for your OpenCart version. The license key is the same for both versions.

OpenCart 3

1. In the admin go to Extensions > Installer, click Upload and choose the file wcp_paysera_payment-oc3-(version).ocmod.zip. The extension has no OCMOD modifications, so Extensions > Modifications does not need a refresh. Instead of the installer you can copy the contents of the upload folder of this package into the root folder of your store.

2. Go to Extensions > Extensions and choose the type Payments. Find VibeFox Paysera Payment and click Install (the green + button). Your admin user needs the right to modify the payment extensions list.

3. Click Edit (the pencil button) to open the settings page. Paste your VibeFox license key into License key in the license block at the top of the page and click Activate (see License key).

4. Enter the Project ID and the Project password from your Paysera account (see Configuration).

5. Optional: enable Allow test payments in the Paysera project and Test payments in the extension to try the flow without charging money. Turn it off before selling.

6. Turn on Enable/Disable and click Save.

OpenCart 4

1. In the admin go to Extensions > Installer, click Upload and choose the file wcp_paysera_payment.ocmod.zip. Do not rename the file: OpenCart 4 takes the extension code from the file name, and a renamed package does not work.

2. The package appears in the list of installed extensions on the same page. Click Install (the green + button) next to it.

3. Go to Extensions > Extensions and choose the type Payments. Find VibeFox Paysera Payment, click Install (the green + button), then Edit (the pencil button).

4. Enter the license key, the project ID and password and the test settings as in steps 3 to 6 for OpenCart 3. The settings page and its fields are the same in both versions. Only the callback URL is different (see Paysera project).

A new install starts with the payment method turned off, test payments off and the Production environment.

Configuration

All settings are on the extension page: Extensions > Extensions > Payments > VibeFox Paysera Payment > Edit. The sections are listed on the left; the Save button under the list saves the whole page. Above the settings the page shows Paysera is hidden at checkout until the project ID and the project password are entered. while one of them is missing, and Test mode is on: customers are not charged. Turn off "Test payments" and select "Production" before accepting real orders. while test payments or the sandbox are on. Without the right to modify the extension the page shows the settings but cannot save them.

When you save, Title must have 1 to 128 characters, Project ID must contain digits only, Sort Order must be a whole number, Total must be a number of 0 or more and the order statuses must exist. If any check fails, nothing is saved and the page lists the errors.

Paysera

Enable/Disable: Enable Paysera Payment turns the payment method on or off. Default: off.

Title: the payment method name customers see at checkout. It is also the payment method name stored in the order. Default: Paysera. Required, up to 128 characters.

Description: the text shown to the customer at the Confirm Order step, above the confirm button. Default: Pay securely via Paysera.

Sort Order: the position of Paysera among the payment methods at checkout. Leave it empty or enter a whole number.

Geo Zone: offer Paysera only for payment addresses in the selected geo zone. Default: All zones. Geo zones are set up in System > Localisation > Geo Zones.

Total: the checkout total, in the default currency of the store, that an order must reach before Paysera is offered. Leave it empty to offer Paysera for any total.

Paysera project

Find the project ID and the project password in your Paysera account under Projects and activities, your project, General project settings. The section has a link to the Paysera account.

Callback URL: the address Paysera uses to confirm every payment. On OpenCart 3 it looks like https://your-store/index.php?route=extension/payment/wcp_paysera_payment/callback, on OpenCart 4 like https://your-store/index.php?route=extension/wcp_paysera_payment/payment/wcp_paysera_payment.callback. It is built from the storefront address of your OpenCart installation. It is sent with each payment automatically, so nothing has to be configured in Paysera, but it must be reachable from the internet. Orders get their status only from these signed or encrypted callbacks.

Project ID: the numeric ID of your Paysera project. Only digits are accepted: any other value gives the error Project ID must contain digits only: the numeric ID of your Paysera project. and nothing is saved.

Project password: the project password (sign key). It signs payment requests and verifies Paysera callbacks. The saved password is never shown again. The field stays empty and shows Saved — leave empty to keep it. Type a new value only to change it. To remove the saved password, tick Clear saved password (tick and save; an empty field keeps the saved value) under the field and click Save.

Testing

Test payments: sends payments in test mode, so no money is charged. Paysera returns a successful test payment without charging the customer. Enable Allow test payments in the Paysera project settings first. While this option is on, test payments mark orders as paid; when it is off, a test payment puts the order on hold. Default: off. While it is on, customers see TEST MODE — no money will be charged. at the Confirm Order step.

Environment: where the customer is sent. Keep Production for a normal Paysera project, also for test payments. Default: Production.

Orders

OpenCart creates the order at the Confirm Order step without a status (a missing order). The order gets a status only from the Paysera callback. A cancelled or not executed payment leaves it without a status, and the customer can pay again. Each field below lists your OpenCart order statuses.

Order Status After Payment: the status set when Paysera confirms the payment with the expected amount and currency. Default: Processing.

Awaiting Payment Status: the bank accepted the payment order but has not executed it yet. The order is marked paid when Paysera confirms the payment. Default: Pending.

On Hold Status: a TEST payment while Test payments is off, a different amount or currency, or a payment after the customer cancelled it. The order is not marked paid; a note explains why. Default: Pending, because OpenCart has no On hold status. You can create your own status in System > Localisation > Order Statuses and select it here.

Cancelled Order Status: the extension never sets this status. It only reads it: a payment that arrives for an order in this status does not reopen the order, only a note is added. Default: Canceled.

Advanced

Debug log: writes payment events to wc_psr_debug.log.php in the OpenCart logs folder (storage/logs). The file cannot be opened from the web. Errors and warnings are always written; the other steps only while this option is on. Passwords and customer data are never written. Default: off.

Log: shows the size and the latest entries of the log. Click Clear log to empty it.

Delete data: when on, uninstalling the extension removes the extension settings and the log. Order data (orders, Paysera payment records) is always kept. Default: off.

Import / Export

Export: Download JSON saves the settings as a JSON file. The project password is not exported.

Import: paste previously exported JSON and click Import to restore the settings. The saved project password is kept.

Checkout

At the Payment Method step the customer chooses the payment method (by default Paysera). At the Confirm Order step the customer sees your description and the note You will be redirected to the Paysera payment window (bank links, cards and other Paysera methods) to complete the payment. OpenCart creates the order at this step, still without a status. On OpenCart 4 the customer picks the payment method with the Choose button of the payment method block, in the window Payment method options, and clicks Confirm Order at the bottom of the checkout page. When the customer clicks Confirm Order, the extension builds a signed payment request with the order number, the order total in the minor unit of the order currency, the customer's name, e-mail and billing address, and the language of the store page (Lithuanian, Latvian, Estonian, Russian, German, Polish, otherwise English). The customer is sent to the Paysera payment window and chooses a bank, card or other method there.

Paysera confirms the payment with a server-to-server callback. The order is marked paid only after Paysera confirms it with a signed callback; the customer's return to the store never pays an order. The order then gets its status the standard OpenCart way, with the usual order e-mails and stock update. When the customer comes back after the callback, the OpenCart order success page is shown. If the bank has accepted the payment order but not executed it yet, the order gets the Awaiting Payment Status and the page shows Paysera is confirming your payment. You will receive an e-mail as soon as it is confirmed — there is no need to pay again. For an order on hold the page shows Your payment is being reviewed. We will contact you if anything else is needed.

If the customer comes back before the callback, a Payment confirmation page explains that the order will be confirmed as soon as Paysera confirms the payment and offers Check again and Back to checkout.

If the customer cancels in the Paysera window, the customer is back at checkout with The Paysera payment was cancelled. You can try again or choose another payment method. If Paysera reports that the payment was not executed, the message is The payment was not completed. You can try again or choose another payment method. The cart is kept in both cases. On OpenCart 4 these messages are shown above the checkout page. OpenCart 3 creates a new order every time the Confirm Order step is shown, and OpenCart 4 updates the order of the checkout (a new attempt pays the same order); if another order of the same cart is already paid, awaiting payment or on hold, a new attempt goes straight to the success page instead of a second payment. A change of the cart, including a new quantity, counts as a new cart that needs its own payment.

OpenCart 4 keeps the order in the checkout until the success page is shown. If that order was closed meanwhile (for example you cancelled an order that was awaiting the bank payment), the customer is sent back to the checkout with the message Your previous order was cancelled or refunded by the store. Please confirm the order again to pay with a new order. The next Confirm Order pays a new order. If that order was already paid for an earlier cart and the cart has changed since, the customer is taken back to the checkout, and the next Confirm Order pays a new order of the current cart. A closed order is never shown as paid.

If the payment cannot be started, the customer stays at the Confirm Order step with Paysera payments are temporarily unavailable. Please choose another payment method. or, for an invalid order total, This order cannot be paid via Paysera. The reason is written to the log.

The callback also works while the store is in maintenance mode, because OpenCart lets payment extension requests through (on OpenCart 4 the extension adds its own startup action for this, which also lets the customer return from Paysera).

The extension has no refunds from the admin, no choice of bank or payment method on the checkout page, no subscriptions, no saved cards and no Paysera delivery or courier services.

Orders

Order statuses

No status (missing order): the customer was sent to Paysera and the callback has not arrived yet, or the customer cancelled, or the payment was not executed. In Sales > Orders such orders are shown only with the filter Order Status set to Missing Orders.

Order Status After Payment (default Processing): Paysera confirmed the payment with the matching amount and currency. A note shows the request and the payment method, marked (TEST — no money charged) for test payments.

Awaiting Payment Status (default Pending): Paysera accepted the payment order, but the bank has not executed it yet. The order moves to Order Status After Payment when Paysera confirms the payment.

On Hold Status (default Pending): the payment needs a manual review. The paid amount or currency differs from the order total, a TEST payment arrived while Test payments is off (no money was charged), or the payment was confirmed after the customer had cancelled it. The note explains it, and the order tab asks you to check the payment in your Paysera account, then set the order to the paid status or cancel it and refund the payment in Paysera. A later correct payment for the same order marks it paid.

Cancelled Order Status (default Canceled): a payment confirmed later for a cancelled order does not change its status. A note asks you to restore the order (set it to the paid status) or refund the payment in Paysera. If the payment method of the order is no longer Paysera, a confirmed payment also adds only a note.

If another successful payment arrives for an order that is already paid, or for another order of a cart that is already paid, the paid order is not changed, and a note asks you to refund the duplicate in your Paysera account. Other Paysera statuses (payment not executed, additional information) only add a note. Notes are entries in the order History that the customer does not see.

VibeFox Paysera Payment tab

In Sales > Orders open an order paid with Paysera. At the bottom of the order page, next to History and Additional, the VibeFox Paysera Payment tab shows the Paysera order ID (the order number and the attempt), the Paysera request ID, the Environment and a TEST payment mark, the payment Status, the amounts Requested / paid, the Payment method and the Notes of the extension. For an order on hold it shows what to check. The tab only shows information and is shown to users who have access to the extension.

Refunds

Refunds from the admin are not supported: the Paysera payment window protocol has no refund API. Make refunds in your Paysera account. When Paysera reports a refund, a note with the refunded amount is added to the order, and the order status is not changed. Record the refund in OpenCart manually if needed. Product returns in Sales > Returns do not send money back through Paysera.

License key

The extension works with a VibeFox license key from vibefox.net. The license block License — VibeFox Paysera Payment is the first block on Extensions > Extensions > Payments > VibeFox Paysera Payment > Edit, above the settings. Paste the key into License key and click Activate. After that the block shows the key masked, the status (for example the date the license is active until and your domain) and the buttons Check now to check the status again, Change key to enter another key and Remove key to remove the key from this store. Below them are the line Product: opencart-payment-paysera and the link Manage licenses and domains in your account, which opens your vibefox.net account. Only admin users with the Modify permission for the extension can change the key. The texts of the block follow the admin language (English and Russian are included).

If the key is not accepted, the block says why, for example Key not found, This key belongs to another product, Domain limit reached or License expired on a date. After the store address changes, or after you free a domain slot in your account, click Check now. If the license server cannot be reached, the extension keeps working on the last known status.

One key works on one domain: the store address from the OpenCart configuration. Removing the key from the store does not free its domain slot. Free the slot in your vibefox.net account.

Without an active key, Paysera is not shown to customers at checkout. If a payment is started anyway, the customer sees This payment method is not available. Please choose another one. An admin user who is logged in to the admin in the same browser still sees the payment method in the store, marked (unlicensed — visible to admins only), so you can set up and test the extension before you buy a key. On OpenCart 4 this preview is not available: the store does not see the admin login, so without an active key the payment method is hidden for everybody. After you have opened the Edit page once, a reminder appears on the admin Dashboard. Close it with × to hide it for 7 days. Existing orders are not affected: payments already started are still confirmed by the callback.

When a license expires, the extension keeps working, but updates and support need a renewal. The status is checked again automatically when you open the admin Dashboard or the Edit page: once a day for the first 14 days after the key is entered, then once a week. No cron job is needed. Uninstalling the extension always removes the license key and license status.

Troubleshooting

Paysera does not appear at checkout: check that the license is active, Enable/Disable is on and both Project ID and Project password are entered. The settings page shows a warning while they are missing. Also check that the payment address is in the selected Geo Zone and that the order reaches the Total set in the settings.

The payment went through, but the order stays without a status: the order gets its status from the Paysera callback, not from the customer's return. Check that your store is reachable from the internet at the Callback URL shown in the settings (not behind a login, basic authentication or firewall), and look at the Log field on the extension page.

Callback answers Invalid signature: the Project password does not match the project, or the callback is not from Paysera. Copy the project password again. If you changed the project or the password, payments started before the change can no longer be verified.

Callback answers Project ID mismatch: the Project ID in the settings differs from the project that made the payment.

Callback answers Order not found: the order in the callback has no Paysera payment in this store, for example the payment was started in another store with the same project.

Callback answers Gateway not configured, Busy or Temporary error: the project ID or password is empty, another callback for the same cart is still running, or the order status could not be set. Paysera retries the callback. Turn on Debug log to see the reason.

Paysera rejects the payment window or says the project does not exist: check Environment. A normal Paysera project works only with Production; Sandbox needs a project created in the Paysera sandbox environment.

The test payment does not pay the order: a TEST payment pays an order only while Test payments is on. Otherwise the order is put on hold with a note that no money was charged. Also enable Allow test payments in the Paysera project.

An order is on hold with a note about an amount/currency mismatch: Paysera confirmed a payment whose amount or currency differs from the order total. Compare the payment in your Paysera account and accept the order or refund the payment manually.

The customer sees Paysera payments are temporarily unavailable: look at the Log field. The project ID or password may be empty, or one of the store addresses sent to Paysera is longer than 255 characters.

The customer sees This payment method is not available. Please reload the checkout page.: the checkout session no longer matches the order, or the payment method was turned off meanwhile. The customer reloads the checkout.

Uninstall

Go to Extensions > Extensions, choose the type Payments and click Uninstall (the red − button) next to VibeFox Paysera Payment. The license key and license status of this extension are always removed. OpenCart always removes its own settings of the extension: Enable/Disable, Sort Order, Geo Zone, Total and the order statuses of the Orders section, which return to their defaults on a re-install. The OpenCart event of the extension is removed too (on OpenCart 4 its events and its startup action, which lets the callback and the customer's return through in maintenance mode). If Delete data is on, the other settings (title, description, project ID and password, testing, logging) and the log are removed. If it is off, they are kept for a later re-install. The Paysera payment records are always kept. Existing orders keep their payment notes.

On OpenCart 4, to remove the files of the extension as well, go to Extensions > Installer after the uninstall and click Uninstall (the orange − button) next to VibeFox Paysera Payment in the list of installed extensions, then Delete (the red bin button) to remove the uploaded package.

Paysera is a trademark of its respective owner. This extension is not affiliated with or endorsed by Paysera.