POST /{merchantId}/service/{serviceId}/get-payment-methods
Authorization token

The request enables you to download the available payment methods.

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}$.

application/json

Body Required

  • amount integer Required

    The transaction amount in the smallest currency unit, e.g. pennies.

  • currency string Required

    Transaction currency in the ISO 4217 standard

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

  • device string

    Device, available values: desktop, mobile

    Values are desktop or mobile.

  • 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.

Responses

  • 200 application/json

    Request executed correctly

    Hide response attributes Show response attributes object
    • label string

      Payment method name

    • isOnline boolean

      Information about whether a payment method is available in the imoje panel. The method may be unavailable even if it is active in the shop. The availability of payment methods is usually restricted globally in the event of a failure or scheduled technical work.

    • image array[object]

      Link to payment method logo

      Hide image attribute Show image attribute object
      • png string
    • channels array[object]

      List of channels available for a given payment method.

      Hide channels attributes Show channels 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.

      • label string

        Payment channel name

      • priority integer

        Payment channel priority

      • 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.

      • image array[object]

        Link to payment channel logo

        Hide image attribute Show image attribute object
        • png string
    • priority integer

      Payment method priority
POST /{merchantId}/service/{serviceId}/get-payment-methods 
curl \
 --request POST 'https://api.imoje.pl/v1/merchant/{merchantId}/service/{serviceId}/get-payment-methods' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"amount":100,"device":"desktop","locale":"pl","currency":"PLN"}'
Request example 
{
  "amount": 100,
  "device": "desktop",
  "locale": "pl",
  "currency": "PLN"
}
Response examples (200) 
[
  {
    "image": [
      {
        "png": "https://data.imoje.pl/img/pay/blik.png"
      }
    ],
    "label": "Płatność BLIK",
    "channels": [
      {
        "image": [
          {
            "png": "https://data.imoje.pl/img/pay/blik.png"
          }
        ],
        "label": "Płatność BLIK",
        "isOnline": true,
        "priority": 1,
        "paymentMethod": "blik",
        "paymentMethodCode": "blik"
      }
    ],
    "isOnline": true,
    "priority": 1
  }
]