GET /{merchantId}/service/{serviceId}
Authorization token

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 attribute Show response attribute 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
          • minTransaction object

            Minimum transaction amount

            Hide minTransaction attributes Show minTransaction attributes object
            • type string
            • value number
        • paymentMethodImage array[object]

          Link to payment method logo

          Hide paymentMethodImage attribute Show paymentMethodImage attribute object
          • png string
        • paymentMethodCodeImage array[object]

          Link to the payment channel logo

          Hide paymentMethodCodeImage attribute Show paymentMethodCodeImage attribute object
          • png string
GET /{merchantId}/service/{serviceId} 
curl \
 --request GET 'https://api.imoje.pl/v1/merchant/{merchantId}/service/{serviceId}' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "service": {
    "id": "865569f1-3e52-4d3e-b6e6-c4f0ce1bd859",
    "created": 1735686000,
    "isActive": true,
    "paymentMethods": [
      {
        "currency": "PLN",
        "isActive": true,
        "isOnline": true,
        "description": "BLIK",
        "paymentMethod": "blik",
        "paymentMethodCode": "blik",
        "transactionLimits": {
          "maxTransaction": {
            "type": "number",
            "value": 5000000
          },
          "minTransaction": {
            "type": "number",
            "value": 1
          }
        },
        "paymentMethodImage": {
          "png": "https://data.imoje.pl/img/pay/blik.png"
        },
        "paymentMethodCodeImage": {
          "png": "https://data.imoje.pl/img/pay/blik.png"
        }
      }
    ]
  }
}