POST /{merchantId}/service/{serviceId}/get-payment-methods
Token autoryzacyjny

Zapytanie umożliwia pobranie dostępnych metod płatności

Path parameters

  • merchantId string Required

    Identyfikator klienta

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

application/json

Body Required

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

  • device string

    Urządzenie, dostępne wartości: 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

    Zapytanie wykonane poprawnie

    Hide response attributes Show response attributes object
    • label string

      Nazwa metody płatności

    • isOnline boolean

      Informacja czy metoda płatności jest dostępna w imoje. Dostępność metod płatności zwykle jest ograniczana globalnie w przypadku awarii lub zaplanowanych prac technicznych.

    • image array[object]

      Link do logo metody płatności

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

      Lista kanałów dostępnych w ramach danej meotdy płatności.

      Hide channels attributes Show channels attributes object
      • paymentMethod string

        Oznaczenie metody płatności

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

      • paymentMethodCode string

        Oznaczenie kanału płatności

        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

        Nazwa kanału płatności

      • priority integer

        Priorytet kanału płatności

      • isOnline boolean

        Informacja czy kanał płatności jest dostępny w panelu imoje. Kanał może być niedostępny nawet jeśli jest aktywny w sklepie. Dostępność kanałów płatności zwykle jest ograniczana globalnie w przypadku awarii lub zaplanowanych prac technicznych.

      • image array[object]

        Link do logo kanału płatności

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

      Priorytet metody płatności
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
  }
]