Tpay
API
Changelog

Integration methods

The primary entity handled by our payment gateway is a transaction. The payment flow may vary depending on the integration and the payment channel.

Below are some integration methods you can implement with our payment gateway.

Basic integration

The basic payment flow in our system is as follows:

  1. Create a Transaction: The first step is to create a new transaction in the system.
  2. Redirect to the Transaction Panel: The user is then redirected to the Transaction Panel, where they can complete the payment.
  3. Payment Completion: The user completes the payment on the Transaction Panel.
  4. Payment Confirmation Notification: After the payment is successfully completed, the system sends a notification confirming the transaction.

On-site integration

For some payment methods, it is possible to process the payment without redirecting to the Transaction Panel. These are referred to as on-site or Level 0 integrations. In this case, the entire payment process is handled within your system.

The payment process for this case is:

  1. Create a Transaction: Start by creating a new transaction in the system.
  2. Display the Payment Form in Your System: Then, display the payment form directly within your system.
  3. Send Form Data to Complete the Transaction: The user fills out the form on your site, and the data is sent to the payment system to complete the transaction.
  4. Payment Confirmation Notification: After the payment is successfully completed, you receive a notification confirming the transaction.

More details can be found in the payment methods where this integration is possible (BLIK, Cards, Visa Mobile, Google Pay, Apple Pay)

Two-step integration

The Tpay system allows for a refund request to be initiated for a transaction before the funds have been credited to the merchant's account.

In the case of two-step payment acceptance, we send two system notifications.

  1. The first system notification informs the merchant's system that a payment has been made for the transaction, and we await a response from the merchant's system on whether to accept or refund the transaction. The merchant does not set any data, time vectors, or anything else with us. The integration is based on their system.
  2. The second system notification is sent once we know the merchant's decision. This is a standard notification containing transaction data, including its status (successful, refunded, etc.).
Note
  • Notifications for transactions are sent according to the notification delivery schedule. Failure to respond to the last notification will be treated as if your system responded with FALSE. As a result, the transaction will be refunded to the payer.
  • A transaction with an empty result URL will be automatically refunded after 7 days from the payment time if it still has the PAID status.

The payment process for this case is:

  1. Create a Transaction: The first step is to create a new transaction in the system.
  2. Redirect to the Transaction Panel: The user is then redirected to the Transaction Panel, where they can complete the payment.
  3. Payment Completion: The user completes the payment on the Transaction Panel.
  4. Payment Notification: The first system notification informs the merchant's system that a payment has been made for the transaction, awaiting information on whether to accept or refund the transaction.
  5. Payment Confirmation Notification: After the payment is successfully completed, the system sends a notification confirming the transaction.
Note

The on-demand two-step integration mode will activate Customer Service Office on your account.

Recurring/cyclic Integration

For payment cards, it is possible to implement recurring payments (e.g., subscriptions, installments, etc.). In this case, upon successful card payment, we can return information about a payment token, which you can use for future recurring payments. There are two types of payments where we return a token.

Purchase transaction token can be returned during a regular card transaction:

  1. Create a Transaction: Start by creating a new transaction in the system.
  2. Redirect to the Transaction Panel or on-site Integration: The user is then redirected to the Transaction Panel to complete the payment, or during the on-site card integration, you set the parameter to issue a token.
  3. 3D Secure Authentication: The payer authenticates payment with the 3D Secure.
  4. Payment Completion: The payer completes the transaction.
  5. Payment Confirmation Notification: After the payment is successfully completed, you receive the notification confirming the transaction, along with the payment token.
  6. Store the Payment Token: Store the payment token for future transactions.
  7. Recurring Payments: Process subsequent transactions for the same card using the received payment token.

More information can be found here.

Payment without charging (known also as Account Verification Transaction) means that the payer's account is not charged any amount:

  1. Create a Tokenization: Start by creating a new tokenization in the system.
  2. Redirect to the Transaction Panel: The payer is then redirected to the Transaction Panel, where he provides payment card details.
  3. Tokenization Authentication: The payer authenticates payment with the 3D Secure.
  4. Tokenization Confirmation Notification: After the process is successfully completed, you receive the notification containing the payment token.
  5. Store the Payment Token: Store the payment token for future transactions.
  6. Recurring Payments: Process subsequent transactions for the same card using the received payment token.

More information can be found here.