Utworzenie linku do płatności

alt text W celu utworzenia linku, należy wysłać zapytanie na adres:

Ścieżka
POST /api/payments
Przykładowe zapytanie
curl --location --request POST 'https://pay.billtech.pl/api/payments' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic YXBpVG9rZW46YXBpU2VjcmV0Cg==' \
--data-raw '{
"payments": [
{
"userId": "user-1234",
"amount": 123.45,
"nrb": "28616102383202382844889825",
"title": "FV 123/2020",
"paymentDue": "2020-07-23"
}
]
}'
atrybutopis
payments: objectLista płatności, dla których ma być wygenerowany link
userId: numberIdentyfikator klienta w systemie dostawcy
amount: numberNależna kwota
nrb: stringNumer konta bankowego do przelewu w formacie BBAN
title: stringTytuł Opłaty - docelowo tytuł przelewu
paymentDue: stringTermin płatności
Przykładowa odpowiedź
{
"links": [
{
"token": "e64a219df20884e4db40b7f99ac2cef9c08650f22e74ca6d09f49ad24734ae75c388b7052500033b693ae29edb2ed9d8ccfa85e66023c9e023eac4f353e2be05",
"link": "https://pay.billtech.pl/single-payment/e64a219df20884e4db40b7f99ac2cef9c08650f22e74ca6d09f49ad24734ae75c388b7052500033b693ae29edb2ed9d8ccfa85e66023c9e023eac4f353e2be05"
}
]
}

Możliwe jest wygenerowanie wielu linków (maksymalnie 100) w pojedynczym zapytaniu. Kolejność wygenerowanych linków odpowiada kolejności płatności w zapytaniu.

Przed dystrybucją linków do użytkowników należy dodać do nich dane osobowe klientów w postaci parametrów, np.:

https://pay.billtech.pl/single-payment/e64a219df20884e4...
?name=Jan&surname=Kowalski&[email protected]

Sugerujemy, by system Dostawcy zapisał utworzony link w relacji z konkretną fakturą. W ten sposób link tworzony jest raz dla danej faktury, a następnie można dołączyć go do wiadomości e-mail czy sms, a także wyświetlić w panelu online użytkownika. System powinien zapisać również token, który jest potrzebny do anulowania linku do płatności.

Kiedy tworzyć linki do płatności?

Utworzenie linku do płatności powoduje pojawienie się opłaty przypisanej do danego użytkownika w ekosystemie. Użytkownik widzi tę opłatę w swojej ulubionej aplikacji, nawet jeśli nie wejdzie w wygenerowany link. Z tego powodu najlepszym momentem utworzenia linku jest moment powstania należności (np. wystawienie faktury).

Płatność za saldo

Jeśli w danym momencie użytkownik ma kilka aktywnych linków (nieopłaconych faktur), to po wejściu na dowolny z tych linków będzie on widział informację o łącznym saldzie. Będzie mógł wtedy zdecydować czy chce zapłacić za pojedynczą fakturę czy spłacić całe saldo.

Istnieje możliwość skierowanie użytkownika bezpośrednio na spłatę salda poprzez dodanie parametru type=balance do dowolnego aktywnego linku, np.:

https://pay.billtech.pl/single-payment/e64a219df20884e4...
?name=Jan&surname=Kowalski&[email protected]
&type=balance

Przykładowym przypadkiem użycia takiego linku jest ekran blokady usług lub wiadomość e-mail przypominająca o zadłużeniu.

Połączenie konta w ekosystemie

alt text Połączenie konta w ekosystemie oznacza połączenie konta użytkownika w Systemie Dostawcy z ulubioną aplikacją użytkownika w ekosystemie BillTech. Pierwszym sposobem, w jaki użytkownik może połączyć konto, jest wejście w link do płatności, a następnie wybranie opcji rejestracji. Po zarejestrowaniu w aplikacji, konto użytkownika w Systemie Dostawcy będzie automatycznie połączone. Od tej pory kolejne opłaty dodane do ekosystemu poprzez utworzenie linku do płatności będą automatycznie pojawiać się na koncie użytkownika w aplikacji.

Połączenie konta z pominięciem podsumowania płatności

Istnieje możliwość skierowania użytkownika bezpośrednio na rejestrację w aplikacji, bez pokazywania ekranu płatności. W tym celu, do dowolnego aktywnego linku należy dodać parametrów type=connect oraz connectApp=<id aplikacji> np.:

https://pay.billtech.pl/single-payment/e64a219df20884e4...
?name=Jan&surname=Kowalski&[email protected]
&type=connect&connectApp=MU