Skip to main content

Utworzenie linku do p艂atno艣ci

alt text W celu utworzenia linku, nale偶y wys艂a膰 zapytanie na adres:

艢cie偶ka
POST /pay/v1/payments
Przyk艂adowe zapytanie
curl --location --request POST 'https://pay.billtech.pl/pay/v1/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",      "name": "Jan",      "surname": "Kowalski",      "email": "[email protected]"    }  ]}'
atrybutopis
payments:聽arrayLista p艂atno艣ci, dla kt贸rych ma by膰 wygenerowany link
userId:聽stringIdentyfikator klienta w systemie dostawcy (max 100 znak贸w)
amount:聽numberNale偶na kwota
nrb:聽stringNumer konta bankowego do przelewu w formacie BBAN
title:聽stringTytu艂 op艂aty (max 105 znak贸w), dopuszczalne znaki: A-Za-z0-9#&_-,./ oraz znak spacji(0x20) i znaki z zakresu UNICODE 00C0 - 02C0 (m.in. polskie znaki diakrytyczne)
paymentDue:聽stringTermin p艂atno艣ci (format yyyy-mm-dd)
name:聽stringImi臋 p艂atnika (opcjonalne, max 100 znak贸w) Dopuszczalne znaki: A-Za-z0-9-,. oraz znak spacji(0x20) i znaki z zakresu UNICODE 00C0 - 02C0 (m.in. polskie znaki diakrytyczne)
surname:聽stringNazwisko (opcjonalne, max 100 znak贸w) Dopuszczalne znaki: A-Za-z0-9-,. oraz znak spacji(0x20) i znaki z zakresu UNICODE 00C0 - 02C0 (m.in. polskie znaki diakrytyczne)
email:聽stringAdres e-mail p艂atnika (opcjonalny)
Przyk艂adowa odpowied藕
{  "links": [    {       "token": "e64a219df20884e4db40b7f99ac2cef9c08650f22e74ca6d09f49ad24734ae75c388b7052500033b693ae29edb2ed9d8ccfa85e66023c9e023eac4f353e2be05",      "link": "https://pay.billtech.pl/single-payment/e64a219df20884e4db40b7f99ac2cef9c08650f22e74ca6d09f49ad24734ae75c388b7052500033b693ae29edb2ed9d8ccfa85e66023c9e023eac4f353e2be05",      "shortLink": "https://zapl.ac/SscsYRx7qy"    }  ]}
atrybutopis
links:聽arrayLista link贸w w kolejno艣ci odpowiadaj膮cej zapytaniu
token:聽stringToken s艂u偶膮cy identyfikacji danego linku do p艂atno艣ci
link:聽stringPe艂ny link do p艂atno艣ci
shortLink:聽stringSkr贸cony link do p艂atno艣ci

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

Skr贸cony link#

Pole shortLink w odpowiedzi zawiera skr贸cony link do p艂atno艣ci, kt贸ry mo偶e by膰 u偶yty np. w wiadomo艣ci SMS, gdzie wyst臋puje ograniczenie liczby znak贸w.

info

Skr贸cone linki s膮 zwracane tylko gdy w zapytaniu podane s膮 dane osobowe tj. name oraz surname.

W przypadku skr贸conego linku funkcjonuj膮 inne zasady do艂膮czania parametr贸w, np. type. Aby doda膰 parametry do linku jednocze艣nie zachowuj膮c jego niewielk膮 d艂ugo艣膰, nale偶y skorzysta膰 z serwisu https://zapl.ac/encode:

艢cie偶ka
POST https://zapl.ac/encode
Przyk艂adowe zapytanie
curl --location --request POST 'https://zapl.ac/encode?type=connect&connectApp=MU' \--header 'Content-Type: application/json' \--data-raw '{  "url": "https://zapl.ac/SscsYRx7qy"}'
Przyk艂adowa odpowied藕
{  "url": "https://zapl.ac/SscsYRx7qy/24"}

W powy偶szym przyk艂adnie parametry: ?type=connect&connectApp=MU dodane do url zapytania zosta艂y zakodowane do skr贸conego linku w postaci trzech znak贸w: /24.