QR Invoice REST API (2.0)

The QR Invoice REST API provides various services for creation and processing of Swiss QR Invoices. This API is available as a Cloud Service but is also available as a self-hosted solution.

Product Website

www.qr-invoice.ch

API Key

This API requires an API Key for authorization on the Cloud. You may use the following Demo API Key or request a trial API on our website: QrInvoice - Order Trial Key
582c9ea9-741a-4bb6-acae-cf92f8805864

Important: Use of Demo API Key comes with a few restrictions!

Hints

  • Please note, that you can retrieve JSON example documents in the «00 Example Data» section using the respective Endpoints. E.g.: https://rest.qr-invoice.cloud/v2/examples/qr-invoice/with-qr-reference
  • Handle error responses correctly by checking HTTP status and read detailed error/validation message from response body
  • Check all parameters
  • Check out length limitation
  • Consult official standards / specification if you need more detailed information regarding QR-Bill specification

Standards / Specifications

Overview of official specs www.qr-invoice.ch/dokumentation/standards-merkblaetter/

QR Invoice Layers


QR Invoice Model



Product Version: 1.21-SNAPSHOT

Download OpenAPI description
Languages
Servers
Generated server url

https://rest.qr-invoice.cloud/

00 Example Data

Various example data that can be used as example input to other services

Operations

10 QR Invoice Documents including Payment Part & Receipt (QR Bill)

Operations

11 Payment Part & Receipt (QR Bill)

Operations

12 Swiss QR Code

Operations

13 Swiss Payments Code

Operations

20 IBAN

Operations

Validate a QR IBAN. QR IBANs are regular IBANs. The only special thing is that the IID (institutional identification) is in the QR-IID range. QR-IIDs consist exclusively of numbers from 30000 to 31999.

Request

Security
X-API-Key or api_key
Bodytext/plainrequired
string

QR-IBAN

curl -i -X POST \
  https://rest.qr-invoice.cloud/v2/qr-iban/validate \
  -H 'Content-Type: text/plain' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d string

Responses

QR-IBAN is valid

Body*/*
object

Validate an IBAN

Request

Security
X-API-Key or api_key
Bodytext/plainrequired
string

IBAN

curl -i -X POST \
  https://rest.qr-invoice.cloud/v2/iban/validate \
  -H 'Content-Type: text/plain' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d string

Responses

IBAN is valid

Body*/*
object

Normalize an IBAN. Works for QR-IBAN too.

Request

Security
X-API-Key or api_key
Bodytext/plainrequired
string

IBAN

curl -i -X POST \
  https://rest.qr-invoice.cloud/v2/iban/normalize \
  -H 'Content-Type: text/plain' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d string

Responses

Normalized IBAN

Bodytext/plain
string

Format an IBAN. Works for QR-IBAN too.

Request

Security
X-API-Key or api_key
Bodytext/plainrequired
string

IBAN

curl -i -X POST \
  https://rest.qr-invoice.cloud/v2/iban/format \
  -H 'Content-Type: text/plain' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d string

Responses

Valid IBAN

Bodytext/plain
string

21 QR Reference (QRR)

Operations

22 Creditor Reference (SCOR)

Operations

23 Country Codes

According to ISO 3166-1 alpha-2

Operations

30 Bill Information

Operations

31 Alternative Schemes

Operations

90 PDF

Operations

99 Authentication

Operations

XX Deprecated QR Invoice Operations v1

Version 1 of QR Invoice REST API

Operations