Collect

Collect to usługa, w której środki z transakcji są przekazywane bezpośrednio na rachunki wskazane w parametrach transakcji. Po pomyślnym zakończeniu transakcji środki trafiają na podany numer rachunku. Każdy przekazany rachunek jest weryfikowany i musi znajdować się na liście dozwolonych rachunków przypisanych do danego merchanta.

Uwaga

Aby rozpocząć przyjmowanie płatności w usłudze Collect, musisz podpisać odpowiednią umowę i przekazać listę obsługiwanych rachunków. Skontaktuj się z Biurem Obsługi Klienta w celu ustalenia szczegółów i możliwości uruchomienia usługi.

Dostępne metody płatności

W ramach Collect dostępne są poniższe metody płatności:

Transakcja

Zakładanie transakcji w usłudze Collect jest analogiczne do zakładania zwykłej transakcji, wymaga podania dwóch obowiązkowych parametrów:

collect.account *	Numer rachunku w formacie IBAN (Przyjmuje 28 znaków). Obsługiwane są jedynie polskie rachunki. Aby poprawnie założyć transakcję przekazany w parametrze rachunek, musi znajdować się na liście rachunków merchanta.
collect.receiver *	Nazwa odbiorcy. Parametr przyjmuje duże i małe litery (a-z, A-Z) oraz polskie znaki, Cyfry (0-9), znaki specjalne: `/ - , . [spacja]`. W przypadku przesłania nieakceptowanych znaków lub nieprawidłowej długości, transakcja nie zostanie założona.

* Pola obowiązkowe.

Przykład:

{
  "collect": {
    "account": "PL63105015201000009091194713",
    "receiver": "Odbiorca testowy"
  }
}

Podstawowe body żądania zakładania transakcji powinno wyglądać następująco:

{
  "amount": 10.21,
  "description": "Test Collect Transaction",
  "lang": "pl",
  "payer": {
    "email": "[email protected]",
    "name": "Test Tpay",
    "phone": "123456789",
    "address": "Plac Andersa 3",
    "code": "11-123",
    "city": "Poznań",
    "country": "PL"
  },
  "collect": {
    "account": "PL63105015201000009091194713",
    "receiver": "Test Receiver"
  }
}

Dodanie rachunku bankowego do listy zaufanych

Uwaga

Endpoint /collect/bank-accounts jest dostępny jedynie dla wybranych sprzedawców. Skontaktuj się z Biurem Obsługi Klienta w celu uzyskania więcej szczegółów.

Utworzenie transakcji collect jest możliwe tylko dla zaufanych rachunków bankowych. Aby dodać rachunek bankowy w systemie należy przesłać następujące parametry:

accountNumber *	Numer rachunku w formacie IBAN (Przyjmuje 28 znaków). Obsługiwane są jedynie polskie rachunki.
ownerName *	Nazwa właściciela rachunku. Maksymalnie 1000 znaków.
additionalInformation *	Dodatkowe dane właściciela rachunku np. adres, NIP. Maksymalnie 1000 znaków.

* Pola obowiązkowe.

Sprawdź szczegóły w dokumentacji API Reference: POST /collect/bank-accounts

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

{
  "accountNumber": "PL49612314784098788023189726",
  "ownerName": "Jan Kowalski",
  "additionalInformation": "ul. Słoneczna 4/5c, 60-001 Poznań"
}

Przykład:

curl --location --request POST 'http://api.tpay.com/collect/bank-accounts' \
--header 'Authorization: Bearer <access_token>' \
--header 'Content-Type: application/json'
--data '{
    "accountNumber" : "PL49612314784098788023189726",
    "ownerName" : "Jan Kowalski",
    "additionalInformation" : "ul. Słoneczna 4/5c, 60-001 Poznań"
}'

Pobranie listy zaufanych rachunków bankowych

Aby pobrać listę zauwanych rachunków bankowych, wyślij żądanie GET na endpoint:

https://api.tpay.com/collect/bank-accounts

W zapytaniu możesz określić następujące parametry (queryParam):

page	Numer strony.
limit	Liczba wyników na stronę.

Sprawdź szczegóły w dokumentacji API Reference: GET /collect/bank-accounts

Przykład:

curl --location 'https://api.tpay.com/collect/bank-accounts?page=1&limit=35' \
--header 'Authorization: Bearer <access_token> '\