Komfortkasse API v2
GET /image/{orderNumber}
Api key

Get a payment-related image (QR code, payment slip) for an order.

Path parameters

  • orderNumber string Required

    Order number (unique per shop).

Query parameters

  • type string

    Image type to retrieve.

    Values are QRCODE, PAYMENTSLIP, or PAYMENTSLIPPRINT.

Responses

  • 200 application/json

    Image data.

    Hide response attributes Show response attributes object
    • type string

      Image type:

      • QRCODE — EPC QR Code (GiroCode)
      • PAYMENTSLIP — payment slip (Germany: "Überweisungsträger", Austria: "Zahlschein", Switzerland: "Einzahlungsschein")
      • PAYMENTSLIPPRINT — a payment slip that you can print yourself (currently only available for QR Invoice in Switzerland)

      Values are QRCODE, PAYMENTSLIP, or PAYMENTSLIPPRINT.

    • format string

      Image format. Always png.

      Value is png.

    • data string

      Base64 encoded image data.
  • 400 application/json

    Invalid request — for example missing required fields or wrong format.

    Hide response attribute Show response attribute object
    • error string Required

      Error message.
  • 401 application/json

    Authentication failed — API key missing or invalid.

    Hide response attribute Show response attribute object
    • error string Required

      Error message.
  • 404 application/json

    Resource not found (e.g. unknown order number).

    Hide response attribute Show response attribute object
    • error string Required

      Error message.
GET /image/{orderNumber} 
curl \
 --request GET 'https://ssl.komfortkasse.eu/api/v2/image/123456' \
 --header "X-Komfortkasse-API-Key: $API_KEY"
Response examples (200) 
{
  "type": "QRCODE",
  "format": "png",
  "data": "string"
}
Response examples (400) 
{
  "error": "Invalid request"
}
Response examples (401) 
{
  "error": "API Key missing"
}
Response examples (404) 
{
  "error": "Order not found"
}