Tpay
DOCS

WooCommerce

WooCommerce is an e-commerce plugin for WordPress that allows you to create and manage an online store. Tpay integration enables the quick implementation of popular payment methods, such as: BLIK, online transfers, cards, e-wallets, as well as installment and deferred payments. The Tpay plugin is regularly updated in accordance with the platform's requirements and expanded with new functionalities.

Logo

Before you start

Requirements:

  • WordPress platform with a minimum PHP version of 7.0.
  • Installed WooCommerce plugin.
  • A store with the currency set to Polish Złoty (PLN).
  • An active account at Tpay.
Note

To correctly receive transaction status notifications, it is necessary to allow the notification URL to be overwritten. In the Merchant Panel, go to the menu Settings → Notifications → in the URL for notifications section, enable the option: Allow overwriting the notification URL.

Before you start

Module installation

  1. Download the plugin to your computer.
  2. Log in to your WordPress admin panel.
  3. In the menu, select Plugins, then click Add New.
  4. Click Upload Plugin, then choose the downloaded plugin, install and activate it.

Add Plugin

Global settings configuration

  1. Go to WooCommerce, and then click the Tpay Settings tab.
  2. Using global settings means you will not have to re-enter the same configuration data for each payment method.

Configuration

Configuration fieldField description
Security code
The security code, available in the Tpay Merchant Panel in the SettingsNotificationsSecurity section.
Client ID
Available in the Tpay Merchant Panel in the IntegrationAPIKeys for the new Open Api section in the Client ID field.
API Secret
Available in the Tpay Merchant Panel in the IntegrationAPIKeys for the new Open Api section in the Secret field.
Tpay environment
Choice of the environment on which the plugin should operate.
Seller's e-mail
The email address to which transaction notifications from the Tpay system are to be sent.
Default status after order payment
The payment status of the order after the transaction has been paid.
Default status after payment, for virtual products
The payment status of the order after the transaction is paid, when the buyer purchases only virtual products.
Surcharge
An option that allows adding a surcharge to the order amount for using Tpay payments.
Payment display method
This option changes the way payment methods are displayed in the cart.
TAX ID field name
This option allows sending the TAX ID number to the Tpay system; in this field, enter the meta data of the form field.
BLIK Pay Later
Check this option if you want to enable this payment on your store.
Easy ON-site
A mechanism that allows a given payment method to be featured. Enabling a payment method will cause it to appear in the WooCommerce payment settings. To enable multiple payment methods, hold down the CTRL key on your keyboard.
Automatic order cancellation
A feature that allows for the cancellation of an order without a registered payment. After the order is canceled, the transaction cannot be paid by the buyer. Range from 1 to 30 days.

Payment configuration

  1. Go to WooCommerce, select Settings, and then click the Payments tab.
  2. Select the payment method you want to enable on your site and configure it by clicking Complete setup.
  3. In the Payments tab, a list of payment methods that can be activated in the plugin will appear.

List of payment methods

Payment namePayment description
Tpay bank list
Payments are displayed as bank tiles in the store's cart. The configuration also allows redirecting the buyer to the Transaction Panel.
BLIK
Displays the BLIK payment method in the store's cart. The configuration also allows enabling BLIK LVL 0.
Payment card (tpay.com page)
Displays the card payment method in the store's cart. The customer enters card details on the Transaction Panel.
Payment card (order page)
Displays the card payment method in the store's cart. The buyer enters card details on the store's page.
Pekao installments
Displays the installment payment method in the store's cart.

Bank list

The plugin allows for the presentation of all available payment methods directly on the store's page or, alternatively, redirects the customer to the Tpay Transaction Panel.

Bank list

Configuration fieldField description
Enable payment
Enable or disable the payment method in the store.
Name
The title of the payment method that customers will see during checkout.
Use global settings
Use the global settings. Thanks to this option, you do not need to re-enter authentication data for each payment configuration, as they are retrieved from the main (global) settings.
Security code
The security code, available in the Tpay Merchant Panel in the SettingsNotificationsSecurity section.
Client ID
Available in the Tpay Merchant Panel in the IntegrationAPIKeys for the new Open Api section in the Client ID field.
API Secret
Available in the Tpay Merchant Panel in the IntegrationAPIKeys for the new Open Api section in the Secret field.
Description
A description that will be visible under the payment title.
Enable for specified shipping methods
Select the shipping methods for which this payment should be available. Leave the field empty if it should be available for all.
Custom order
This function is responsible for changing the display order of banks that are to be displayed first, e.g., entering 64, 18, 13 causes the BLIK, mBank, ING payments to be displayed first. Full list of payment channels.
Hide the bank selection list
Hides the visible payment methods on the store's page. The buyer will be redirected directly to the Tpay Transaction Panel, where they will choose the payment method.
Notification address
The notification address to which notifications regarding the payment status will be sent.

