Zum Hauptinhalt springen
PDF4me APIIntegrationenWissensdatenbankErweiterungenAPI-TesterBlog

SwissQR-Code lesen – Zahlungsdatenextraktor API

PDF4me SwissQR-Code lesen ermöglicht es Ihnen, SwissQR-Codes zu extrahieren und zu lesen. PDF Dokumente mit fortgeschrittenen OCR und Barcode-Erkennungstechnologie. API Serviceprozesse PDF Dateien und Auszüge aus strukturierten Zahlungsinformationen einschließlich Beträgen und Währung, IBANGläubigerdaten und Zahlungsreferenzen für eine reibungslose digitale Zahlungsabwicklung. API empfängt PDF Inhalte durch REST API Anrufe, die genutzt werden Base64 Verschlüsselung für sichere Übertragung. Diese Lösung eignet sich ideal für Rechnungsverarbeitung, Bankintegration, Zahlungsautomatisierung und Finanzberichterstattung.

Verwandte Blog-Beiträge
Zu dieser Funktion gibt es noch keinen Blogbeitrag – folgt in Kürze.
Schauen Sie sich in der Zwischenzeit im PDF4me-Blog Tutorials und Arbeitsabläufe für alle Plattformen an.
Besuchen Sie den Blog →

Authentifizierung Ihres API Anfrage​

Um auf die PDF4me REST APIJede Anfrage muss die entsprechenden Authentifizierungsdaten enthalten. Die Authentifizierung gewährleistet eine sichere Kommunikation und bestätigt Ihre Identität als autorisierter Benutzer des Systems. REST APIDie

Get your api Key

Hauptmerkmale​

  • SwissQR-Code-Erkennung: SwissQR-Codes extrahieren und lesen von PDF Dokumente mit fortgeschrittenen OCR und Barcode-Erkennungstechnologie
  • Strukturierte Zahlungsdaten: Strukturierte Zahlungsinformationen extrahieren, einschließlich Beträge, Währung, IBANGläubigerdaten und Zahlungsreferenzen
  • Schweizer ZahlungsstandardUnterstützung für die Schweiz QR-Standard für digitale Rechnungszahlung (Juni 2020)
  • Asynchrone VerarbeitungUnterstützung für async Verarbeitung mit Abfrage für langlaufende Operationen

SwissQR-Code-Unterstützung​

Der API unterstützt das Lesen von SwissQR-Codes von PDF Dokumente. SwissQR-Codes enthalten strukturierte Zahlungsinformationen einschließlich Betrag, Währung, IBANDie extrahierten Daten umfassen Gläubigerdaten und Zahlungsreferenzen und werden in einem standardisierten Format zur Integration in Zahlungsabwicklungssysteme zurückgegeben.

REST-API-Endpunkt​

Der PDF4me REST API verwendet Standard HTTP Methoden zur Interaktion mit Ressourcen. Alle SwissQR-Code-Leseoperationen werden über einen einzigen Endpunkt durchgeführt:

  • Verfahren: POST
  • Endpunkt: /api/v2/ReadSwissQRBill

REST-API-Parameter​

Vollständige Liste der Parameter für das Lesen von SwissQR-Codes REST APIDie Parameter sind zur besseren Verständlichkeit und Implementierung nach Kategorien geordnet.

Wichtig: Mit einem Sternchen (*) gekennzeichnete Parameter sind erforderlich und müssen angegeben werden. API um ordnungsgemäß zu funktionieren.

Erforderliche Parameter​

ParameterTypBeschreibungBeispiel
docContent*Base64PDF Dateiinhalt kodiert in Base64 enthalten SwissQR-CodesJVBERi...
docName*StringPDF Dateiname mit der Erweiterung .pdfinvoice.pdf
async*BooleanAktivieren Sie die asynchrone Verarbeitung. Wenn true, Die API Gibt den Statuscode 202 zurück und stellt eine Abfrage bereit. URL im Location Überschrifttrue

Ausgabe​

Der PDF4me SwissQR-Code lesen REST API Die Antwort hängt vom Verarbeitungsmodus ab. API strukturierte Renditen JSON Daten mit SwissQR-Code-Informationen.

Synchrone Verarbeitung (Standard)

Wann async ist nicht festgelegt oder auf gesetzt false, Die API verarbeitet die Anfrage sofort:

