PrestaShop Tap Payment Gateway User Guide

The PrestaShop Tap Payment Gateway module integrates secure Tap card payments into your PrestaShop store, ensuring a safe, efficient and highly reliable transaction experience for global shoppers.

This module supports card payments in various GCC and global currencies such as SAR, AED, KWD, USD and EUR. It features Secure 3D authentication and automatic order synchronization.

This guide details the complete setup process, including module installation, Tap API key capture, sandbox and live mode configuration, refund processing, and the customer checkout journey.

NOTE: PrestaShop Tap Payment Gateway is compatible with PrestaShop Multi-store feature.

• Add Tap Payment as a checkout option for your customers.
• 3D Secure is enabled by default.
• Sandbox and Live modes are switched with mode-specific secret API keys.
• Tap the hosted payment page or on-premises payment page (HPP) before being redirected.
• Admin Transaction Index with bill ID, order link, customer, amount, refund, status and date.
• Direct order ID link from transaction list to PrestaShop orders.
• Process full refunds and partial refunds from the transaction details view.
• Refund status and history tracking against original transaction.
• Tap the webhook listener with a custom module front controller.
• A special PrestaShop order status “Waiting for payment” is installed on module installation.
• Multi-currency support: SAR, AED, KWD, BHD, QAR, OMR, USD, EUR and GBP.
• Enhanced transaction protection with integrated Secure 3D authentication.

• First, go to the module manager in the back office and click ‘upload module’.
• After that, drag and drop the module file or select the file from the system.
• This way the module installation will be successful.

• Step 1 — Create an Account Tap

Tap Payments offers merchant accounts for businesses operating in Saudi Arabia, UAE, Kuwait, Bahrain, Qatar, Oman, and Egypt, plus international merchants upon request.

Register at:

Complete the merchant onboarding form with your business details, upload the required KYC documents (commercial registration, ID, bank details), and wait for approval.

Once your account is approved, you can log in to the Tap Payments merchant dashboard.

• Step 2 — Find your API Credentials

Once logged into the Tap merchant dashboard, navigate to the API or Developer section to find your API key.

Tap provides two separate sets of keys — one for the Sandbox (test) environment and one for the Live environment.

Connect the module to your Tap Payments account and choose how the payment page is displayed to customers through the module configuration.

• Direct mode: When enabled, the module uses a secret API key directly for real payments. If disabled, this module uses the Test secret API key for sandbox payments.

• Direct secret API key: The secret key to your Tap merchant dashboard for the Live environment. This field is required if Live mode is enabled.

• Test the secret API key: The secret key of your Tap merchant dashboard for the Sandbox environment. This field is required if Live mode is not active.

• Payment via Mandiri HPP: If disabled, the module will redirect customers directly to the Tap-hosted checkout page. If enabled, the module will display a payment form in your Front Office first, then redirect to Tap to complete payment.

After installation, a new “Transactions” tab appears in the PrestaShop admin sidebar.

The Transactions tab stores any Tap Pay fees processed through the store and allows you to initiate a refund.

On this tab, admins can initially see a list of all Transactions carried out using the PrestaShop Tap Payment Gateway module.

The list displays ID, Transaction ID, Order ID, Cart ID, Customer Name, Total amount, Refund total, Status, and Transaction date.

View transactions

Click the View action on any row to open the transaction details view.

The details view shows the transaction ID, customer name and email, order link, currency, total amount, refund amount, current status, and transaction date.

Issue a refund

1. Open the transaction details view.
2. Select Full refund to return the entire amount taken, or Partial refund to enter a specific amount.
3. Send a refund.
4. If successful, the refund amount and refund status are updated on the same view, and the refund is recorded based on the original transaction.

Refund history is saved per transaction, so admins always have an audit trail of partial refunds.

On the checkout page, “Pay by Tap Payment” appears as a payment option (if the cart currency is supported and the module is configured correctly).

When the customer selects ‘Pay by Tap Payment’ as the payment method and confirms the order, the module then initiates the payment flow.

If ‘Self-paid HPP payment’ is disabled, customers are directed to a hosted secure payment page Tap to enter card details, complete 3D Secure authentication and complete payment.

If you activate “Payment via HPP Mandiri”, your shop embeds a payment form on the confirmation page.

Customers enter card details directly without leaving your domain, after which Tap processes payment and returns to your order confirmation page.

In both flows, Tap Payments sends a webhook to your store endpoint. Modules then:

• Validate signature
• Create or update a PrestaShop order
• Set the order status to “Payment received” for collected payments or “Waiting for Tap payment” for pending or authorized payments
• Record costs in the Transactions grid

After successful payment, the system directs the customer to the order confirmation page.

If a payment fails or the customer cancels, the checkout page displays an error message that allows the customer to retry the payment or choose another payment method.

This is all about PrestaShop Tap Payment Gateway Module. I hope this document will help you in checking the module functionality better.

Also, let us know about your views in the comments.

For technical assistance or any questions, please submit a ticket or email us at [email protected]

Additionally, feel free to explore our Prestashop development services and a wide range of quality Prestashop add-ons.