Developers can integrate Swiss QR Bills API ( Application Programming Interface) into their billing applications or mobile applications. There is no limit of testing Swiss QR Bills API.
For Production API Endpoint, login to member Area and purchase API Credits. Users who have high volume of transactions, can contact us.
| Parameters | Data Type | Whether Mandatory | Length | Description |
|---|---|---|---|---|
| apikey | string | yes | 100 Characters Maximum | Register and login to member area to get your apikey. |
| CRname | string | yes | 70 Characters Maximum | Seller / Creditor/ Payment Receiver Name |
| CRiban | string | yes | 21 Alphanumeric | IBAN No. of the Seller/ Payment Receiver's. IBAN Nos. of Switzerland and Liechtenstein are permitted |
| CRadd1 | string | no | 70 Characters Maximum | Seller/ Payment Receiver's Street/P.O. Box from the creditor's address |
| CRadd2 | string | no | 16 Characters Maximum | Seller/ Payment Receiver's Building number from creditor's address |
| CRPostCode | string | Conditional | 16 Characters Maximum | Seller/ Payment Receiver's postal code is must be provided without a country code prefix |
| CRcity | string | Conditional | 35 Characters Maximum | Seller/ Payment Receiver's City / town |
| CRcountry | string | yes | 2 Characters Only | Seller/ Payment Receiver's Country Code. Only CH/LI permitted. CH -> for Switzerland LI -> Liechtenstein |
| billamount | Currency | no | 12 (Format 0.00) | Bill Amount. Maximum 12-digits permitted, including decimal separators. Only decimal points (".") are permitted as decimal separators. The amount must be between CHF/EUR 0.01 and CHF/EUR 999999999.99. |
| CRcurrency | string | yes | 3 Alpha | CHF/EUR CHF->For Swiss franc EUR-Euro |
| DRname | string | Conditional | 70 Characters Maximum | Buyer / Debtor/ Payer Name |
| DRadd1 | string | no | 70 Characters maximum | Buyer/ Payer's Street/P.O. Box from the creditor's address |
| DRadd2 | string | no | 16 Characters Maximum | Buyer/ Payer's Building number from creditor's address |
| DCRPostCode | string | Conditional | 16 Characters maximum | Buyer/ Payer's postal code is must be provided without a country code prefix |
| DRcity | string | Conditional | 35 Characters maximum | Buyer/ Payer's City / town |
| DRcountry | string | Conditional | 2 Characters Only | Buyer/ Payer's Country Code. Only Two-letter country code according to ISO 3166-1 |
| refType | string | yes | 4 Characters Maximum | QRR -> QR reference SCOR -> Creditor Reference (ISO 11649) NON -> without reference |
| ref | string | Conditional | 27 Characters | QRR - 27 Characters SCOR - 5-25 Characters |
| addInfo | string | no | 140 characters | Additional Information |
| billingInfo | string | no | 140 characters | Bill Related information |
| othpayscheme1 | string | no | 100 Characters | Payment Scheme |
| othpayscheme2 | string | no | 100 characters | Payment Scheme |
| payslip | string | no | 3 characters | YES-> If require QR Code with payment detail/ payment slip NO->If require only Swiss QR Code. If option is not defined, only Swiss QR Code image will be generated. Swiss QR Bill Image With Payslip Swiss QR Bill Image Without Payslip |
| output | string | no | 5 characters | image -> if required output is QR Code Image JSON-> If required output in JSON. Output will be JSON and image will be encoded in base64 String If option is not defined, image will be the output in response |
| website | string | no | 100 characters | website name to be printed on Swiss QR Bill in production. |