fiskaltrust Receipt API (1.0)
Download OpenAPI specification:Download
fiskaltrust provides a feature richt digital receipt implementation.
Receipt visualization can be used by everyone free of charge, simply following the receipt-url.
Sharing and Matching enables 3rd party apps to integrate with millions of receipts a day, processed by fiskaltrust.
API design principles
The Receipt API was designed in a RESTful and follows those design principles. The API accepts JSON data and uses standard HTTP status codes for responses. The return types can be different depending on the calls. The default return type is either HTML or JSON
Authentication
The Receipt API can be used in three different modes. End-Users that are using one of the visualizations or features via fiskaltrust can use the features without authentication. While we also allow third party applications to use most of the endpoints without actual authentication, applications must add an additional AppId header to each request. Raw data requests require the application to authenticate with `AppId` and `AppSecret`. Currently these credentials are invite-only so please reach out to hello@fiskaltrust.eu if you are interested.
Versioning
This API uses semantic versioning, meaning only major version changes contain breaking changes. Non-breaking changes (like returning additional data without changing the original model) will not increase the major version.
- The latest version is used if no version is specified (like in the samples in this collection).
- Users can specify versions by explicitly stating it in the URL once more versions are released.
With the endpoints for Visualize integrators can use the Receipt API to retrieve the Receipt in many different formats. Each call to one of these endpoints marks the receipt as accepted/viewed by the customer and gives the merchant the chance to have trace information on when the receipts have been received by their customers.
While integrators can make use of the digital receipt including the tracking of the customer retrieval without authentication, it is required that applications that are using the digital receipt visualization in one or the other form to add an additional Query Parameter AppId. This AppId can be requested via the fiskaltrust.Portal. When using endpoints with the AppId included the receipt is not marked as accepted/viewed.
Visualize Digital Receipt for Give Away
This endpoint returns the visualization for a receipt that has been linked to the Give Away. Calling this endpoint marks the receipt as accepted/viewed.
Visit example receipt
query Parameters
| c required | string <byte> Base64Url identifier |
| s1 | string <byte> signature with key number 1 |
| s2 | string <byte> signature with key number 2 |
| f | string <byte> featureset |
| mcc | string marketing campaign code. |
| AppId | string <uuid> When an |
Responses
Visualize the digital receipt
This endpoint returns the visualization for a receipt with the global unique identifier and marks the receipt as accepted/viewed (by human user). By using different values for the Accept header callers can retrieve different formats.
Visit a example receipt
path Parameters
| QueueId required | string <uuid> Example: 9330c645-e838-4b65-b77c-0ab6583d5e80 |
| QueueItemId required | string <uuid> Example: 8fb08828-3f08-4622-8ba7-363552a5a5c0 |
query Parameters
| AppId | string <uuid> When an |
Responses
Callbacks
Provides the link to the digital receipt as QRCode
Provides the link to the digital receipt as QRCode that can be scanned with a Smartphone to retrieve the digital receipt. This endpoint can be used by systems to easily visualize the link in a convenient form.
path Parameters
| QueueId required | string <uuid> |
| QueueItemId required | string <uuid> |
Responses
Provides the visualization of the digital receipt as `PNG`
This endpoint returns the PNG visualization for a receipt with the global unique identifier and marks the receipt as accepted/viewed (by human user). By using different values for the Accept header callers can retrieve different formats.
An example of an integration could be a HTML tag:
<img src="https://receipts-sandbox.fiskaltrust.eu/9330c645-e838-4b65-b77c-0ab6583d5e80/8fb08828-3f08-4622-8ba7-363552a5a5c0/png" />
path Parameters
| QueueId required | string <uuid> |
| QueueItemId required | string <uuid> |
query Parameters
| AppId | string <uuid> When an |
Responses
Provides the visualization of the digital receipt as `PDF`.
This endpoint returns the PDF visualization for a receipt with the global unique identifier and marks the receipt as accepted/viewed (by human user). By using different values for the Accept header callers can retrieve different formats.
Example PDF download
path Parameters
| QueueId required | string <uuid> |
| QueueItemId required | string <uuid> |
query Parameters
| AppId | string <uuid> When an |