API
Produkty finansowe
Zwraca dostępne produkty finansowe dla wskazanych kryteriów zapytania.
Produkty finansowe
Endpoint zwraca dostępne produkty finansowe dla wskazanych kryteriów. Przy wyświetlaniu widgetu wywołanie tego endpointu powinno uwzględniać 5-sekundowy timeout połączenia. Po jego przekroczeniu widget nie powinien być wyświetlany, a użytkownik strony nie powinien być powiadamiany o błędzie. Błąd nie powinien mieć wpływu na dalsze funkcjonowanie strony.
Zapytanie:
curl -X GET https://{HOST_API}/v1/financial-products?loanAmount=120000&loanTerm=6 \
--header "Content-Type: application/json" \
--header "Api-Key: {API-KEY}" \
--connection-timeout 5
Zapytanie z użyciem parametru productTypes=CONVENIENT_INSTALLMENTS,PAY_LATER:
curl -X GET https://{HOST_API}/v1/financial-products?loanAmount=120000&loanTerm=6&productTypes=CONVENIENT_INSTALLMENTS,PAY_LATER \
--header "Content-Type: application/json" \
--header "Api-Key: {API-KEY}" \
--connection-timeout 5
Parametry zapytania
| Parametr | Typ | Wymagane | Opis |
|---|---|---|---|
| loanAmount | int | tak | Kwota pożyczki w groszach. |
| loanTerm | int | nie | Okres kredytowania w miesiącach. Pominięcie lub wartość zerowa zwraca oferty dla wszystkich dostępnych okresów. |
| loanType | string | nie | Typ produktu finansowego ze słownika typów. Dostępność zależy od konfiguracji sklepu; niedostępny typ zwraca pustą listę. Pominięcie lub pusta wartość zwraca oferty dla wszystkich dostępnych typów. |
| loanTypeSelected | string | nie | Typ produktu wstępnie wybranego na liście ofert ze słownika typów. Pominięcie lub pusta wartość wybiera pierwszą pozycję z listy. |
| productTypes | string | nie | Przecinkami separowana lista typów ze słownika typów. Pominięcie zwraca wszystkie dostępne typy; pusta lista zwraca puste wyniki. |
| taxId | string | nie | NIP punktu sprzedaży, dla którego zwracana jest oferta. Pominięcie lub pusta wartość zwraca oferty bez ograniczeń punktu sprzedaży. |
Szczegóły punktów sprzedaży:
- Dodawanie punktu sprzedaży usług
- Pobieranie listy punktów sprzedaży usług
- Pobieranie punktu sprzedaży usług
- Aktualizacja danych punktu sprzedaży usług
Odpowiedź
[
{
"name":"Raty 0%",
"description":"Szybkie i proste zakupy bez dodatkowych kosztów. Spłacasz dokładnie tyle, ile pożyczasz!",
"icon":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>...",
"type":"INSTALLMENTS_ZERO_PERCENT",
"instalmentAmount":1200,
"representativeExample":"Przykład reprezentatywny",
"rrso":0,
"toPay":120000,
"remarks": null,
"loanTerm": 10,
"loanParameters": [
{
"instalmentAmount": 40000,
"loanTerm": 3,
"toPay": 120000,
"rrso": 0
},
{
"instalmentAmount": 20000,
"loanTerm": 6,
"toPay": 120000,
"rrso": 0
},
{
"instalmentAmount": 1200,
"loanTerm": 10,
"toPay": 120000,
"rrso": 0
}
]
},
{
"name":"Niskie raty",
"description":"Zakupy bez obciążania budżetu, dostosowane do Twoich potrzeb. Sam decydujesz o liczbie rat.",
"icon":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>...",
"type":"CONVENIENT_INSTALLMENTS",
"instalmentAmount":6200,
"representativeExample":"Przykład reprezentatywny",
"rrso":0.2384,
"toPay":148797,
"remarks": null,
"loanTerm": 24,
"loanParameters": [
{
"instalmentAmount": 21201,
"loanTerm": 6,
"toPay": 127206,
"rrso": 0.17420000000000002
},
{
"instalmentAmount": 11200,
"loanTerm": 12,
"toPay": 134394,
"rrso": 0.1869
},
{
"instalmentAmount": 7867,
"loanTerm": 18,
"toPay": 141602,
"rrso": 0.1892
},
{
"instalmentAmount": 6200,
"loanTerm": 24,
"toPay": 148797,
"rrso": 0.18899999999999997
},
{
"instalmentAmount": 4534,
"loanTerm": 36,
"toPay": 163206,
"rrso": 0.1863
},
{
"instalmentAmount": 3701,
"loanTerm": 48,
"toPay": 177614,
"rrso": 0.1827
}
]
}
]
Opis pól odpowiedzi
| Pole | Typ | Opis |
|---|---|---|
| name | string | Nazwa produktu. |
| description | string | Opis produktu. |
| icon | string | Ikona w formacie SVG. |
| type | string | Typ produktu — zob. typy produktów finansowych. Opcjonalnie przekazywany przy tworzeniu wniosku. |
| instalmentAmount | int | Kwota raty w groszach. |
| representativeExample | string | Przykład reprezentatywny. |
| rrso | float | RRSO dla tego typu produktu. |
| toPay | int | Łączna kwota spłaty kredytu w groszach. |
| remarks | string, null | Dodatkowe uwagi związane z ofertą. |
| loanTerm | int | Liczba rat. |
| loanParameters | array | Kolekcja wariantów rat wraz z kwotą spłaty i kwotą raty. |
Kody odpowiedzi serwera
- 200 OK
- 400 Not Found
- 401 Unauthorized
- 405 Method Not Allowed
- 500 Internal Server Error
Produkty finansowe kalkulowane na podstawie koszyka
Oferty zależne od zawartości koszyka zakupowego i kosztów transportu (np. leasing) pobiera się metodą POST. W ciele żądania należy przesłać strukturę JSON pola cart opisaną w metodzie order_create.
Zapytanie:
curl -X POST https://{HOST_API}/v1/financial-products?loanAmount=120000&loanTerm=6&productTypes=LEASING \
--header "Content-Type: application/json" \
--header "Api-Key: {API-KEY}" \
--connection-timeout 5
--data-raw '{
"category": "KATEGORIA ZE SŁOWNIKA",
"totalAmount": 443907,
"deliveryCost": 1230,
"deliveryNetCost": 1000,
"deliveryCostVatRate": 23,
"deliveryCostVatAmount": 230,
"products": [
{
"name": "Lenovo Ideapad 120S-14IAP",
"quantity": 1,
"price": 246000,
"netPrice": 200000,
"vatRate": 23,
"vatAmount": 46000,
"photoUrl": "01e5f8",
"ean": "9002490100070",
"externalId": "123",
"category": "productCategory"
},
{
"name": "Lenovo Ideapad 120S-14IAP",
"quantity": 1,
"price": 196677,
"netPrice": 159900,
"vatRate": 23,
"vatAmount": 36777,
"photoUrl": "01e5f8",
"ean": "9002490100070",
"externalId": "123",
"category": "productCategory"
}
]
}'
Przykłady implementacji produktów finansowych
Przykład reprezentacji widoku produktów:
HTML do pobrania: