Path parameters

• merchantId string Required

  Merchant identifier

• serviceId string(uuid) Required

  Shop identifier as 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

  Request executed correctly

  Hide response attributes Show response attributes object

  • service object
    Hide service attributes Show service attributes object

    • id string(uuid)

      Shop identifier as 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}$.

    • created integer | null

      Creation date as timestamp

    • isActive boolean

      Information about whether the shop is active in the imoje panel.

    • paymentMethods array[object]

      List of available payment methods and channels.

      Hide paymentMethods attributes Show paymentMethods attributes object

      • paymentMethod string

        Payment method description

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

      • paymentMethodCode string

        Payment method code

        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.

      • isActive boolean

        Information about whether a payment channel is active in the shop. Together with the isOnline parameter, it defines whether a given payment channel should be available in the shop at a given moment.

      • isOnline boolean

        Information about whether a payment channel is available in the imoje panel. The channel may be unavailable even if it is active in the shop. The availability of payment channels is usually restricted globally in the event of a failure or scheduled technical work. Together with the isActive parameter, it defines whether a given payment channel should be made available in the shop at a given moment.

      • description string

        Payment channel name

      • currency string

        Transaction currency in the ISO 4217 standard

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

      • transactionLimits object

        Maximum and minimum transaction amount

        Hide transactionLimits attributes Show transactionLimits attributes object

        • maxTransaction object

          Maximum transaction amount

          Hide maxTransaction attributes Show maxTransaction attributes object

          • type string
          • value number
          • * string | integer | number | boolean | object | array Additional properties

            Additional parameters that are not described and may appear in the response as part of API development.

            Your API response validation scheme should always allow new parameters.

        • minTransaction object

          Minimum transaction amount

          Hide minTransaction attributes Show minTransaction attributes object

          • type string
          • value number
          • * string | integer | number | boolean | object | array Additional properties

            Additional parameters that are not described and may appear in the response as part of API development.

            Your API response validation scheme should always allow new parameters.

        • * string | integer | number | boolean | object | array Additional properties

          Additional parameters that are not described and may appear in the response as part of API development.

          Your API response validation scheme should always allow new parameters.

      • paymentMethodImage array[object]

        Link to payment method logo

        Hide paymentMethodImage attributes Show paymentMethodImage attributes object

        • png string
        • * string | integer | number | boolean | object | array Additional properties

          Additional parameters that are not described and may appear in the response as part of API development.

          Your API response validation scheme should always allow new parameters.

      • paymentMethodCodeImage array[object]

        Link to the payment channel logo

        Hide paymentMethodCodeImage attributes Show paymentMethodCodeImage attributes object

        • png string
        • * string | integer | number | boolean | object | array Additional properties

          Additional parameters that are not described and may appear in the response as part of API development.

          Your API response validation scheme should always allow new parameters.

      • * string | integer | number | boolean | object | array Additional properties

        Additional parameters that are not described and may appear in the response as part of API development.

        Your API response validation scheme should always allow new parameters.

    • * string | integer | number | boolean | object | array Additional properties

      Additional parameters that are not described and may appear in the response as part of API development.

      Your API response validation scheme should always allow new parameters.

  • * string | integer | number | boolean | object | array Additional properties

    Additional parameters that are not described and may appear in the response as part of API development.

    Your API response validation scheme should always allow new parameters.