Adyen Login API

openapi: 3.2.0
info:
  version: '1'
  title: Adyen Terminal Login 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: Login
paths:
  /login:
    post:
      description: It conveys Information related to the session (period between a Login and the following Logout) to process. Content of the Login Request message.
      summary: Adyen Login Request
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LoginRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoginResponse'
              examples:
                operation200Example:
                  summary: Default operation 200 response
                  x-microcks-default: true
                  value:
                    Response: example_value
                    POISystemData: example_value
                    TokenRequestStatus: true
                    CustomerOrderStatus: true
          description: It conveys Information related to the Login to process. Content of the Login Response message.
      tags:
      - Login
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    CashHandlingDevice:
      type: object
      description: Indicate the status and the remaining coins and bill in a cash handling device. Status of cash handling device.
      properties:
        CashHandlingOKFlag:
          type: boolean
          description: Indicates if the cash handling device is working and usable.
        Currency:
          type: string
          pattern: ^[A-Z]{3,3}$
          description: Currency of a monetary amount.
        CoinsOrBills:
          type: array
          items:
            $ref: '#/components/schemas/CoinsOrBills'
      required:
      - CashHandlingOKFlag
      - Currency
      - CoinsOrBills
    PrinterStatus:
      type: string
      enum:
      - NoPaper
      - OK
      - OutOfOrder
      - PaperJam
      - PaperLow
    POICapabilities:
      type: array
      items:
        type: string
        enum:
        - CashHandling
        - CashierDisplay
        - CashierError
        - CashierInput
        - CustomerDisplay
        - CustomerError
        - CustomerInput
        - EMVContactless
        - ICC
        - MagStripe
        - PrinterDocument
        - PrinterReceipt
        - PrinterVoucher
    CustomerOrderReq:
      type: array
      items:
        type: string
        enum:
        - Both
        - Closed
        - Open
    POISystemData:
      type: object
      properties:
        DateTime:
          type: string
          format: date-time
        POISoftware:
          $ref: '#/components/schemas/POISoftware'
        POITerminalData:
          $ref: '#/components/schemas/POITerminalData'
        POIStatus:
          $ref: '#/components/schemas/POIStatus'
      required:
      - DateTime
      - POISoftware
    TerminalEnvironment:
      type: string
      enum:
      - Attended
      - SemiAttended
      - Unattended
    POIStatus:
      type: object
      description: Indicate the availability of the POI Terminal components. The data element is absent if the component is not part of the POI Terminal. State of a POI Terminal.
      properties:
        GlobalStatus:
          $ref: '#/components/schemas/GlobalStatus'
        SecurityOKFlag:
          type: boolean
          description: If security module present.
        PEDOKFlag:
          type: boolean
          description: If PED present.
        CardReaderOKFlag:
          type: boolean
          description: If card reader device present.
        PrinterStatus:
          $ref: '#/components/schemas/PrinterStatus'
        CommunicationOKFlag:
          type: boolean
          description: If communication infrastructure present.
        CashHandlingDevice:
          type: array
          items:
            $ref: '#/components/schemas/CashHandlingDevice'
        FraudPreventionFlag:
          type: boolean
          description: default False.
      required:
      - GlobalStatus
    ErrorCondition:
      type: string
      enum:
      - Aborted
      - Busy
      - Cancel
      - DeviceOut
      - InProgress
      - InsertedCard
      - InvalidCard
      - LoggedOut
      - MessageFormat
      - NotAllowed
      - NotFound
      - PaymentRestriction
      - Refusal
      - UnavailableDevice
      - UnavailableService
      - UnreachableHost
      - WrongPIN
    POITerminalData:
      type: object
      properties:
        TerminalEnvironment:
          $ref: '#/components/schemas/TerminalEnvironment'
        POICapabilities:
          $ref: '#/components/schemas/POICapabilities'
        POIProfile:
          $ref: '#/components/schemas/POIProfile'
        POISerialNumber:
          type: string
          pattern: ^.+$
      required:
      - TerminalEnvironment
      - POICapabilities
      - POISerialNumber
    Result:
      type: string
      enum:
      - Failure
      - Partial
      - Success
    POIProfile:
      type: object
      properties:
        GenericProfile:
          $ref: '#/components/schemas/GenericProfile'
        ServiceProfiles:
          $ref: '#/components/schemas/ServiceProfiles'
    CoinsOrBills:
      type: object
      description: Indicates the remaining number of coins or bills of a given value in a cash handling device. When the cash handling machine does not have any more coins or bills of a certain value, the number must be equal to 0. Number of coins or bills of a given value.
      properties:
        UnitValue:
          type: number
          maximum: 99999999.999999
          minimum: 0
          description: Value of a coin or bill.
        Number:
          type: integer
          description: Number of elements.
      required:
      - UnitValue
      - Number
    POISoftware:
      type: object
      properties:
        ManufacturerID:
          type: string
          pattern: ^.+$
        ApplicationName:
          type: string
          pattern: ^.+$
        SoftwareVersion:
          type: string
          pattern: ^.+$
        CertificationCode:
          type: string
          pattern: ^.+$
      required:
      - ManufacturerID
      - ApplicationName
      - SoftwareVersion
      - CertificationCode
    LoginResponse:
      type: object
      description: It conveys Information related to the Login to process. Content of the Login Response message.
      properties:
        Response:
          $ref: '#/components/schemas/Response'
        POISystemData:
          $ref: '#/components/schemas/POISystemData'
        TokenRequestStatus:
          type: boolean
        CustomerOrderStatus:
          type: boolean
      required:
      - Response
    GlobalStatus:
      type: string
      enum:
      - Busy
      - Maintenance
      - OK
      - Unreachable
    TokenRequestedType:
      type: string
      enum:
      - Customer
      - Transaction
    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
    ServiceProfiles:
      type: array
      items:
        type: string
        enum:
        - Batch
        - CardReader
        - Communication
        - Loyalty
        - OneTimeRes
        - PIN
        - Reservation
        - Sound
        - StoredValue
        - Synchro
    GenericProfile:
      type: string
      enum:
      - Basic
      - Extended
      - Standard
    SaleSoftware:
      type: object
      description: Information related to the software of the Sale System which manages the NEXO Sale to POI protocol.
      properties:
        ManufacturerID:
          type: string
          pattern: ^.+$
        ApplicationName:
          type: string
          pattern: ^.+$
        SoftwareVersion:
          type: string
          pattern: ^.+$
        CertificationCode:
          type: string
          pattern: ^.+$
      required:
      - ManufacturerID
      - ApplicationName
      - SoftwareVersion
      - CertificationCode
    SaleTerminalData:
      type: object
      description: In the Login Request, if a Sale Terminal is involved in the login. In other messages, when a logical device is out of order (SaleCapabilites), or when the other data have changed since or were not in the Login. Information related to the software and hardware feature of the Sale Terminal.
      properties:
        TotalsGroupID:
          type: string
          pattern: ^.{1,16}$
          description: If present, default value for all transaction.
    LoginRequest:
      type: object
      description: It conveys Information related to the session (period between a Login and the following Logout) to process. Content of the Login Request message.
      properties:
        DateTime:
          type: string
          format: date-time
          description: Date and Time.
        SaleSoftware:
          $ref: '#/components/schemas/SaleSoftware'
        SaleTerminalData:
          $ref: '#/components/schemas/SaleTerminalData'
        TrainingModeFlag:
          type: boolean
          default: false
          description: The POI does not realise the transaction with the Acquirer.
        OperatorLanguage:
          type: string
          pattern: ^[a-z]{2,2}$
          description: Default value for Device type displays.
        OperatorID:
          type: string
          pattern: ^.+$
          description: '4 conditions to send it: a) the Sale System wants the POI log it in the transaction log b) because of reconciliation.'
        ShiftNumber:
          type: string
          pattern: ^.+$
          description: Same as OperatorID.
        TokenRequestedType:
          $ref: '#/components/schemas/TokenRequestedType'
        CustomerOrderReq:
          $ref: '#/components/schemas/CustomerOrderReq'
        POISerialNumber:
          type: string
          pattern: ^.+$
          description: If the login involve a POI Terminal and not the first Login to the POI System.
      required:
      - DateTime
      - SaleSoftware
      - OperatorLanguage
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: X-API-Key
      type: apiKey
    BasicAuth:
      scheme: basic
      type: http