Swiss QR Invoice

Generate Swiss QR bills to use it on your invoice documents.

原始信息汇总

Swiss QR Invoice 数据集概述

数据集基本信息

• 数据集名称: Swiss QR Invoice
• 提供方: APIstax
• 类别: Payments
• 访问方式: API
• API版本: 1.7.1 (current)
• 订阅模式: Freemium
• 订阅计划:
  • BASIC: $0.00 / mo
  • PRO: $6.99 / mo
  • ULTRA: $17.99 / mo
  • MEGA: $45.99 / mo
• 性能指标:
  • 流行度: 1.9
  • 服务等级: 100%
  • 延迟: 90ms

数据集描述

该API用于生成瑞士QR账单（QR invoice/QR bill），以便在发票文档上使用。QR账单在瑞士用于发起支付交易，被视为等同于欧盟的EPC QR码。除了QR码，QR账单还包含一个以人类可读形式显示信息的区域。

主要端点

• POST Create Swiss QR Invoice: 创建瑞士QR账单。

请求参数

creditor (Object)

债权人信息。必须至少指定 iban、name、postalCode 和 city。

• iban (String): 债权人的国际银行账号。所有块之间的空格将被移除。IBAN必须来自瑞士或列支敦士登，因此必须以CH或LI开头。
• name (String): 债权人姓名。长度不得超过70个字符。
• street (String): 债权人街道名。长度不得超过70个字符。
• postalCode (String): 债权人邮政编码。长度不得超过16个字符。
• city (String): 债权人城市名。长度不得超过35个字符。
• country (String): 债权人的国家代码（ISO 3166-1 alpha-2）。默认为 CH。

debtor (Object) (可选)

债务人信息。如果提供，则必须至少指定 name、postalCode 和 city。

• name (String): 债务人姓名。长度不得超过70个字符。
• street (String): 债务人街道名。长度不得超过70个字符。
• postalCode (String): 债务人邮政编码。长度不得超过16个字符。
• city (String): 债务人城市名。长度不得超过35个字符。
• country (String): 债务人的国家代码（ISO 3166-1 alpha-2）。默认为 CH。

其他参数

• currency (String): 货币（ISO 4217）。仅允许 CHF 或 EUR。默认为 CHF。
• amount (Float): 支付金额，最多两位小数。可选但建议提供。
• information (String): 非结构化信息，例如可用于支付目的。长度不得超过140个字符。
• structuredInformation (String): 结构化信息，包含用于自动记账的编码信息。最新版本的语法定义可在 swico.ch 找到。
• reference (String): 参考号，可以是QR参考号（如果在 creditor.iban 中使用QR-IBAN）或ISO 11649债权人参考号。
• size (String): 请求的输出格式，可以是 QR_CODE、QR_BILL 或 A4_SHEET。默认为 QR_CODE。
• language (String): 创建文档的语言。仅在 size 为 QR_BILL 或 A4_SHEET 时使用。可用值为 DE、FR、IT 和 EN。默认为 EN。

输出格式

输出格式由 size 参数控制：

• A4 Sheet (A4_SHEET): 创建一张A4纵向页面（210 x 297 mm），QR账单位于底部。
• QR Bill (QR_BILL): 创建QR账单付款单（210 x 110 mm）。
• QR Code (QR_CODE): 仅创建QR码（46 x 46 mm）。

可能的错误

• message.countryMustBeValid: 参数 country 必须有效且为ISO 3166-1 alpha-2代码。
• message.currencyMustBeValid: 参数 currency 必须有效且为ISO 4217货币代码。
• message.ibanMustBeValid: 参数 iban 必须有效。
• message.ibanMustNotBeBlank: 参数 iban 为必填项。
• message.ibanMustContainValidCountryCode: 参数 iban 必须有效且必须以CH或LI开头。
• message.creditorMustNotBeNull: 参数 creditor 为必填项。
• message.nameMustNotBeBlank: 参数 name 为必填项。
• message.postalCodeMustNotBeBlank: 参数 postalCode 为必填项。
• message.cityMustNotBeBlank: 参数 city 为必填项。
• message.informationMustNotBeLongerThan140Characters: 参数 information 长度不得超过140个字符。
• message.structuredInformationMustBeValid: 参数 structuredInformation 必须是有效的 swico.ch 信息。
• message.structuredInformationMustBeLongerThan3Characters: 参数 structuredInformation 长度必须至少为3个字符。
• message.structuredInformationMustNotBeLongerThan140Characters: 参数 structuredInformation 长度不得超过140个字符。
• message.nameMustNotBeLongerThan70Characters: 参数 name 长度不得超过70个字符。
• message.streetMustNotBeLongerThan70Characters: 参数 street 长度不得超过70个字符。
• message.postalCodeMustNotBeLongerThan16Characters: 参数 postalCode 长度不得超过16个字符。
• message.cityMustNotBeLongerThan35Characters: 参数 city 长度不得超过35个字符。
• message.amountMustNotBeSmallerThan1: 参数 amount 必须在1到99999999999之间。
• message.amountMustNotBeBiggerThan99999999999: 参数 amount 必须在1到99999999999之间。
• message.referenceMustBeValid: 参数 reference 必须有效且为ISO 11649或QR参考号。
• message.qrIbanRequiresValidQrReference: 如果使用QR IBAN，则必须指定有效的QR参考号。
• message.qrReferenceRequiresQrIban: 如果使用QR参考号，则必须指定QR IBAN。

示例请求

一个使用所有参数的假设性 curl 请求示例如下： bash curl -X POST https://api.apistax.io/v1/swiss-qr-invoice -o a4-sheet.png -H Authorization: Bearer API_KEY_HERE -H Content-Type: application/json -H Accept: image/png -d { "creditor": { "iban": "CH07 3000 0017 3000 9700 0", "name": "Schweizerisches Rotes Kreuz", "street": "Postfach", "postalCode": "3001", "city": "Bern", "country": "CH" }, "debtor": { "name": "Max Mustermann", "street": "Musterstraße 1", "postalCode": "3000", "city": "Bern", "country": "CH" }, "currency": "CHF", "amount": 150.00, "information": "Emergency relief", "reference": "00 00000 00371 40000 00000 85842", "size": "A4_SHEET", "language": "EN" }

提供方信息

• API创建者: APIstax
• 订阅者数量: 1
• 资源: Terms of Use