Skip to content

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.
Please refer to the API tutorial for your first eBill submission.

API 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".

Top level overview

  • Create bills by posting either a QR-Invoice as PDF to the /v1/business-cases` endpoint or a fully populated JSON object to one of the business case type endpoints.
  • If the request succeeds, it passed validation and can be delivered to the eBill recipients.
  • Use the webhook endpoints to be notified about changes to your recipient subscriptions or business case statuses.

Referencing existing bills

If you pass one of the reference parameters or fill in the referenced bills section in your business case, the submitted eBill will:
  • In case of a reminder: Add a reminder to the eBill portal of the reciepient for the referenced bill.
  • In case of a donation inquiry: Will do nothing. Donation inquiries cannot be referenced.
  • In any other case: Replace the referenced bill with the new one in the eBill portal of the recipient. (Hint: Use advices to effectively cancel delivered eBills.)

Product Website

https://www.dibito.ch

Further Informations

Consult our documentation for further informations about creating and handling eBills.
Download OpenAPI description
api-docs.json
api-docs.yaml
Overview
URL

https://www.codeblock.ch

Codeblock GmbH

contact@codeblock.ch

Languages
Servers
Generated server url

https://app.dibito.ch/

00 Examples

Operations

10 Business Cases

Operations

20 Bill Recipients

Operations

21 Bill-Recipient Subscriptions

Operations

30 Events

Operations

31 SIX Events

Operations

40 Webhook Management

Operations

Create a webhook

Request

Create a new webhook for a specified type of event. The webhook will instantaneously become active and receive events. See the webhook definitions in the Webhooks section

Security
X-API-Key
Bodyapplication/jsonrequired
idinteger(int32)
eventTypestring
Enum"SUBSCRIPTION_STATUS_CHANGED_EVENTS""BILL_RECIPIENT_EMAIL_ADDRESS_CHANGED_EVENTS""BUSINESS_CASE_STATUS_CHANGED_EVENTS""INSTALMENT_STATUS_CHANGED_EVENTS""PROCESSING_STATUS_CHANGED_EVENTS"
hookUrlstring
curl -i -X POST \
  https://app.dibito.ch/api/v1/webhook/events \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "id": 0,
    "eventType": "SUBSCRIPTION_STATUS_CHANGED_EVENTS",
    "hookUrl": "string"
  }'

Responses

OK

Body*/*
idinteger(int32)
eventTypestring
Enum"SUBSCRIPTION_STATUS_CHANGED_EVENTS""BILL_RECIPIENT_EMAIL_ADDRESS_CHANGED_EVENTS""BUSINESS_CASE_STATUS_CHANGED_EVENTS""INSTALMENT_STATUS_CHANGED_EVENTS""PROCESSING_STATUS_CHANGED_EVENTS"
hookUrlstring

Get all webhooks

Request

Get all webhooks for this biller

Security
X-API-Key
curl -i -X GET \
  https://app.dibito.ch/api/v1/webhook \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

OK

Body*/*Array [
idinteger(int32)
eventTypestring
Enum"SUBSCRIPTION_STATUS_CHANGED_EVENTS""BILL_RECIPIENT_EMAIL_ADDRESS_CHANGED_EVENTS""BUSINESS_CASE_STATUS_CHANGED_EVENTS""INSTALMENT_STATUS_CHANGED_EVENTS""PROCESSING_STATUS_CHANGED_EVENTS"
hookUrlstring
]

Delete webhook

Request

Delete an existing webhook

Security
X-API-Key
Query
webhookIdinteger(int32)required

Webhook ID

curl -i -X DELETE \
  'https://app.dibito.ch/api/v1/webhook?webhookId=0' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

OK

90 PDF

Operations

98 Health Check

Operations

99 Authentication

Operations

webhooks

Webhooks

endpoint-controller

Operations