Dokumentacja

Dokumentacja przedstawia krok po kroku jak w prosty i szybki sposób skomunikować
Twój sklep z Comfino.

Pobieranie produktów finansowych

Zwraca dostępne produkty finansowe dla wskazanych kryteriów. Wywołanie poniższej końcówki API w przypadku wyświetlania widgetu, powinno uwzględniać 5-sekundowy czas nawiązania połączenia (timeout). Po przekroczenia tego czasu, 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 \
-H "Content-Type: application/json" \
-H "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 \
-H "Content-Type: application/json" \
-H "Api-Key: {API-KEY}" \
--connection-timeout 5

Parametry zapytania:

  • loanAmount: Kwota pożyczki (wymagany, wartość w groszach jako INT)
  • loanTerm: Okres kredytowania (opcjonalny, wartość w miesiącach jako INT)
  • loanType: Typ produktu finansowego (opcjonalny, wartość STRING ze słownika typów - zobacz sekcję typy produktów finansowych w dokumentacji wartości słownikowych). Dostępność typów produktów zależy od konfiguracji sklepu w systemie Comfino. Użycie niedostępnego typu spowoduje zwrócenie pustej listy produktów.
  • productTypes: Typy produktów finansowych (opcjonalny, wartość STRING, separowana przecinkami lista typów ze słownika - zobacz sekcję typy produktów finansowych w dokumentacji wartości słownikowych). Dostępność typów produktów zależy od konfiguracji sklepu w systemie Comfino. Użycie niedostępnego typu spowoduje zwrócenie pustej listy produktów.
  • taxId: Numer NIP punktu sprzedaży dla którego ma zostać zwrócona oferta (opcjonalny, wartość STRING)

Pomijanie parametrów opcjonalnych:

  • Pominięcie parametru loanTerm lub przekazanie wartości zerowej powoduje zwracanie propozycji dla wszystkich dostępnych okresów.
  • Pominięcie parametru loanType lub przekazanie wartości pustej powoduje zwracanie propozycji dla wszystkich dostępnych typów.
  • Pominięcie parametru productTypes powoduje zwracanie propozycji dla wszystkich dostępnych typów.
  • Przekazanie parametru productTypes jako pustej listy powoduje zwracanie pustej listy ofert.
  • Pominięcie parametru taxId lub przekazanie wartości pustej powoduje zwracanie propozycji bez uwzględnienia ograniczeń nałożonych na punkt sprzedaży.

Więcej szczegółów o punktach sprzedaży znajdziesz tu:

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\"?>\n<svg width=\"20px\" height=\"20px\" viewBox=\"0 0 20 20\" version=\"1.1\" xmlns=\"http://www.w3.org/2000/svg\" xmlns:xlink=\"http://www.w3.org/1999/xlink\">\n    <title>D56B2892-72FB-45C4-90BD-B67258896C88</title>\n    <g id=\"ecommerce\" stroke=\"none\" stroke-width=\"1\" fill=\"none\" fill-rule=\"evenodd\">\n        <g id=\"07\" transform=\"translate(-566.000000, -386.000000)\" fill=\"#006FB2\" fill-rule=\"nonzero\">\n            <g id=\"1\" transform=\"translate(464.000000, 336.000000)\">\n                <g id=\"icon\" transform=\"translate(84.000000, 32.000000)\">\n                    <path d=\"M21.5,18 C19.578125,18 18,19.578125 18,21.5 L18,24.5 C18,26.421875 19.578125,28 21.5,28 C23.421875,28 25,26.421875 25,24.5 L25,21.5 C25,19.578125 23.421875,18 21.5,18 Z M32.75,18 L20.75,38 L23.25,38 L35.25,18 L32.75,18 Z M21.5,20 C22.339844,20 23,20.660156 23,21.5 L23,24.5 C23,25.339844 22.339844,26 21.5,26 C20.660156,26 20,25.339844 20,24.5 L20,21.5 C20,20.660156 20.660156,20 21.5,20 Z M34.5,28 C32.578125,28 31,29.578125 31,31.5 L31,34.5 C31,36.421875 32.578125,38 34.5,38 C36.421875,38 38,36.421875 38,34.5 L38,31.5 C38,29.578125 36.421875,28 34.5,28 Z M34.5,30 C35.339844,30 36,30.660156 36,31.5 L36,34.5 C36,35.339844 35.339844,36 34.5,36 C33.660156,36 33,35.339844 33,34.5 L33,31.5 C33,30.660156 33.660156,30 34.5,30 Z\" id=\"Shape\"></path>\n                </g>\n            </g>\n        </g>\n    </g>\n</svg>",
      "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\"?>\n<svg width=\"28px\" height=\"20px\" viewBox=\"0 0 28 20\" version=\"1.1\" xmlns=\"http://www.w3.org/2000/svg\" xmlns:xlink=\"http://www.w3.org/1999/xlink\">\n    <title>FDEF13DD-2310-4CFF-A5E2-CCACA70AC16A</title>\n    <g id=\"ecommerce\" stroke=\"none\" stroke-width=\"1\" fill=\"none\" fill-rule=\"evenodd\">\n        <g id=\"07\" transform=\"translate(-1074.000000, -386.000000)\" fill=\"#006FB2\" fill-rule=\"nonzero\">\n            <g id=\"3\" transform=\"translate(976.000000, 336.000000)\">\n                <g id=\"icon\" transform=\"translate(84.000000, 32.000000)\">\n                    <path d=\"M17,18 L17,31.5625 L14.71875,33.875 C14.265625,34.328125 14,34.953125 14,35.59375 C14,36.914063 15.085938,38 16.40625,38 L39.59375,38 C40.914063,38 42,36.914063 42,35.59375 C42,34.953125 41.734375,34.328125 41.28125,33.875 L39,31.5625 L39,18 L17,18 Z M19,20 L37,20 L37,31 L19,31 L19,20 Z M18.4375,33 L37.5625,33 L39.875,35.28125 C39.953125,35.359375 40,35.484375 40,35.59375 C40,35.835938 39.835938,36 39.59375,36 L16.40625,36 C16.164063,36 16,35.835938 16,35.59375 C16,35.484375 16.046875,35.359375 16.125,35.28125 L18.4375,33 Z\" id=\"Shape\"></path>\n                </g>\n            </g>\n        </g>\n    </g>\n</svg>",
      "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

  • name: Nazwa produktu
  • description: Opis produktu
  • icon: Ikona w formacie SVG
  • type: Typ produktu (opcjonalnie przekazywany przy tworzeniu wniosku) - zobacz sekcję typy produktów finansowych w dokumentacji wartości słownikowych)
  • instalmentAmount: Kwota raty (w groszach jako INT)
  • representativeExample: Przykład reprezentatywny
  • rrso: RRSO dla tego typu produktu
  • toPay: Łączna kwota spłaty kredytu (w groszach jako INT)
  • remarks: Dodatkowe uwagi związane z ofertą
  • loanTerm: Liczba rat
  • loanParameters: Kolekcja wariantów rat wraz z kwotą spłaty i kwotą raty

Kody odpowiedzi serwera:

  • 200 OK
  • 401 Unauthorized
  • 400 Not Found
  • 405 Method Not Allowed
  • 500 Internal Server Error

Przykłady implementacji produktów finansowych

Przykład reprezentacji widoku produktów:

HTML do pobrania:

comfino-products.zip