Tpay
API

Installments

Installment payments are a financing method that allows consumers to spread the cost of a purchase into several smaller, regular payments instead of paying the full amount upfront.

How does the installment payment system work?

The process of purchasing on installments typically involves the following steps:

  1. Product or Service Selection: The customer selects the product or service they wish to purchase and adds it to their shopping cart.
  2. Payment Method Selection: Among the available payment methods, the customer chooses the Installment Payment or Installments option and selects the appropriate installment plan.
  3. Credit Check: The installment service provider conducts a credit check to assess the customer's ability to repay the installments.
  4. Establishment of Financing Terms: The customer accepts the proposed installment plan, which includes the number of installments and the amount of monthly payments. These terms may also include any applicable interest rates and additional fees.
  5. Contract Signing: The customer formally accepts the installment payment terms by signing a financial agreement. For online purchases, acceptance is usually digital.
  6. Receipt of Product or Service: After the installment payment is approved, the customer receives the product or service according to the seller's delivery policy.
  7. Regular Payments: The customer makes regular installment payments according to the agreed-upon schedule until the full purchase amount is paid off.

Available installment providers

We offer three installment payment providers: Raty Pekao, Alior Raty and PragmaPay.

PragmaPay Installment for business

Terms of Service

  • The minimum amount is 100 PLN, and the maximum is 50 000 PLN.
  • The repayment period is 3, 6, 9 or 12 months.
  • MCC Code from outside the table below
MCC CodeCode Name
1041Production of oils and other liquid fats
1101Distilling, rectifying, and blending of alcohols
2446Manufacturing of nuclear fuels
2540Manufacturing of weapons and ammunition
4612Activities of agents engaged in the sale of fuels, ores, metals, and industrial chemicals
4671Wholesale sale of fuels and related products
4672Wholesale sale of metals and metal ores
4677Wholesale sale of waste and scrap
9200Activities related to games of chance and mutual betting
9491Activities of religious organizations
9492Activities of political organizations
9405Organizations and associations

Installment transaction

Process installment payments by using the transaction creation endpoint and providing the appropriate payment channel identifier.

Payment Channel NameChannelId - identifier
Raty Pekao 1%77
Raty Pekao 3 x 0%78
Raty Pekao do 10 x 080
Raty Pekao 0,7%81
Alior Raty49
PragmaPay Installment for business86

Send a request to create an installment transaction

To create a BNPL transaction, send a POST request to the endpoint:

https://api.tpay.com/transactions

Check the details in the API Reference documentation: POST /transactions

In the request, specify the following parameters:

amount
Transaction amount (in PLN).
description
Transaction description visible to the payer.
payer.email
Payer's email address.
payer.name
Payer's full name.
pay.channelId
Installment payment channel identifier.

The basic request body should look like this:

{
  "amount": 0.1,
  "description": "Testowa transakcja ratalna",
  "payer": {
    "email": "[email protected]",
    "name": "Jan Nowak"
  },
  "pay": {
    "channelId": 77
  }
}

Example:

curl --location 'https://api.tpay.com/transactions' \
--header 'Authorization: Bearer <access_token>' \
--header 'Content-Type: application/json' \
--data-raw '{
   "amount": 0.1,
   "description": "Testowa transakcja ratalna",
   "payer": {
      "email": "[email protected]",
      "name": "Jan Nowak"
   },
   "pay": {
      "channelId": 77
   }
}'

After sending the request, you will receive a TransactionCreated schema in response.

The key response parameters are:

result
success - The transaction was successfully created.
status
pending - The transaction is awaiting payment.
transactionPaymentUrl
URL to which the payer should be redirected.

Example response:

{
  "result": "success",
  "requestId": "786dee7ec39502226238",
  "transactionId": "ta_73qDVKjNvNQ5GbLn",
  "title": "TR-CWM-D14339X",
  "posId": "ps_e4dkPVDEm4Jg726q",
  "status": "pending",
  "date": {
    "creation": "2024-07-04 21:15:23",
    "realization": null
  },
  "amount": 0.1,
  "currency": "PLN",
  "description": "Testowa transakcja ratalna",
  "hiddenDescription": "",
  "payer": {
    "payerId": "py_a9rjlZWxRLdG1bqY",
    "email": "[email protected]",
    "name": "Jan Nowak",
    "phone": "",
    "address": "",
    "city": "",
    "country": "PL",
    "postalCode": ""
  },
  "payments": {
    "status": "pending",
    "method": "pay_by_link",
    "amountPaid": 0,
    "date": {
      "realization": null
    }
  },
  "transactionPaymentUrl": "https://secure.tpay.com/?title=TR-CWM-D14339X&uid=01J1ZJREPKDXXJ5E4JRWYVXMN2"
}

Redirect the payer to the installment application

Redirect the payer to the URL provided in the response in the transactionPaymentUrl field.

At the given URL, the payer will be redirected to the installment application, where they complete the required information and submit the application.

Handle the notification

We will inform you about the transaction status via notification after transaction posting.

Pekao installment calculator

You can place the Installment Calculator from Pekao Bank on your website anywhere you like (e.g., on the product page).

This allows customers to calculate the number and/or amount of installments by themselves.

Copy the code

To display the installment calculator, copy the source code below and place it in the selected location.

Pekao Installment Calculator 1%:

<iframe src="https://secure.tpay.com/installments/calculator?channelId=77" mce_src="https://secure.tpay.com/installments/calculator?channelId=77" width="680" height="680" frameborder="0"> </iframe>

Pekao Installment Calculator 3 x 0%:

<iframe src="https://secure.tpay.com/installments/calculator?channelId=78" mce_src="https://secure.tpay.com/installments/calculator?channelId=78" width="680" height="680" frameborder="0"> </iframe>

Pekao Installment Calculator 0.7%:

<iframe src="https://secure.tpay.com/installments/calculator?channelId=81" mce_src="https://secure.tpay.com/installments/calculator?channelId=81" width="680" height="680" frameborder="0"> </iframe>

Pekao Installment Calculator 10 x 0%:

<iframe src="https://secure.tpay.com/installments/calculator?channelId=80" mce_src="https://secure.tpay.com/installments/calculator?channelId=80" width="680" height="680" frameborder="0"> </iframe>
Note

The Pekao installment calculator can be set to show the proposed price divided into installments on product pages - find out how to do it

Promotion

You can also use banners with the text Check the Installment or Calculate Installment - embed them on the site in such a way that clicking on them will display the calculator. Download banners..

Learn more about promoting Pekao installments.

Alior installment calculator

You can place the Alior Installment Calculator on your website anywhere you like (e.g., on the product page).

This allows customers to calculate the number and/or amount of installments by themselves.

Copy the code

To display the installment calculator, copy the source code below and place it in the selected location.

<iframe src="https://secure.tpay.com/alior-raty/?range&logo" mce_src="https://secure.tpay.com/alior-raty/?range&logo" width="680" height="600" frameborder="0"> </iframe>