Pricing Templates
Log in Sign up
Integrations / Adyen Terminal / ...

POST /enableservice

It conveys the services that will be enabled for the POI Terminal without the request of the Sale System, and a possible invitation for the Customer to start the services. Content of the Enable Service Request message.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
TransactionAction String Yes

Action to realise on a transaction. In an EnableService request message:

  • Starts a transaction by a swipe-ahead mechanism, with the services which are enabled.
  • Aborts a swipe-ahead transaction or started by a CardAcquisition, and not followed by a service request from the Sale System to complete the transaction. Possible values:
  • AbortTransaction
  • StartTransaction

Possible values:

  • "AbortTransaction"
  • "StartTransaction"
DisplayOutput Object No

Information to display and the way to process the display.
DisplayOutput.InfoQualify String Yes

Qualification of the information to sent to an output logical device, to display or print to the Cashier or the Customer. Allows the manager of the device, Sale or POI Terminal, to send the information to a particular physical device or to present the information accordingly. Possible values:

  • CustomerAssistance
  • Display
  • Document
  • Error
  • Input
  • POIReplication
  • Receipt
  • Sound
  • Status
  • Voucher

Possible values:

  • "CustomerAssistance"
  • "Receipt"
  • "POIReplication"
  • "Error"
  • "Input"
  • "Status"
  • "Document"
  • "Sound"
  • "Voucher"
  • "Display"
DisplayOutput.ResponseRequiredFlag Boolean No

Indicates if the message response is required.

Default value: true
DisplayOutput.MinimumDisplayTime Integer No

Number of seconds the message has to be displayed.

Default value: 0
DisplayOutput.MenuEntry[] Array No

An entry of the menu to present to the Cashier. It conveys the message text and parameters of the menu entry. This output data could be only provided for an input command, in order to choose an entryof the menu.
DisplayOutput.MenuEntry[].DefaultSelectedFlag Boolean No

Selection of a menu entry to be displayed. In Input request message, it allows selection of one or several menu entries before any user action.

Default value: false
DisplayOutput.MenuEntry[].PredefinedContent Object No

Reference of a predefined message to display or print. It conveys information related to the predefined message.
DisplayOutput.MenuEntry[].PredefinedContent.Language String No

Identification of a language.
DisplayOutput.MenuEntry[].PredefinedContent.ReferenceID String Yes

Identification of a predefined message to display or print.
DisplayOutput.MenuEntry[].MenuEntryTag String No

Characteristics related to the selection of a menu entry. Possible values:

  • NonSelectable
  • NonSelectableSubMenu
  • Selectable
  • SubMenu

Possible values:

  • "NonSelectable"
  • "Selectable"
  • "NonSelectableSubMenu"
  • "SubMenu"
DisplayOutput.MenuEntry[].OutputText[] Array No

Content of text message to display or print. It conveys Information related to the content of the text message and its format. All the data elements related to the format of the text to display or print are parameters valid for the whole Text content.
DisplayOutput.MenuEntry[].OutputText[].EndOfLineFlag Boolean No

Indicates if the text is at the end of a line. Allows the display or the print of a new line and a carry-over return characters after the formatted text.

Default value: true
DisplayOutput.MenuEntry[].OutputText[].Text String Yes

Content of text message to display, print or play.
DisplayOutput.MenuEntry[].OutputText[].Font String No

Name of the font. Used to change character font of the output, as agreed between the POI and Sale Systems.
DisplayOutput.MenuEntry[].OutputText[].CharacterHeight String No

Character height of the text string to display or print. Absence of this data element means the characters have normal height. Possible values:

  • DoubleHeight
  • HalfHeight
  • SingleHeight

Possible values:

  • "HalfHeight"
  • "SingleHeight"
  • "DoubleHeight"
DisplayOutput.MenuEntry[].OutputText[].Alignment String No

Alignment of the text string on the display line or print line. Absence of this data element means the characters have normal alignment. Possible values:

  • Centred
  • Justified
  • Left
  • Right

Possible values:

  • "Right"
  • "Justified"
  • "Left"
  • "Centred"
DisplayOutput.MenuEntry[].OutputText[].StartColumn Integer No

Column where the text string has to be displayed or printed.
DisplayOutput.MenuEntry[].OutputText[].CharacterSet Integer No

Character height of the text string to display or print. Absence of this data element means the characters have normal height.
DisplayOutput.MenuEntry[].OutputText[].StartRow Integer No

Row where the text string has to be displayed or printed.
DisplayOutput.MenuEntry[].OutputText[].CharacterWidth String No

Character width of the text string to display or print. Absence of this data element means the characters have normal width. Possible values:

  • DoubleWidth
  • SingleWidth

Possible values:

  • "SingleWidth"
  • "DoubleWidth"
DisplayOutput.MenuEntry[].OutputText[].CharacterStyle String No

Typographic style of the sequence of characters to display or print. Absence of this data element means the characters have normal style. Possible values:

  • Bold
  • Italic
  • Normal
  • Underline

Possible values:

  • "Bold"
  • "Normal"
  • "Underline"
  • "Italic"
DisplayOutput.MenuEntry[].OutputText[].Color String No

Color of the text string to display or print. Possible values:

  • Black
  • Blue
  • Cyan
  • Green
  • Magenta
  • Red
  • White
  • Yellow

Possible values:

  • "Cyan"
  • "Green"
  • "Black"
  • "Red"
  • "Magenta"
  • "Yellow"
  • "Blue"
  • "White"
DisplayOutput.MenuEntry[].OutputXHTML String No

