Redemption & card charge via incert Public API

The following content was translated using AI and reviewed by our team. Please note that some images are still being updated.

Incert provides a JSON/REST-based interface with the incert Public API for integration by external system partners (e.g. POS system or booking engine). The API offers various functions, for example for redeeming vouchers or loading pre-printed cards. 

If you are interested, please contact sales@incert.at 

This Help Center article was generated using automated AI translation. Content may contain minor linguistic or factual inaccuracies. Please review carefully and refer to the original version or contact our support team if in doubt.

Documentation

  • Documentation (process guideline & Swagger documentation) can be provided after an initial alignment.
  • Approval by incert is required prior to go-live.

Use cases & systems

  Use cases to be implemented
POS / Cash register system
  • Status request
  • Voucher redemption as a means of payment
  • Cancellation (reversal) of a redemption
  • Loading (sale) of a pre-printed card
  • Cancellation of a card load
Online booking / IBE
  • Status request
  • Voucher redemption as a means of payment
  • Reversal of a redemption (in case of booking cancellation)

This page describes general requirements and provides an overview of the API communication. Depending on the system being integrated (POS, booking engine, etc.), we can provide more detailed implementation requirements and recommendations upon request.

Status request & redemption

General requirements

  • The voucher status code determines redeemability (only status 1 means "redeemable"). For all other statuses (see documentation), meaningful error messages should be displayed.
  • Validity date, payment date, voucher type, etc. are provided for informational purposes only. No redemption logic should be based on them. Redeemability is controlled by incert via the status (according to customer settings).
  • A receipt must be payable using one or more vouchers, or via a mixed payment method (e.g. remaining amount via credit card if the voucher value is not sufficient). Redemptions should only be transmitted at invoice or booking completion.
  • Voucher redemption is treated like a payment method and must not reduce VAT of the charged items.
  • If a receipt or booking paid via voucher is cancelled, the applied voucher redemptions must be automatically reversed.
  • API credentials must be storable per property (hotel, branch, location, etc.) and a unique workstation ID (e.g. POS ID) must be provided.
  • Sponsored vouchers may exist with or without value. Vouchers with 0 EUR must be redeemable at the POS. The value equivalent is checked manually by staff (e.g. by entering the amount to be deducted). In this case 0€ must still be sent to incert for redemption.
    For online redemption or self-service terminals a 0 EUR voucher redemption is not allowed and must be blocked.

Processes

The table below shows a simplified overview of request and response. Please refer to the Swagger documentation for complete parameter details.

  Request Response
Status request
  • Voucher code to be checked
  • Status (defines redeemability) and partial redeemability
  • Current value (and currency)
  • Informational details such as product name, purchase and validity date, redemption history, etc.
Redemption
  • Voucher code to be redeemed
  • Redemption amount (and currency)
  • Workstation for statistical assignment in incert
  • Redeemed amount
  • Redemption ID (required for cancellation)
Redemption cancellation
  • ID of the redemption to be cancelled
  • Success of cancellation
  • New remaining balance

Card loading

General requirements

  • Value cards are a specific type of voucher which can be topped up.
  • Value cards can be loaded with any amount entered at the POS. Upper and lower limits can be defined in incert.
  • Value cards are handled in the POS as items and can be checked out using any available payment method.
  • Depending on the incert configuration, value cards can be reloaded multiple times via the POS.
  • If a value card purchase is reversed at the POS (purchase cancelled), the cancellation of the card loading must be transmitted automatically to incert.

Processes

The table below shows a simplified overview of request and response. Please refer to the Swagger documentation for complete parameter details.

  Request Response
Card loading 
  • Card code to be loaded
  • Amount to be loaded (and currency)
  • Workstation for statistical assignment in incert
  • Loaded card code
  • Loading ID
  • Current balance
Card loading cancellation
  • Card code
  • ID of the loading to be cancelled
  • Success of the cancellation
  • New remaining balance

 

 

Was this article helpful?

0 out of 0 found this helpful