Statuscode: 200 OK

Content-Type: application/json

Antworttext:

{
  "fileName": "invoice.pdf",
  "mimeType": "application/pdf",
  "fileSize": 2456789,
  "success": true,
  "swissQrCodeData": {
    "amount": "100.00",
    "currency": "CHF",
    "iban": "CH9300762011623852957",
    "creditorName": "Swiss Company AG",
    "paymentReference": "INV-2024-001",
    "dueDate": "2024-12-31",
    "purpose": "Invoice payment"
  }
}

Antwortfelder:

  • Dateiname (Zeichenkette): Die PDF Dateiname
  • MIME-Typ (Zeichenkette): MIME Dateityp (application/pdf)
  • Dateigröße (Zahl): Größe der PDF Datei in Bytes
  • Erfolg (Boolescher Wert): Gibt an, ob der SwissQR-Code erfolgreich gelesen wurde.
  • swissQrCodeData (Objekt): Extrahierte SwissQR-Code-Zahlungsinformationen
    • Menge (Zeichenkette): Zahlungsbetrag
    • Währung (Zeichenkette): Währungscode (CHF, EUR, USD)
    • Sie gingen (Zeichenkette): IBAN des Gläubigers
    • Gläubigername (Zeichenkette): Name oder Firma des Gläubigers
    • Zahlungsreferenz (Zeichenkette): Zahlungsreferenznummer
    • Fälligkeitsdatum (Zeichenkette): Fälligkeitsdatum der Zahlung (falls verfügbar)
    • Zweck (Zeichenkette): Zahlungszweck oder Beschreibung

Beispiel (JavaScript):

const response = await fetch(url, options);
const data = await response.json();
if (data.success) {
  console.log(`Amount: ${data.swissQrCodeData.amount} ${data.swissQrCodeData.currency}`);
  console.log(`IBAN: ${data.swissQrCodeData.iban}`);
}

Beispielanfrage​

Kopfzeile​

Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY

Notiz:

  • Hol dir deins API Schlüssel vom PDF4me Armaturenbrett
  • Der API Der Schlüssel muss sein Base64 kodiert und mit "Basic" präfixiert in der Authorization Überschrift
  • Beispiel: Wenn Ihr API Schlüssel ist abc123, kodieren Sie es zu Base64 und verwenden Authorization: Basic YWJjMTIz

Nutzlast​

Beispiel:

{
  "docContent": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8Ci9Gb250IDw8Ci9GMSA0IDAgUgo+Pgo+PgovQ29udGVudHMgNSAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9CYXNlRm9udCAvSGVsdmV0aWNhCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihIZWxsbyBXb3JsZCkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1NCAwMDAwMCBuIAowMDAwMDAwMTAxIDAwMDAwIG4gCjAwMDAwMDAxNzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDYKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM0MQolJUVPRg==",
  "docName": "invoice.pdf",
  "async": true
}

Codebeispiele​

Der PDF4me SwissQR-Code lesen REST API Es werden Codebeispiele in verschiedenen Programmiersprachen bereitgestellt. Wählen Sie die Sprache, die am besten zu Ihrer Entwicklungsumgebung passt:

C# (CSharp) Probe

Vollständig C# Implementierung zum Lesen von SwissQR-Codes von PDF Dokumente:

Branchenspezifische Anwendungsfälle und Anwendungen​

Anwendungsfälle im Finanz- und Bankwesen

  • Rechnungsverarbeitung: Zahlungsinformationen aus Schweizer Quellen extrahieren QR Rechnungen für die automatisierte Zahlungsabwicklung
  • BankintegrationIntegration der SwissQR-Code-Lesung in Bankanwendungen und Zahlungssysteme
  • Zahlungsautomatisierung: Zahlungsprozesse optimieren und manuelle Dateneingabe reduzieren
  • Rechnungsverarbeitung: Automate Swiss QR Rechnungsbearbeitung und Zahlungsprüfung
  • Zahlungsabstimmung: Automatisierung der Zahlungsabgleichs- und Abstimmungsprozesse
  • Finanzberichterstattung: Zahlungsdaten aus der Schweiz extrahieren QR Codes für die Finanzberichterstattung und -analyse

Hilfe erhalten​

Get Your API KeyAPI SamplesGetting Started