XHTML document body containing the message to display or print.
DisplayOutput.MenuEntry[].OutputFormat String Yes

Possible values:

  • BarCode
  • MessageRef
  • Text
  • XHTML

Possible values:

  • "MessageRef"
  • "Text"
  • "BarCode"
  • "XHTML"
DisplayOutput.OutputSignature String No

Vendor-specific signature of the text message to display or print. If protection has to be provided to the vendor on the text to display or print.
DisplayOutput.Device String Yes

Logical device located on a Sale Terminal or a POI Terminal, in terms of class of information to output (display, print, or store), or input (keyboard) for the Cashier or the Customer. Possible values:

  • CashierDisplay
  • CashierInput
  • CustomerDisplay
  • CustomerInput

Possible values:

  • "CashierDisplay"
  • "CustomerInput"
  • "CustomerDisplay"
  • "CashierInput"
DisplayOutput.OutputContent Object Yes

Content to display or print.
DisplayOutput.OutputContent.PredefinedContent Object No

Reference of a predefined message to display or print. Mandatory, if OutputFormat is MessageRef, not allowed otherwise.
DisplayOutput.OutputContent.PredefinedContent.Language String No

Identification of a language.
DisplayOutput.OutputContent.PredefinedContent.ReferenceID String Yes

Identification of a predefined message to display or print.
DisplayOutput.OutputContent.OutputBarcode Object No

Barcode content to display or print. Mandatory if OutputFormat is Barcode, not allowed otherwise.
DisplayOutput.OutputContent.OutputBarcode.BarcodeValue String Yes

Value with a Barcode coding. The barcode value to display or print.
DisplayOutput.OutputContent.OutputBarcode.BarcodeType String No

Type of Barcode coding. Qualification of the barcode value to display or print. Possible values:

  • Code128
  • Code25
  • EAN13
  • EAN8
  • PDF417
  • QRCode
  • UPCA

Possible values:

  • "QRCode"
  • "UPCA"
  • "Code25"
  • "EAN8"
  • "EAN13"
  • "Code128"
  • "PDF417"
DisplayOutput.OutputContent.OutputText[] Array No

Content of text message to display or print. Mandatory, if OutputFormat is Text, not allowed otherwise. One instance of OutputText per shared format.
DisplayOutput.OutputContent.OutputText[].EndOfLineFlag Boolean No

Indicates if the text is at the end of a line. Allows the display or the print of a new line and a carry-over return characters after the formatted text.

Default value: true
DisplayOutput.OutputContent.OutputText[].Text String Yes

Content of text message to display, print or play.
DisplayOutput.OutputContent.OutputText[].Font String No

Name of the font. Used to change character font of the output, as agreed between the POI and Sale Systems.
DisplayOutput.OutputContent.OutputText[].CharacterHeight String No

Character height of the text string to display or print. Absence of this data element means the characters have normal height. Possible values:

  • DoubleHeight
  • HalfHeight
  • SingleHeight

Possible values:

  • "HalfHeight"
  • "SingleHeight"
  • "DoubleHeight"
DisplayOutput.OutputContent.OutputText[].Alignment String No

Alignment of the text string on the display line or print line. Absence of this data element means the characters have normal alignment. Possible values:

  • Centred
  • Justified
  • Left
  • Right

Possible values:

  • "Right"
  • "Justified"
  • "Left"
  • "Centred"
DisplayOutput.OutputContent.OutputText[].StartColumn Integer No

Column where the text string has to be displayed or printed.
DisplayOutput.OutputContent.OutputText[].CharacterSet Integer No

Character height of the text string to display or print. Absence of this data element means the characters have normal height.
DisplayOutput.OutputContent.OutputText[].StartRow Integer No

Row where the text string has to be displayed or printed.
DisplayOutput.OutputContent.OutputText[].CharacterWidth String No

Character width of the text string to display or print. Absence of this data element means the characters have normal width. Possible values:

  • DoubleWidth
  • SingleWidth

Possible values:

  • "SingleWidth"
  • "DoubleWidth"
DisplayOutput.OutputContent.OutputText[].CharacterStyle String No

Typographic style of the sequence of characters to display or print. Absence of this data element means the characters have normal style. Possible values:

  • Bold
  • Italic
  • Normal
  • Underline

Possible values:

  • "Bold"
  • "Normal"
  • "Underline"
  • "Italic"
DisplayOutput.OutputContent.OutputText[].Color String No

Color of the text string to display or print. Possible values:

  • Black
  • Blue
  • Cyan
  • Green
  • Magenta
  • Red
  • White
  • Yellow

Possible values:

  • "Cyan"
  • "Green"
  • "Black"
  • "Red"
  • "Magenta"
  • "Yellow"
  • "Blue"
  • "White"
DisplayOutput.OutputContent.OutputXHTML String No

XHTML document body containing the message to display or print. Mandatory if OutputFormat is XHTML, not allowed otherwise.
DisplayOutput.OutputContent.OutputFormat String Yes

Format of the content to display or print. Possible values:

  • BarCode
  • MessageRef
  • Text
  • XHTML

Possible values:

  • "MessageRef"
  • "Text"
  • "BarCode"
  • "XHTML"
ServicesEnabled[] Array No

Services which are enabled before the start-up of a transaction. Mandatory if TransactionAction is StartTransaction, absent if not. Possible values:

  • CardAcquisition
  • Loyalty
  • Payment

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.
All third party trademarks (including logos and icons) are the property of their respective owners, which do not sponsor, authorize, or endorse this website.
Pricing Templates Integrations Blog Contact Us Help
© 2025 SimWorkflow
Terms of Service Privacy Policy