Dokumentacja

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

Spis treści

Integracja Sklepu

  1. Wprowadzenie
  2. Uwierzytelnienie użytkownika API
  3. Pobieranie produktów finansowych
  4. Pobieranie parametrów najlepszej oferty
  5. Składanie wniosku kredytowego
  6. Pobieranie wniosku
  7. Notyfikowanie statusu do sklepu
  8. Uprawomocnienie wniosku
  9. Anulowanie wniosku
  10. Odstąpienie od umowy
  11. Zlecenie wypłaty środków
  12. Dodawanie punktu sprzedaży usług
  13. Aktualizacja danych punktu sprzedaży usług
  14. Pobieranie punktu sprzedaży usług
  15. Pobieranie listy wszystkich punktów sprzedaży usług
  16. Statusy i kody błędów
  17. Rejestracja nowego sklepu
  18. Rejestracja nowego sklepu - pobieranie zgód
  19. Rejestracja nowego sklepu - sprawdzanie statusu aktywacji
  20. Widgety

Dodawanie punktu sprzedaży usług

Dodaje nowy punkt sprzedaży usług. Każdy wpis o danym numerze NIP jest unikalny. Nie można dodać do bazy kilku wpisów o takim samym numerze NIP.

Zapytanie: | Zapytanie jest sprawdzane pod kątem poprawności przesyłanych wartości

curl -X POST 'http://{HOST_API}/v1/sale-points' \
--header 'API-KEY: {API-KEY}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "name": "{nazwa dostawcy usługi}",
  "taxId": "{NIP usługodawcy}",
  "city": "{miejscowość usługodawcy}",
  "accountNumber": "{numer konta usługodawcy}",
  "contactPerson": "{dane osoby do kontaktu}",
  "productTypes": [{lista typów produktów dostępnych dla punktu sprzedaży}]
}'

Definicja pól:

Nazwa pola Typ Wymagane Format
name string tak Znaki alfanumeryczne (max. 100)
taxId string tak Znaki alfanumeryczne (max. 10)
city string tak Znaki alfanumeryczne (max. 50)
accountNumber string tak Znaki alfanumeryczne (max. 50)
contactPerson string nie Znaki alfanumeryczne (max. 50)
productTypes string[] nie Tablica wartosci typu string zawierajaca typy produktow

Typy produktów:

  • INSTALLMENTS_ZERO_PERCENT - Raty 0%
  • CONVENIENT_INSTALLMENTS - Niskie raty
  • PAY_LATER - Kup teraz zapłać później
  • COMPANY_INSTALLMENTS - Kredyt dla firm

Odpowiedź:

{
    "name": "{nazwa dostawcy usługi}",
    "taxId": "{NIP usługodawcy}",
    "active": true,
    "city": "{miejscowość usługodawcy}",
    "accountNumber": "{numer konta usługodawcy}",
    "contactPerson": "{dane osoby do kontaktu}",
    "productTypes": [{lista typów produktów dostępnych dla punktu sprzedaży}],
    "_links": {
        "self": {
            "href": "https://{HOST_API}/v1/sale-points/{NIP usługodawcy}",
            "method": "GET"
        }
    }
}

Kody odpowiedzi:

  • 201 Created
  • 400 Bad Request
  • 401 Unauthorized
  • 403 Http Forbidden
  • 404 Http Not Found
  • 405 Method Not Allowed
  • 500 Internal Server Error