Path parameters

• merchantId string Required

  Identyfikator klienta

• paymentId string(uuid) Required

  Identyfikator linku płatności jako UUID v4

  Maximum length is 36. Format should match the following pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$.

Responses

• 200 application/json

  Zapytanie wykonane poprawnie

  Hide response attributes Show response attributes object

  • id string(uuid) Required

    Identyfikator linku płatności jako UUID v4

    Maximum length is 36. Format should match the following pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$.

  • url string Required

    Adres przekierowania do płatności

  • serviceId string(uuid) Required

    Identyfikator sklepu jako UUID v4

    Maximum length is 36. Format should match the following pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$.

  • orderId string Required

    Numer zamówienia

    Maximum length is 100. Format should match the following pattern: ^[A-Za-z0-9#_\-\.\\\\/ \u00C0-\u02C0]+$.

  • title string Required

    Tytuł transakcji

    Maximum length is 255. Format should match the following pattern: ^[A-Za-z0-9#&_\-\,\.\\\\/ \u00C0-\u02C0"']+$.

  • simp string Required

    Numer rachunku SIMP przy włączonej usłudze płatności masowych

  • amount string Required

    Kwota transakcji w najmniejszej jednostce waluty np. grosze.

  • currency string Required

    Status

    Values are new, pending, settled, authorized, rejected, cancelled, or error.

  • status string

    Status

    Values are new, pending, settled, authorized, rejected, cancelled, or error.

  • isActive boolean Required

    Informacja czy link płatności jest aktywny

  • validTo integer | null Required

    Data ważności transakcji jako timestamp w sekundach. Brak realizacji płatności do tego czasu spowoduje jej anulowanie. Jeżeli nie jest przekazane to transakcja ważna jest do czasu ustawionego w parametrze Aktywność płatności w Panelu Administracyjnym imoje (ustawienia sklepu) lub po upływie 15 miesięcy. Przekazanie parametru validTo= NULL powoduje brak wygaśnięcia transakcji z pominięciem ustawień w parametrze Aktywność płatności na Panelu Administracyjnym imoje (ustawienia sklepu). Minimalny czas ważności linku to 60 sekund.

  • created integer | null Required

    Data utworzenia jako timestamp

  • modified integer | null Required

    Data modyfikacji jako timestamp

  • isGenerated boolean Required

    Informacja czy link płatności został wygenerowany z poziomu panelu imoje.

  • isUsed boolean Required

    Informacja czy link płatności został użyty.

  • usedAt integer Required

    Data użycia linku płatności jako timestamp

  • isConfirmVisited boolean Required

    Informacja czy płatnik odwiedził stronę potwierdzenia płatności w bramce imoje.

  • confirmVisitedAt integer | null Required

    Data przejścia na stronę potwierdzenia płatności w bramce imoje jako timestamp.

  • returnUrl string(uri) Required

    Adres powrotu z zewnętrznej strony obsługującej płatność w przypadku nie rozstrzygnięcia statusu transakcji. Adres musi być zgodny ze standardem URL RFC 3986.

    Maximum length is 300.

  • failureReturnUrl string(uri) Required

    Adres powrotu z zewnętrznej strony obsługującej płatność w przypadku wystąpienia błędu płatności. Adres musi być zgodny ze standardem URL RFC 3986.

    Maximum length is 300.

  • successReturnUrl string(uri) Required

    Adres powrotu z zewnętrznej strony obsługującej płatność w przypadku dokonania płatności z powodzeniem. Adres musi być zgodny ze standardem URL RFC 3986.

    Maximum length is 300.

  • notificationUrl string(uri) Required

    Dynamiczny adres notyfikacji, możliwość ustawienia konkretnego adresu dla pojedynczej transakcji. Adresy zawierające localhost oraz porty zostaną odrzucone.

    Maximum length is 300.

  • customer object Required

    Dane płatnika

    Hide customer attributes Show customer attributes object

    • firstName string Required

      Imię płatnika

      Maximum length is 100. Format should match the following pattern: ^[A-Za-z0-9#&_\-\,\.\\\\/ \u00C0-\u02C0\u0400-\u04FF"']+$.

    • lastName string Required

      Nazwisko płatnika

      Maximum length is 100. Format should match the following pattern: ^[A-Za-z0-9#&_\-\,\.\\\\/ \u00C0-\u02C0\u0400-\u04FF"']+$.

    • email string(email) Required

      Adres e-mail płatnika w formacie zgodnym ze standardem RFC 5322 oraz RFC 6531

      Maximum length is 200.

    • phone string

      Numer telefonu płatnika

      Maximum length is 20. Format should match the following pattern: ^[0-9\+\- ]+$.

    • cid string

      Identyfikator płatnika. (Wymagane podczas płatności oneclick, recurring).

      Maximum length is 36. Format should match the following pattern: ^[A-Za-z0-9\x2D]+$.

    • company string

      Nazwa firmy płatnika

      Maximum length is 200. Format should match the following pattern: ^[A-Za-z0-9#&_\-\,\.\/ \u00C0-\u02C0"']+$.

    • locale string

      Maximum length is 2. Values are pl, en, cs, de, es, fr, it, lt, ru, sk, sl, uk, nl, hu, ro, bg, or sv.

  • transactions array[object] Required

    Lista transkacji przypisanych do linku płatności.

    Hide transactions attributes Show transactions attributes object

    • id string(uuid) Required

      Identyfikator transakcji jako UUID v4

      Maximum length is 36. Format should match the following pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$.

    • type string Required

      Typ transakcji

      Values are sale or refund.

    • status string Required

      Status

      Values are new, pending, settled, authorized, rejected, cancelled, or error.

    • source string Required

      Żródło transakcji

      Values are web or api.

    • created integer | null Required

      Data utworzenia jako timestamp

    • modified integer | null Required

      Data modyfikacji jako timestamp

    • notificationUrl string(uri) Required

      Dynamiczny adres notyfikacji, możliwość ustawienia konkretnego adresu dla pojedynczej transakcji. Adresy zawierające localhost oraz porty zostaną odrzucone.

      Maximum length is 300.

    • serviceId string(uuid) Required

      Identyfikator sklepu jako UUID v4

      Maximum length is 36. Format should match the following pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$.

    • amount integer Required

      Kwota transakcji w najmniejszej jednostce waluty np. grosze.

    • currency string Required

      Waluta transakcji w standardzie ISO 4217

      Maximum length is 3. Values are PLN, EUR, USD, GBP, CHF, SEK, HUF, CZK, BGN, or RON.

    • title string Required

      Tytuł transakcji

      Maximum length is 255. Format should match the following pattern: ^[A-Za-z0-9#&_\-\,\.\\\\/ \u00C0-\u02C0"']+$.

    • orderId string Required

      Numer zamówienia

      Maximum length is 100. Format should match the following pattern: ^[A-Za-z0-9#_\-\.\\\\/ \u00C0-\u02C0]+$.

    • paymentMethod string Required

      Oznaczenie metody płatności

      Values are blik, pbl, ing, card, wallet, imoje_paylater, wt, or imoje_installments.

    • paymentMethodCode string Required

      Kanał płatności ustawiony jako domyślny i automatycznie wybrany po otwarciu bramki płatności. Jeśli tego pola nie ma to bramka otwiera się bez wybranego zaznaczonego kanału płatności. Pole nie może być zdefiniowane i pozostawione bez wartości.

      Maximum length is 20. Values are blik, imoje_twisto, paypo, blik_paylater, pragma_go, gpay, applepay, visa_mobile, paypal, ecom3ds, oneclick, recurring, ing, mtransfer, bzwbk, pekao24, inteligo, ipko, getin, noble, creditagricole, alior, millennium, citi, bos, bnpparibas, pocztowy, plusbank, bs, bspb, nest, pbs, cs, mp, kb, rf, pg, pf, cb, uc, posta, sporo, tatra, viamo, vub, wt, wt_split, inbank, or inbank_0.

    • payment object Required
      Hide payment attributes Show payment attributes object

      • id string(uuid) Required

        Identyfikator linku płatności jako UUID v4

        Maximum length is 36. Format should match the following pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$.

      • status string Required

        Status

        Values are new, pending, settled, authorized, rejected, cancelled, or error.