This endpoint verifies the combination of subscription initiation token and activation code. If the combination is valid, it creates an active biller relation. Only the primary network partner of a biller is allowed to confirm the subscription at the biller initiation.
Dibito REST API (1.1)
The Dibito REST API provides services to submit, verify and deliver eBills. The API is designed to be used by biller integrations.
Product Website
https://www.dibito.chAPI Key
This API requires an API key to be passed in the `X-API-Key` header.Generate your API key in the Dibito application under "Dibito -> API Keys".
Further Informations
Consult our documentation for futher informations about creating and handling eBills.Download OpenAPI description
Overview
URL
Codeblock GmbH
Languages
Servers
Generated server url
https://app.dibito.ch/
- Generated server url
https://app.dibito.ch/api/v1/bill-recipient-subscriptions/initiations/{subscriptionInitiationToken}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://app.dibito.ch/api/v1/bill-recipient-subscriptions/initiations/{subscriptionInitiationToken}' \
-H 'Content-Type: application/json' \
-H 'X-API-Key: YOUR_API_KEY_HERE' \
-d '{
"activationCode": 123456
}'Bill recipient relation initiated
email address of the bill recipient
Example: "peter@muster.ch"
SIX ID of the bill recipient
Example: 41010560425610180
Swiss enterprise identification number (UID) without dashes, dots or extension. Note that this has to contain the swiss enterprise identification number (UID) from the commercial register (Handelsregister) which may be different from the VAT UID (Mehrwertsteuer UID).
Example: "CHE123456789"
last name, if private bill recipient company name, if company bill recipient
Example: "for private bill recipient: Muster, for company name: Muster AG"
first name, if private bill recipient empty, if company bill recipient
Example: "Peter"
language for correspondence with this bill recipient ISO-639-2/B
Example: "ger"
Response
application/json
{ "emailAddress": "peter@muster.ch", "billRecipientSixId": 41010560425610180, "enterpriseIdentificationNumber": "CHE123456789", "type": "PRIVATE", "name": "for private bill recipient: Muster, for company name: Muster AG", "firstName": "Peter", "correspondenceLanguage": "ger", "address": { "streetName": "Neustadtstrasse", "postalCode": 6025, "city": "Neudorf", "countryCode": "CH" } }
Request
This endpoint initiates the "Bill recipient driven subscription (Subscription at the biller)" process, returns a subscription initiation token to the caller and sends a verification code to the eBill subscribers email address. Only the primary network partner of a biller is allowed to initiate the subscription at the biller.
Security
X-API-Key
- Generated server url
https://app.dibito.ch/api/v1/bill-recipient-subscriptions/initiations
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://app.dibito.ch/api/v1/bill-recipient-subscriptions/initiations \
-H 'Content-Type: application/json' \
-H 'X-API-Key: YOUR_API_KEY_HERE' \
-d '{
"emailAddress": "hansmuster@muster.info"
}'Response
application/json
{ "subscriptionInitiationToken": "0dc2ff79-db4c-4635-a4aa-f93f36ab5dbf" }