Zgłoszenie leada

Przekazuje do ComfinoPay.pl zgłoszenie firmy (np. placówki medycznej) zainteresowanej współpracą. Zgłoszenie trafia do działu sprzedaży — przedstawiciel ComfinoPay.pl skontaktuje się z firmą telefonicznie lub mailowo. Endpoint nie zakłada konta sprzedawcy; do tego służy rejestracja sklepu.

Endpoint jest publiczny — nie wymaga nagłówka API-KEY.

Zapytanie

curl -X POST 'https://{HOST_API}/v1/lead' \
--header 'Content-Type: application/json' \
--data-raw '{
    "taxId": "7570654759",
    "phone": "+48604138107",
    "email": "kontakt@placowka.pl",
    "platformId": 42
}'

Definicja pól

* Wymagane jest co najmniej jedno z pól phone lub email.

Odpowiedź

Odpowiedź przy sukcesie — status 201 Created:

[]

Odpowiedź przy błędzie walidacji — status 400 Bad Request:

{
  "errors": {
    "taxId": "Nieprawidłowy numer NIP.",
    "phone": "Nieprawidłowy numer telefonu.",
    "email": "Należy podać adres e-mail lub numer telefonu.",
    "platformId": "The platformId 999 does not exists."
  }
}

errors to obiekt, którego klucze odpowiadają polom żądania, a wartości opisują przyczynę błędu. Treść komunikatów ma charakter informacyjny i może się zmienić — nie należy na niej opierać logiki integracji.

Niepoprawny JSON w treści żądania zwraca 400 Bad Request:

{
  "errors": {
    "json": "Invalid."
  }
}

Pozostałe odpowiedzi:

Terminale płatnicze

Endpoint POST /lead (bez prefiksu wersji) jest aliasem POST /v1/lead używanym przez terminale płatnicze. Terminal wysyła nagłówek API-KEY — wtedy urządzenie i platforma są ustalane na podstawie klucza, a pole platformId nie jest wymagane. Nieznany klucz API zwraca 403 Forbidden.

Zobacz również:

• Rejestracja sklepu