BLIK

Allows for BLIK payments using a form integrated directly on the store's page or by redirecting the customer to the eBLIK service.

BLIK payment

Configuration fieldField description
Enable payment
Enable or disable the payment method in the store.
Name
The title of the payment method that customers will see during checkout.
Use global settings
Use the global settings. Thanks to this option, you do not need to re-enter authentication data for each payment configuration, as they are retrieved from the main (global) settings.
Security code
The security code, available in the Tpay Merchant Panel in the SettingsNotificationsSecurity section.
Client ID
Available in the Tpay Merchant Panel in the IntegrationAPIKeys for the new Open Api section in the Client ID field.
API Secret
Available in the Tpay Merchant Panel in the IntegrationAPIKeys for the new Open Api section in the Secret field.
Description
A description that will be visible under the payment title.
Enable for specified shipping methods
Select the shipping methods for which this payment should be available. Leave the field empty if it should be available for all.
BLIK LVL 0
Enable the BLIK LVL 0 option. Enable if you want the customer to enter the BLIK code on the store's page. A disabled option will cause the user to always be redirected to the external eBLIK page, where they will enter the code.
Notification address
The notification address to which notifications regarding the payment status will be sent.

Payment card - Payment on the order page

Accept card payments using a form provided directly on the store's page. The customer's card data is fully encrypted.

Payment card - Payment on the order page

Configuration fieldField description
Enable payment
Enable or disable the payment method in the store.
Name
The title of the payment method that customers will see during checkout.
Use global settings
Use the global settings. Thanks to this option, you do not need to re-enter authentication data for each payment configuration, as they are retrieved from the main (global) settings.
Security code
The security code, available in the Tpay Merchant Panel in the SettingsNotificationsSecurity section.
Client ID
Available in the Tpay Merchant Panel in the IntegrationAPIKeys for the new Open Api section in the Client ID field.
API Secret
Available in the Tpay Merchant Panel in the IntegrationAPIKeys for the new Open Api section in the Secret field.
Description
A description that will be visible under the payment title.
Enable for specified shipping methods
Select the shipping methods for which this payment should be available. Leave the field empty if it should be available for all.
Notification address
The notification address to which notifications regarding the payment status will be sent.

Payment card with redirection to the payment gateway

Accept card payments by redirecting the customer to the secure Tpay Transaction Panel. The customer's card data is fully encrypted.

Payment card with redirection to the payment gateway

Configuration fieldField description
Enable payment
Enable or disable the payment method in the store.
Name
The title of the payment method that customers will see during checkout.
Use global settings
Use the global settings. Thanks to this option, you do not need to re-enter authentication data for each payment configuration, as they are retrieved from the main (global) settings.
Security code
The security code, available in the Tpay Merchant Panel in the SettingsNotificationsSecurity section.
Client ID
Available in the Tpay Merchant Panel in the IntegrationAPIKeys for the new Open Api section in the Client ID field.
API Secret
Available in the Tpay Merchant Panel in the IntegrationAPIKeys for the new Open Api section in the Secret field.
Description
A description that will be visible under the payment title.
Enable for specified shipping methods
Select the shipping methods for which this payment should be available. Leave the field empty if it should be available for all.
RSA Key
The RSA key, available in the Tpay Merchant Panel in the Card paymentsAPIPublic RSA key section for the Elavon acquirer (visible after enabling the securesale method), whereas for the Pekao acquirer the key is in the Integration → API tab.
Notification address
The notification address to which notifications regarding the payment status will be sent.

Pekao installments

Redirects the customer to the external Bank Pekao service to fill out an installment application.

Pekao installments

Configuration fieldField description
Enable payment
Enable or disable the payment method in the store.
Name
The title of the payment method that customers will see during checkout.
Use global settings
Use the global settings. Thanks to this option, you do not need to re-enter authentication data for each payment configuration, as they are retrieved from the main (global) settings.
Security code
The security code, available in the Tpay Merchant Panel in the SettingsNotificationsSecurity section.
Client ID
Available in the Tpay Merchant Panel in the IntegrationAPIKeys for the new Open Api section in the Client ID field.
API Secret
Available in the Tpay Merchant Panel in the IntegrationAPIKeys for the new Open Api section in the Secret field.
Description
A description that will be visible under the payment title.
Enable for specified shipping methods
Select the shipping methods for which this payment should be available. Leave the field empty if it should be available for all.
Merchant ID
The Seller's identification number. In other words, it is the ID for logging into the Tpay Merchant Panel. This field is required to enable the installment simulator.
Installment simulator on the product card
The simulator will be visible on the product page.
Installment simulator in the shopping cart
The simulator will be visible on the cart page.
Installment simulator on the order page
The simulator will be visible on the order page.
Notification address
The notification address to which notifications regarding the payment status will be sent.

FAQ