URL
Codeblock GmbH
The Dibito REST API provides services to submit, verify and deliver eBills. The API is designed to be used by biller integrations.
https://app.dibito.ch/
https://app.dibito.ch/api/v1/examples/reminder
curl -i -X GET \
'https://app.dibito.ch/api/v1/examples/reminder?recipientEmail=string&referencedBillReferenceNumber=string' \
-H 'X-API-Key: YOUR_API_KEY_HERE'OK
The amount of the business case (amount incl. VAT + currency code, e.g. CHF 1183.46). Must be matching with the total amount (totalAmount), if business case is an invoice, reminder or donation inquiry.
Information about the account and reference of the invoice issuer.
In case the account holder differs from the biller use this element to provide the account holder name and address.
Reference number, structured payment reference. Note: the reference is either a QR reference or creditor reference (ISO 11649).
QR Reference: 27 characters, numerical; check digit computation with Modulus 10 recursive (27th position of the reference).
Creditor Reference (ISO 11649): up to 25 characters, alphanumeric.
When using QR-IBAN, this element must be filled with the QR Reference. When using IBAN and referenceType SCOR, this element must be filled with the Creditor Reference. When using IBAN and referenceType NON, this element is not permitted to be filled.
Unstructured message
Credit account of the invoice issuer (IBAN or QR-IBAN). See also ISO 13616-1. The usage of IBAN or QR-IBAN is only permitted with country codes CH or LI and 21 alphanumeric characters.
Example: CH9300762011623852957 LI21088100002324013AA
Must contain country code CH or LI, otherwise the business case will be denied. Must be matching with a credit account that is specified in the infrastructure in the master data of the invoice issuer, otherwise the business case will be denied.
The amount of the business case (amount incl. VAT + currency code, e.g. CHF 1183.46). Must be matching with the total amount (totalAmount), if business case is an invoice, reminder or donation inquiry.
Due date. In the case of donation inquiries, the due date acts as a proposal for the payment date.
At time of submission, cannot be set to more than 3 years in the future (1095 days) for payment mode ebill. At time of submission, cannot be set to more than 30 days in the future for payment mode ebill debit. At time of submission, cannot be older than 90 days.
https://app.dibito.ch/api/v1/examples/reminder-with-workflow
curl -i -X GET \
'https://app.dibito.ch/api/v1/examples/reminder-with-workflow?recipientEmail=string&referencedBillReferenceNumber=string' \
-H 'X-API-Key: YOUR_API_KEY_HERE'OK
The amount of the business case (amount incl. VAT + currency code, e.g. CHF 1183.46). Must be matching with the total amount (totalAmount), if business case is an invoice, reminder or donation inquiry.
Information about the account and reference of the invoice issuer.
In case the account holder differs from the biller use this element to provide the account holder name and address.
Reference number, structured payment reference. Note: the reference is either a QR reference or creditor reference (ISO 11649).
QR Reference: 27 characters, numerical; check digit computation with Modulus 10 recursive (27th position of the reference).
Creditor Reference (ISO 11649): up to 25 characters, alphanumeric.
When using QR-IBAN, this element must be filled with the QR Reference. When using IBAN and referenceType SCOR, this element must be filled with the Creditor Reference. When using IBAN and referenceType NON, this element is not permitted to be filled.
Unstructured message
Credit account of the invoice issuer (IBAN or QR-IBAN). See also ISO 13616-1. The usage of IBAN or QR-IBAN is only permitted with country codes CH or LI and 21 alphanumeric characters.
Example: CH9300762011623852957 LI21088100002324013AA
Must contain country code CH or LI, otherwise the business case will be denied. Must be matching with a credit account that is specified in the infrastructure in the master data of the invoice issuer, otherwise the business case will be denied.
The amount of the business case (amount incl. VAT + currency code, e.g. CHF 1183.46). Must be matching with the total amount (totalAmount), if business case is an invoice, reminder or donation inquiry.
Due date. In the case of donation inquiries, the due date acts as a proposal for the payment date.
At time of submission, cannot be set to more than 3 years in the future (1095 days) for payment mode ebill. At time of submission, cannot be set to more than 30 days in the future for payment mode ebill debit. At time of submission, cannot be older than 90 days.
https://app.dibito.ch/api/v1/examples/instalment-bill
curl -i -X GET \
'https://app.dibito.ch/api/v1/examples/instalment-bill?recipientEmail=string' \
-H 'X-API-Key: YOUR_API_KEY_HERE'OK
The amount of the business case (amount incl. VAT + currency code, e.g. CHF 1183.46). Must be matching with the total amount (totalAmount), if business case is an invoice, reminder or donation inquiry.
https://app.dibito.ch/api/v1/examples/instalment-bill-with-workflow
curl -i -X GET \
'https://app.dibito.ch/api/v1/examples/instalment-bill-with-workflow?recipientEmail=string' \
-H 'X-API-Key: YOUR_API_KEY_HERE'OK
The amount of the business case (amount incl. VAT + currency code, e.g. CHF 1183.46). Must be matching with the total amount (totalAmount), if business case is an invoice, reminder or donation inquiry.
https://app.dibito.ch/api/v1/examples/donation-inquiry
curl -i -X GET \
'https://app.dibito.ch/api/v1/examples/donation-inquiry?recipientEmail=string' \
-H 'X-API-Key: YOUR_API_KEY_HERE'OK
The amount of the business case (amount incl. VAT + currency code, e.g. CHF 1183.46). Must be matching with the total amount (totalAmount), if business case is an invoice, reminder or donation inquiry.
Information about the account and reference of the invoice issuer.
In case the account holder differs from the biller use this element to provide the account holder name and address.
Reference number, structured payment reference. Note: the reference is either a QR reference or creditor reference (ISO 11649).
QR Reference: 27 characters, numerical; check digit computation with Modulus 10 recursive (27th position of the reference).
Creditor Reference (ISO 11649): up to 25 characters, alphanumeric.
When using QR-IBAN, this element must be filled with the QR Reference. When using IBAN and referenceType SCOR, this element must be filled with the Creditor Reference. When using IBAN and referenceType NON, this element is not permitted to be filled.
Unstructured message
Credit account of the invoice issuer (IBAN or QR-IBAN). See also ISO 13616-1. The usage of IBAN or QR-IBAN is only permitted with country codes CH or LI and 21 alphanumeric characters.
Example: CH9300762011623852957 LI21088100002324013AA
Must contain country code CH or LI, otherwise the business case will be denied. Must be matching with a credit account that is specified in the infrastructure in the master data of the invoice issuer, otherwise the business case will be denied.
The amount of the business case (amount incl. VAT + currency code, e.g. CHF 1183.46). Must be matching with the total amount (totalAmount), if business case is an invoice, reminder or donation inquiry.
Due date. In the case of donation inquiries, the due date acts as a proposal for the payment date.
At time of submission, cannot be set to more than 3 years in the future (1095 days) for payment mode ebill. At time of submission, cannot be set to more than 30 days in the future for payment mode ebill debit. At time of submission, cannot be older than 90 days.
https://app.dibito.ch/api/v1/examples/donation-inquiry-with-workflow
curl -i -X GET \
'https://app.dibito.ch/api/v1/examples/donation-inquiry-with-workflow?recipientEmail=string' \
-H 'X-API-Key: YOUR_API_KEY_HERE'OK
The amount of the business case (amount incl. VAT + currency code, e.g. CHF 1183.46). Must be matching with the total amount (totalAmount), if business case is an invoice, reminder or donation inquiry.
Information about the account and reference of the invoice issuer.
In case the account holder differs from the biller use this element to provide the account holder name and address.
Reference number, structured payment reference. Note: the reference is either a QR reference or creditor reference (ISO 11649).
QR Reference: 27 characters, numerical; check digit computation with Modulus 10 recursive (27th position of the reference).
Creditor Reference (ISO 11649): up to 25 characters, alphanumeric.
When using QR-IBAN, this element must be filled with the QR Reference. When using IBAN and referenceType SCOR, this element must be filled with the Creditor Reference. When using IBAN and referenceType NON, this element is not permitted to be filled.
Unstructured message
Credit account of the invoice issuer (IBAN or QR-IBAN). See also ISO 13616-1. The usage of IBAN or QR-IBAN is only permitted with country codes CH or LI and 21 alphanumeric characters.
Example: CH9300762011623852957 LI21088100002324013AA
Must contain country code CH or LI, otherwise the business case will be denied. Must be matching with a credit account that is specified in the infrastructure in the master data of the invoice issuer, otherwise the business case will be denied.
The amount of the business case (amount incl. VAT + currency code, e.g. CHF 1183.46). Must be matching with the total amount (totalAmount), if business case is an invoice, reminder or donation inquiry.
Due date. In the case of donation inquiries, the due date acts as a proposal for the payment date.
At time of submission, cannot be set to more than 3 years in the future (1095 days) for payment mode ebill. At time of submission, cannot be set to more than 30 days in the future for payment mode ebill debit. At time of submission, cannot be older than 90 days.
https://app.dibito.ch/api/v1/examples/credit-note
curl -i -X GET \
'https://app.dibito.ch/api/v1/examples/credit-note?recipientEmail=string' \
-H 'X-API-Key: YOUR_API_KEY_HERE'OK
The amount of the business case (amount incl. VAT + currency code, e.g. CHF 1183.46). Must be matching with the total amount (totalAmount), if business case is an invoice, reminder or donation inquiry.
https://app.dibito.ch/api/v1/examples/credit-note-with-workflow
curl -i -X GET \
'https://app.dibito.ch/api/v1/examples/credit-note-with-workflow?recipientEmail=string' \
-H 'X-API-Key: YOUR_API_KEY_HERE'OK
The amount of the business case (amount incl. VAT + currency code, e.g. CHF 1183.46). Must be matching with the total amount (totalAmount), if business case is an invoice, reminder or donation inquiry.
https://app.dibito.ch/api/v1/examples/bill
curl -i -X GET \
'https://app.dibito.ch/api/v1/examples/bill?recipientEmail=string' \
-H 'X-API-Key: YOUR_API_KEY_HERE'OK
The amount of the business case (amount incl. VAT + currency code, e.g. CHF 1183.46). Must be matching with the total amount (totalAmount), if business case is an invoice, reminder or donation inquiry.
Information about the account and reference of the invoice issuer.
In case the account holder differs from the biller use this element to provide the account holder name and address.
Reference number, structured payment reference. Note: the reference is either a QR reference or creditor reference (ISO 11649).
QR Reference: 27 characters, numerical; check digit computation with Modulus 10 recursive (27th position of the reference).
Creditor Reference (ISO 11649): up to 25 characters, alphanumeric.
When using QR-IBAN, this element must be filled with the QR Reference. When using IBAN and referenceType SCOR, this element must be filled with the Creditor Reference. When using IBAN and referenceType NON, this element is not permitted to be filled.
Unstructured message
Credit account of the invoice issuer (IBAN or QR-IBAN). See also ISO 13616-1. The usage of IBAN or QR-IBAN is only permitted with country codes CH or LI and 21 alphanumeric characters.
Example: CH9300762011623852957 LI21088100002324013AA
Must contain country code CH or LI, otherwise the business case will be denied. Must be matching with a credit account that is specified in the infrastructure in the master data of the invoice issuer, otherwise the business case will be denied.
The amount of the business case (amount incl. VAT + currency code, e.g. CHF 1183.46). Must be matching with the total amount (totalAmount), if business case is an invoice, reminder or donation inquiry.
Due date. In the case of donation inquiries, the due date acts as a proposal for the payment date.
At time of submission, cannot be set to more than 3 years in the future (1095 days) for payment mode ebill. At time of submission, cannot be set to more than 30 days in the future for payment mode ebill debit. At time of submission, cannot be older than 90 days.
https://app.dibito.ch/api/v1/examples/bill-with-workflow
curl -i -X GET \
'https://app.dibito.ch/api/v1/examples/bill-with-workflow?recipientEmail=string' \
-H 'X-API-Key: YOUR_API_KEY_HERE'OK
The amount of the business case (amount incl. VAT + currency code, e.g. CHF 1183.46). Must be matching with the total amount (totalAmount), if business case is an invoice, reminder or donation inquiry.
Information about the account and reference of the invoice issuer.
In case the account holder differs from the biller use this element to provide the account holder name and address.
Reference number, structured payment reference. Note: the reference is either a QR reference or creditor reference (ISO 11649).
QR Reference: 27 characters, numerical; check digit computation with Modulus 10 recursive (27th position of the reference).
Creditor Reference (ISO 11649): up to 25 characters, alphanumeric.
When using QR-IBAN, this element must be filled with the QR Reference. When using IBAN and referenceType SCOR, this element must be filled with the Creditor Reference. When using IBAN and referenceType NON, this element is not permitted to be filled.
Unstructured message
Credit account of the invoice issuer (IBAN or QR-IBAN). See also ISO 13616-1. The usage of IBAN or QR-IBAN is only permitted with country codes CH or LI and 21 alphanumeric characters.
Example: CH9300762011623852957 LI21088100002324013AA
Must contain country code CH or LI, otherwise the business case will be denied. Must be matching with a credit account that is specified in the infrastructure in the master data of the invoice issuer, otherwise the business case will be denied.
The amount of the business case (amount incl. VAT + currency code, e.g. CHF 1183.46). Must be matching with the total amount (totalAmount), if business case is an invoice, reminder or donation inquiry.
Due date. In the case of donation inquiries, the due date acts as a proposal for the payment date.
At time of submission, cannot be set to more than 3 years in the future (1095 days) for payment mode ebill. At time of submission, cannot be set to more than 30 days in the future for payment mode ebill debit. At time of submission, cannot be older than 90 days.
https://app.dibito.ch/api/v1/examples/advice
curl -i -X GET \
'https://app.dibito.ch/api/v1/examples/advice?recipientEmail=string' \
-H 'X-API-Key: YOUR_API_KEY_HERE'OK
The amount of the business case (amount incl. VAT + currency code, e.g. CHF 1183.46). Must be matching with the total amount (totalAmount), if business case is an invoice, reminder or donation inquiry.
https://app.dibito.ch/api/v1/examples/advice-with-workflow
curl -i -X GET \
'https://app.dibito.ch/api/v1/examples/advice-with-workflow?recipientEmail=string' \
-H 'X-API-Key: YOUR_API_KEY_HERE'OK
The amount of the business case (amount incl. VAT + currency code, e.g. CHF 1183.46). Must be matching with the total amount (totalAmount), if business case is an invoice, reminder or donation inquiry.