POST /print
Content of the Print Request message. It conveys the complete data to print and how to process the print.
Servers
- https://terminal-api-test.adyen.com/sync
- https://terminal-api-test.adyen.com/async
- <local-terminal-IP-address>
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 |
---|---|---|---|
PrintOutput |
Object | Yes |
Information to print and how to process it. |
PrintOutput.DocumentQualifier |
String | Yes |
Qualification of the document to print to the Cashier or the Customer. Allows the manager of the printer, Sale or POI Terminal, to send information to a physical printer or to use the paper type accordingly. Possible values:
Possible values:
|
PrintOutput.ResponseMode |
String | Yes |
Message response awaited by the initiator of the Request. Allows various types and synchronisation of requests for Print or Sound. Possible values:
Possible values:
|
PrintOutput.RequiredSignatureFlag |
Boolean | No |
Indicates that the cardholder payment receipt requires a physical signature by the Customer. Default value: false |
PrintOutput.OutputContent |
Object | Yes |
Content to display or print. This is a sequence of elements if they have different formats. |
PrintOutput.OutputContent.PredefinedContent |
Object | No |
Reference of a predefined message to display or print.
Mandatory, if |
PrintOutput.OutputContent.PredefinedContent.Language |
String | No |
Identification of a language. |
PrintOutput.OutputContent.PredefinedContent.ReferenceID |
String | Yes |
Identification of a predefined message to display or print. |
PrintOutput.OutputContent.OutputBarcode |
Object | No |
Barcode content to display or print.
Mandatory if |
PrintOutput.OutputContent.OutputBarcode.BarcodeValue |
String | Yes |
Value with a Barcode coding. The barcode value to display or print. |
PrintOutput.OutputContent.OutputBarcode.BarcodeType |
String | No |
Type of Barcode coding. Qualification of the barcode value to display or print. Possible values:
Possible values:
|
PrintOutput.OutputContent.OutputText[] |
Array | No |
Content of text message to display or print.
Mandatory, if |
PrintOutput.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 |
PrintOutput.OutputContent.OutputText[].Text |
String | Yes |
Content of text message to display, print or play. |
PrintOutput.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. |
PrintOutput.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:
Possible values:
|
PrintOutput.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:
Possible values:
|
PrintOutput.OutputContent.OutputText[].StartColumn |
Integer | No |
Column where the text string has to be displayed or printed. |
PrintOutput.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. |
PrintOutput.OutputContent.OutputText[].StartRow |
Integer | No |
Row where the text string has to be displayed or printed. |
PrintOutput.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:
Possible values:
|
PrintOutput.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:
Possible values:
|
PrintOutput.OutputContent.OutputText[].Color |
String | No |
Color of the text string to display or print. Possible values:
Possible values:
|
PrintOutput.OutputContent.OutputXHTML |
String | No |
XHTML document body containing the message to display or print.
Mandatory if |
PrintOutput.OutputContent.OutputFormat |
String | Yes |
Format of the content to display or print. Possible values:
Possible values:
|
PrintOutput.IntegratedPrintFlag |
Boolean | No |
Type of the print integrated in other prints. Allows a separated printing (paper cut if available), or integration with the sale receipt or other print. If the printing is integrated, the response is always immediate, even if the Default value: false |
How to start integrating
- Add HTTP Task to your workflow definition.
- 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.
- Click Test request to test run your request to the API and see the API's response.