Read SwissQR Code

Barcode → Read SwissQR Code

The Read SwissQR Code API extracts Swiss QR-bill data from a PDF. You send the PDF as Base64 (docContent), docName, and optionally IsAsync. The API returns JSON with structured payment data: amount, currency, IBAN, creditor name, payment reference, due date, purpose, and related fields. Use the tester below to try it; more details are in the sections that follow.

Try the Read SwissQR Code API

Quick reference

Endpoint: POST /api/v2/ReadSwissQRBill · Required: api-key, docContent, docName, IsAsync

Try it live

Use the form below to send your API key and a PDF (Base64) that contains a Swiss QR-bill. The response is JSON with extracted payment information (or a polling URL when async). No code required—fill the fields and click Send request.

Loading API Tester...

Overview, parameters, and use cases

Overview

What is Read SwissQR Code?

This endpoint reads Swiss QR-bill codes from a PDF and returns structured payment data. You send the PDF (Base64) and optionally enable async; the API returns JSON with amount, currency, IBAN, creditor name, payment reference, due date, purpose, and related fields—ready for payment automation or reconciliation.

Key features

• Structured payment data – Amount, currency, IBAN, creditor name, reference, due date, purpose.
• Single PDF input – docContent (Base64) and docName; no extra configuration.
• Async – IsAsync returns a URL to poll for results when processing is asynchronous.

Best for

Use after Create SwissQR Bill to verify bills, or to extract payment data from existing Swiss QR invoices for banking or accounting workflows.

Parameters

API parameters

Parameter	Type	Required	Description
api-key	string	Yes	Your PDF4me API key, Base64 encoded. Get it from the dashboard.
docContent	base64	Yes	PDF file content (Base64) containing a Swiss QR-bill.
docName	string	Yes	PDF file name with .pdf extension.
IsAsync	boolean	Yes	Enable asynchronous processing.

Use cases

When to use Read SwissQR Code

• Invoice and bill processing – Extract payment information from Swiss QR invoices for automated payment or reconciliation.
• Banking and payment systems – Integrate Swiss QR-bill reading into banking or payment apps.
• Payment automation – Reduce manual data entry by reading amount, IBAN, reference, and creditor from PDFs.
• Verification – Confirm that Swiss QR-bills created with Create SwissQR Bill are readable and correct.

Need the full API?

For request/response schemas and code samples, see Read SwissQR Code in the PDF4me API docs.

Prerequisites

Before using this endpoint, make sure you have:

• A valid PDF4me API key (Get your API Key)
• A PDF document containing SwissQR codes
• The PDF file encoded in Base64 format

Response Format

The API returns JSON with swissQrCodeData (amount, currency, iban, creditorName, paymentReference, dueDate, purpose, etc.). Status 200 returns the data immediately; Status 202 means processing is asynchronous—poll the Location header URL until the result is ready.

Get Help

Get Your API KeyFull DocumentationAPI Tester Home