Adyen Input API

openapi: 3.2.0
info:
  version: '1'
  title: Adyen Terminal Input API
  description: The Adyen Terminal API lets you make payments, issue refunds, collect shopper information, and perform other shopper-terminal interactions using a payment terminal supplied by Adyen.
servers:
- description: with cloud integration
  url: https://terminal-api-test.adyen.com/sync
- description: with cloud integration
  url: https://terminal-api-test.adyen.com/async
- description: with local-hosting
  url: <local-terminal-IP-address>
tags:
- name: Input
paths:
  /input:
    post:
      description: It conveys data to display and the way to process the display, and contains the complete content to display. In addition to the display on the Input Device, it might contain an operation (the DisplayOutput element) per Display Device type. Content of the Input Request message.
      summary: Adyen Input Request
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InputRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InputResponse'
              examples:
                operation200Example:
                  summary: Default operation 200 response
                  x-microcks-default: true
                  value:
                    OutputResult: example_value
                    InputResult: example_value
          description: It conveys the result of the input or the result of the outputs, parallel to the message request, except if response not required and absent. Content of the Input Response message.
      tags:
      - Input
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    Color:
      type: string
      enum:
      - Black
      - Blue
      - Cyan
      - Green
      - Magenta
      - Red
      - White
      - Yellow
    InputResult:
      type: object
      properties:
        Device:
          $ref: '#/components/schemas/Device'
        InfoQualify:
          $ref: '#/components/schemas/InfoQualify'
        Response:
          $ref: '#/components/schemas/Response'
        Input:
          $ref: '#/components/schemas/Input'
      required:
      - Device
      - InfoQualify
      - Response
    OutputText:
      type: object
      description: 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. Content of text message to display or print.
      properties:
        Text:
          type: string
        CharacterSet:
          type: integer
        Font:
          type: string
          pattern: ^.+$
        StartRow:
          type: integer
          minimum: 1
          maximum: 500
        StartColumn:
          type: integer
          minimum: 1
          maximum: 500
        Color:
          $ref: '#/components/schemas/Color'
        CharacterWidth:
          $ref: '#/components/schemas/CharacterWidth'
        CharacterHeight:
          $ref: '#/components/schemas/CharacterHeight'
        CharacterStyle:
          $ref: '#/components/schemas/CharacterStyle'
        Alignment:
          $ref: '#/components/schemas/Alignment'
        EndOfLineFlag:
          type: boolean
          default: true
      required:
      - Text
    PredefinedContent:
      type: object
      description: It conveys Information related to the predefined message. Reference of a predefined message to display or print.
      properties:
        ReferenceID:
          type: string
          pattern: ^.+$
          description: Identification of a predefined message to display or print.
        Language:
          type: string
          pattern: ^[a-z]{2,2}$
          description: Identification of a language.
      required:
      - ReferenceID
    InputData:
      type: object
      properties:
        Device:
          $ref: '#/components/schemas/Device'
        InfoQualify:
          $ref: '#/components/schemas/InfoQualify'
        InputCommand:
          $ref: '#/components/schemas/InputCommand'
        NotifyCardInputFlag:
          type: boolean
          default: false
        MaxInputTime:
          type: integer
        ImmediateResponseFlag:
          type: boolean
          default: false
        MinLength:
          type: integer
        MaxLength:
          type: integer
        MaxDecimalLength:
          type: integer
        WaitUserValidationFlag:
          type: boolean
          default: true
        DefaultInputString:
          type: string
          pattern: ^.+$
        DefaultLayoutString:
          type: string
          pattern: ^.+$
        StringMask:
          type: string
          pattern: ^.+$
        FromRightToLeftFlag:
          type: boolean
          default: false
        MaskCharactersFlag:
          type: boolean
          default: false
        BeepKeyFlag:
          type: boolean
          default: false
        GlobalCorrectionFlag:
          type: boolean
          default: false
        DisableCancelFlag:
          type: boolean
          default: false
        DisableCorrectFlag:
          type: boolean
          default: false
        DisableValidFlag:
          type: boolean
          default: false
        MenuBackFlag:
          type: boolean
          default: false
      required:
      - Device
      - InfoQualify
      - InputCommand
    ErrorCondition:
      type: string
      enum:
      - Aborted
      - Busy
      - Cancel
      - DeviceOut
      - InProgress
      - InsertedCard
      - InvalidCard
      - LoggedOut
      - MessageFormat
      - NotAllowed
      - NotFound
      - PaymentRestriction
      - Refusal
      - UnavailableDevice
      - UnavailableService
      - UnreachableHost
      - WrongPIN
    CharacterHeight:
      type: string
      enum:
      - DoubleHeight
      - HalfHeight
      - SingleHeight
    Device:
      type: string
      enum:
      - CashierDisplay
      - CashierInput
      - CustomerDisplay
      - CustomerInput
    OutputBarcode:
      type: object
      properties:
        BarcodeType:
          $ref: '#/components/schemas/BarcodeType'
        BarcodeValue:
          type: string
          pattern: ^.+$
      required:
      - BarcodeValue
    Result:
      type: string
      enum:
      - Failure
      - Partial
      - Success
    MenuEntryTag:
      type: string
      description: Characteristics related to the selection of a menu entry.
      enum:
      - NonSelectable
      - NonSelectableSubMenu
      - Selectable
      - SubMenu
    BarcodeType:
      type: string
      enum:
      - Code128
      - Code25
      - EAN13
      - EAN8
      - PDF417
      - QRCode
      - UPCA
    MenuEntry:
      type: object
      description: It conveys 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. An entryof the menu to present to the Cashier.
      properties:
        MenuEntryTag:
          $ref: '#/components/schemas/MenuEntryTag'
        DefaultSelectedFlag:
          type: boolean
          default: false
        OutputFormat:
          $ref: '#/components/schemas/OutputFormat'
        PredefinedContent:
          $ref: '#/components/schemas/PredefinedContent'
        OutputText:
          type: array
          items:
            $ref: '#/components/schemas/OutputText'
        OutputXHTML:
          type: string
          format: byte
          pattern: ^.+$
      required:
      - OutputFormat
    DisplayOutput:
      type: object
      description: It contains a complete display operation for a Display or an Input Device type. For the Input Devices, Diagnosis and EnableService, ResponseRequiredFlag and MinimumDisplayTime shall be absent. Information to display and the way to process the display.
      properties:
        ResponseRequiredFlag:
          type: boolean
          default: true
          description: Request of a message response.
        MinimumDisplayTime:
          type: integer
          minimum: 0
          maximum: 999
          default: 0
          description: Number of seconds the message has to be displayed.
        Device:
          $ref: '#/components/schemas/Device'
        InfoQualify:
          $ref: '#/components/schemas/InfoQualify'
        OutputContent:
          $ref: '#/components/schemas/OutputContent'
        MenuEntry:
          type: array
          items:
            $ref: '#/components/schemas/MenuEntry'
        OutputSignature:
          type: string
          format: byte
          pattern: ^.+$
          description: If protection has to be provided to the vendor on the text to display or print.
      required:
      - Device
      - InfoQualify
      - OutputContent
    CharacterStyle:
      type: string
      enum:
      - Bold
      - Italic
      - Normal
      - Underline
    Input:
      type: object
      properties:
        InputCommand:
          $ref: '#/components/schemas/InputCommand'
        ConfirmedFlag:
          type: boolean
        FunctionKey:
          type: integer
        TextInput:
          type: string
        DigitInput:
          type: integer
        Password:
          type: string
        MenuEntryNumber:
          type: array
          items:
            type: integer
      required:
      - InputCommand
    InputCommand:
      type: string
      enum:
      - DecimalString
      - DigitString
      - GetAnyKey
      - GetConfirmation
      - GetFunctionKey
      - GetMenuEntry
      - Password
      - SiteManager
      - TextString
    OutputResult:
      type: object
      description: In the message response, it contains the result of the output, if required in the message request. Information related to the result the output (display, print, input).
      properties:
        Device:
          $ref: '#/components/schemas/Device'
        InfoQualify:
          $ref: '#/components/schemas/InfoQualify'
        Response:
          $ref: '#/components/schemas/Response'
      required:
      - Device
      - InfoQualify
      - Response
    InfoQualify:
      type: string
      enum:
      - CustomerAssistance
      - Display
      - Document
      - Error
      - Input
      - POIReplication
      - Receipt
      - Sound
      - Status
      - Voucher
    InputResponse:
      type: object
      description: It conveys the result of the input or the result of the outputs, parallel to the message request, except if response not required and absent. Content of the Input Response message.
      properties:
        OutputResult:
          $ref: '#/components/schemas/OutputResult'
        InputResult:
          $ref: '#/components/schemas/InputResult'
      required:
      - InputResult
    InputRequest:
      type: object
      description: It conveys data to display and the way to process the display, and contains the complete content to display. In addition to the display on the Input Device, it might contain an operation (the DisplayOutput element) per Display Device type. Content of the Input Request message.
      properties:
        DisplayOutput:
          $ref: '#/components/schemas/DisplayOutput'
        InputData:
          $ref: '#/components/schemas/InputData'
      required:
      - InputData
    OutputContent:
      type: object
      description: This is a sequence of elements if they have different formats. Content to display or print.
      properties:
        OutputFormat:
          $ref: '#/components/schemas/OutputFormat'
        PredefinedContent:
          $ref: '#/components/schemas/PredefinedContent'
        OutputText:
          type: array
          items:
            $ref: '#/components/schemas/OutputText'
        OutputXHTML:
          type: string
          format: byte
          pattern: ^.{0,262144}$
          description: Mandatory, if OutputFormat is XHTML, not allowed otherwise.
        OutputBarcode:
          $ref: '#/components/schemas/OutputBarcode'
      required:
      - OutputFormat
    Response:
      type: object
      description: If Result is Success, ErrorCondition is absent or not used in the processing of the message. In the other cases, the ErrorCondition has to be present and can refine the processing of the message response. AdditionalResponse gives more information about the success or the failure of the message request processing, for logging without real time involvements. Result of a message request processing.
      properties:
        Result:
          $ref: '#/components/schemas/Result'
        ErrorCondition:
          $ref: '#/components/schemas/ErrorCondition'
        AdditionalResponse:
          type: string
          pattern: ^.+$
          description: If present, the POI logs it for further examination.
      required:
      - Result
    OutputFormat:
      type: string
      enum:
      - BarCode
      - MessageRef
      - Text
      - XHTML
    Alignment:
      type: string
      enum:
      - Centred
      - Justified
      - Left
      - Right
    CharacterWidth:
      type: string
      enum:
      - DoubleWidth
      - SingleWidth
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: X-API-Key
      type: apiKey
    BasicAuth:
      scheme: basic
      type: http