メインコンテンツへスキップ
PDF4me API統合AIとSDK知識ベース拡張機能APIテスターブログ

SwissQRコードを読み取る - 決済データ抽出ツール API

PDF4me SwissQRコードを読み取る SwissQRコードを抽出して読み取ることができます PDF 高度なドキュメントを使用する OCR そしてバーコード認識技術。 API サービスプロセス PDF ファイルと抽出された構造化された支払い情報には、金額、通貨、 IBAN債権者の詳細、および支払い参照情報により、シームレスなデジタル決済処理を実現します。 API 受け取る PDF コンテンツを通じて REST API 通話を利用して Base64 安全なデータ送信のためのエンコード機能。このソリューションは、請求書処理、銀行システムとの連携、決済自動化、財務報告に最適です。

関連ブログ記事
この機能に関するブログ記事はまだありません。近日公開予定です。
その間、PDF4me ブログを閲覧して、あらゆるプラットフォームのチュートリアルやワークフローをご覧ください。
ブログをご覧ください →

認証 API リクエスト​

アクセスするには PDF4me REST APIすべてのリクエストには適切な認証情報を含める必要があります。認証により安全な通信が保証され、あなたが正規のユーザーであることが検証されます。 REST API。

Get your api Key

主な機能​

  • SwissQRコード認識SwissQRコードを抽出して読み取る PDF 高度なドキュメントを使用する OCR バーコード認識技術
  • 構造化決済データ: 金額、通貨、構造化された支払い情報などを抽出する。 IBAN債権者情報、および支払い参照情報
  • スイス決済スタンダードスイスへのサポート QR-請求書デジタル決済規格（2020年6月）
  • 非同期処理: サポート async 長時間実行される操作をポーリングで処理する

SwissQRコードのサポート​

の API SwissQRコードの読み取りをサポートしています PDF 文書。SwissQRコードには、金額、通貨、 IBAN債権者情報、支払参照情報などが含まれます。抽出されたデータは、決済処理システムとの連携のために標準化された形式で返されます。

REST APIエンドポイント​

の PDF4me REST API 標準を使用する HTTP リソースとやり取りするためのメソッド。すべてのSwissQRコード読み取り操作は、単一のエンドポイントを介して実行されます。

  • 方法： POST
  • 終点： /api/v2/ReadSwissQRBill

REST APIパラメータ​

SwissQRコード読み取りのパラメータ一覧 REST APIパラメータは、理解と実装を容易にするためにカテゴリ別に整理されています。

重要： アスタリスク (*) が付いているパラメータは必須であり、提供する必要があります。 API 正しく機能するため。

パラメータ必須その機能例
jobIdExtOptionalYour own reference for this call. It is stored with the API call log so you can correlate calls with your jobs. Type: string.
integrationsOptionalIntegration identifiers, forwarded unchanged with the job's notification settings. Type: array.
isAsyncOptionalSet to `true` to process the action asynchronously and get a job to poll at `/api/v2/GetActionStatus`. Only honoured by actions that support asynchronous processing. Type: boolean.true
docNameOptionalSource file name including its extension. Several actions dispatch on the extension, so it should always be set; when omitted a per-action default is used. Type: string.invoice.pdf
docContentRequiredThe source file. Accepts the base64-encoded file content, a `pdf4meblobid://<id>` reference to a previously uploaded blob, or an `https` URL to the source document. Required: an empty value fails with `File is empty`. Type: string.JVBERi...
docContentBytesOptionalAlternative raw byte payload for the source file. Type: string.
callBackUrlOptionalOptional URL notified when an asynchronous job completes. Type: string.

出力​

の PDF4me SwissQRコードを読み取る REST API 処理モードに基づいて異なる応答を返します。 API 構造化されたリターン JSON SwissQRコード情報を含むデータ。

同期処理（デフォルト）

いつ async 設定されていないか、 false、 API リクエストを即座に処理します。

ステータスコード: 200 OK

Content-Type: application/json

応答本文：

{
  "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"
  }
}

回答欄:

  • ファイル名 (文字列): PDF ファイル名
  • mimeタイプ （弦）： MIME ファイルの種類（application/pdf）
  • ファイルサイズ （数値）：サイズ PDF ファイル（バイト単位）
  • 成功 （ブール値）：SwissQRコードが正常に読み取られたかどうかを示します。
  • スイスQRコードデータ （オブジェクト）：抽出されたSwissQRコード決済情報
    • 額 （文字列）：支払い金額
    • 通貨 (文字列): 通貨コード (CHF、 EUR、 USD）
    • 彼らは行く （弦）： IBAN 債権者の
    • 債権者名 （文字列）：債権者名または会社名
    • 支払い参照 （文字列）：支払い参照番号
    • 期日 （文字列）：支払期日（利用可能な場合）
    • 目的 （文字列）：支払い目的または説明

例 （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}`);
}

リクエスト例​

ヘッダ​

Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY

注記：

  • 手に入れよう API 鍵から PDF4me ダッシュボード
  • の API キーは Base64 エンコードされ、「Basic」がプレフィックスとして付加されています。 Authorization ヘッダー
  • 例: API 重要なのは abc123エンコードして Base64 そして使用する Authorization: Basic YWJjMTIz

ペイロード​

例：

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

コードサンプル​

の PDF4me SwissQRコードを読み取る REST API 複数のプログラミング言語のコードサンプルを提供します。開発環境に最適な言語を選択してください。

C# （CSharpサンプル

完了 C# SwissQRコードを読み取るための実装 PDF 文書:

業界におけるユースケースとアプリケーション​

金融・銀行業務におけるユースケース

  • 請求書処理: スイスから支払い情報を抽出 QR 自動支払い処理用の請求書
  • 銀行との連携SwissQRコード読み取り機能を銀行アプリケーションおよび決済システムに統合する
  • 決済自動化支払いワークフローを効率化し、手作業によるデータ入力を削減します。
  • 請求書処理: スイスの自動化 QR 請求書の処理と支払い確認
  • 支払照合支払いの照合および調整プロセスを自動化する
  • 財務報告: スイスから支払いデータを抽出 QR 財務報告および分析のためのコード

ヘルプが必要な場合​

Get Your API KeyAPI SamplesGetting Started