Tpay
API

E-przelew

E-przelew to rodzaj płatności, który wymaga od płatnika utworzenia przelewu po zalogowaniu się do swojej bankowości elektronicznej.

Dane przelewu (numer konta odbiorcy, tytuł przelewu, kwota, nazwa odbiorcy) należy skopiować z Panelu Transakcyjnego po wybraniu konkretnego banku.

Przelew jest wewnątrzbankowy, numer rachunku, na który będzie wykonany przelew, należy do tego samego banku, który wybrał płatnik.

Księgowanie płatności następuje zgodnie z harmonogramem przelewów wewnętrznych banku.

Transakcja E-przelew

Realizuj płatności E-przelew, wykorzystując endpoint do tworzenia transakcji.

Wyślij zapytanie o utworzenie transakcji E-przelew

Aby utworzyć transakcję E-przelew, wyślij żądanie POST na endpoint podając odpowiedni parametr channelId przypisany do danego banku.

Uwaga

Kanały płatnicze, które obsługują E-przelew mają atrybuty:

onlinePayment
true.
instantRedirection
false.

Sprawdź więcej informacji o kanałach płatności.

Lista dostępnych banków wraz z identyfikatorem channelId

Nazwa bankuChannelId - identyfikator
Bank Nowy S.A.24
Nest Bank26
Bank Polskiej Spółdzielczości28
Pekao Firma24 / Biznes2447
Bank Millennium S.A. Firmy48

https://api.tpay.com/transactions

W zapytaniu określ następujące parametry:

amount
Kwota transakcji (w złotówkach).
description
Opis transakcji widoczny dla płatnika.
payer.email
Adres e-mail płatnika.
payer.name
Imię i nazwisko płatnika.
pay.channelId
Identyfikator kanału płatności dla wybranego banku.

Podstawowe body żądania powinno wyglądać następująco:

{
  "amount": 0.1,
  "description": "Testowa transakcja E-przelew",
  "payer": {
    "email": "[email protected]",
    "name": "Jan Nowak"
  },
  "pay": {
    "channelId": 48
  }
}

Przykład:

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 E-przelew",
   "payer": {
      "email": "[email protected]",
      "name": "Jan Nowak"
   },
   "pay" : {
    "channelId": 48
   }
}'

Po wysłaniu żądania otrzymasz w odpowiedzi schemat TransactionCreated.

Najważniejsze parametry odpowiedzi:

result
success - Transakcja została utworzona pomyślnie.
status
pending - Transakcja oczekuje opłacenia.
transactionId
Unikalny identyfikator transakcji.
transactionPaymentUrl
Adres URL, na który należy przekierować płatnika.

Przykład:

{
  "result": "success",
  "requestId": "cf47fa58ad6679fb6a86",
  "transactionId": "ta_jrkNGj5xnppBlbqw",
  "title": "TR-CWM-D02D7HX",
  "posId": "ps_e4dkPVDEm4Jg726q",
  "status": "pending",
  "date": {
    "creation": "2024-07-01 21:38:13",
    "realization": null
  },
  "amount": 0.1,
  "currency": "PLN",
  "description": "Testowa transakcja",
  "hiddenDescription": "",
  "payer": {
    "payerId": "py_a9rjlZWxRLdG1bqY",
    "email": "[email protected]",
    "name": "Jan Nowak",
    "phone": "",
    "address": "",
    "city": "",
    "country": "PL",
    "postalCode": ""
  },
  "payments": {
    "status": "pending",
    "method": null,
    "amountPaid": 0,
    "date": {
      "realization": null
    }
  },
  "transactionPaymentUrl": "https://secure.tpay.com/?gtitle=TR-CWM-D02D7HX&uid=01J1QWW3AN9RYYSA978ECND8Z3"
}
Uwaga

Parametr transactionId przechowaj w swoim systemie. Więcej o transactionId.

Przekieruj płatnika na Panel Transakcyjny

Przekieruj płatnika na URL zawarty w odpowiedzi w polu transactionPaymentUrl.

Płatnik zostanie przekierowany do Panelu Transakcyjnego, gdzie wyświetli mu się formularz z danymi do przelewu.

Następnie płatnik loguje się w swoim systemie bankowym i realizuje przelew z podanymi danymi na Panelu Transakcyjnym.

Księgowanie płatności następuje zgodnie z harmonogramem przelewów wewnętrznych banku.

Obsłuż powiadomienie

Poinformujemy Cię o statusie transakcji za pośrednictwem notyfikacji po zaksięgowaniu transakcji.