Adyen assignTerminals API

openapi: 3.2.0
info:
  version: '1'
  x-publicVersion: true
  title: Adyen POS Terminal Management Assign Terminals API
  description: This API provides endpoints for managing your point-of-sale (POS) payment terminals. You can use the API to obtain information about a specific terminal, retrieve overviews of your terminals and stores, and assign terminals to a merchant account or store.
  termsOfService: https://www.adyen.com/legal/terms-and-conditions
  contact:
    name: Adyen Developer Experience team
    url: https://github.com/Adyen/adyen-openapi
servers:
- url: https://postfmapi-test.adyen.com/postfmapi/terminal/v1
tags:
- name: assignTerminals
paths:
  /assignTerminals:
    post:
      tags:
      - assignTerminals
      summary: Adyen Assign Terminals
      description: Assigns one or more payment terminals to a merchant account or a store. You can also use this endpoint to reassign terminals between merchant accounts or stores, and to unassign a terminal and return it to company inventory.
      operationId: post-assignTerminals
      x-sortIndex: 1
      x-methodName: assignTerminals
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      requestBody:
        content:
          application/json:
            examples:
              assignTerminalCompany:
                $ref: '#/components/examples/post-assignTerminals-assignTerminalCompany'
              assignTerminalMerchant:
                $ref: '#/components/examples/post-assignTerminals-assignTerminalMerchant'
              assignTerminalStore:
                $ref: '#/components/examples/post-assignTerminals-assignTerminalStore'
            schema:
              $ref: '#/components/schemas/AssignTerminalsRequest'
      responses:
        '200':
          content:
            application/json:
              examples:
                assignTerminalCompany:
                  $ref: '#/components/examples/post-assignTerminals-assignTerminalCompany-200'
                assignTerminalMerchant:
                  $ref: '#/components/examples/post-assignTerminals-assignTerminalMerchant-200'
                assignTerminalStore:
                  $ref: '#/components/examples/post-assignTerminals-assignTerminalStore-200'
              schema:
                $ref: '#/components/schemas/AssignTerminalsResponse'
          description: OK - the request has succeeded.
        '400':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-400'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Bad Request - a problem reading or understanding the request.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
              examples:
                post-assignTerminals401Example:
                  summary: Default post-assignTerminals 401 response
                  x-microcks-default: true
                  value:
                    errorCode: CODE123
                    errorType: standard
                    message: example_value
                    pspReference: REF-001
                    status: 500
          description: Unauthorized - authentication required.
        '403':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-403'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Forbidden - insufficient permissions to process the request.
        '422':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-422'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Unprocessable Entity - a request validation error.
        '500':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-500'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Internal Server Error - the server could not process the request.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  examples:
    post-assignTerminals-assignTerminalCompany-200:
      summary: Example response for request 'assignTerminalCompany'
      value:
        results:
          P400Plus-275479597: RemoveConfigScheduled
    post-assignTerminals-assignTerminalStore:
      summary: Assign a terminal to a store
      description: Assign one or more terminals to the specified store.
      value:
        companyAccount: YOUR_COMPANY_ACCOUNT
        merchantAccount: YOUR_MERCHANT_ACCOUNT
        store: YOUR_STORE
        terminals:
        - P400Plus-275479597
    post-assignTerminals-assignTerminalCompany:
      summary: Assign a terminal to the company inventory
      description: Assign one or more terminals to the inventory of the company account.
      value:
        companyAccount: YOUR_COMPANY_ACCOUNT
        terminals:
        - P400Plus-275479597
    generic-500:
      summary: Response code 500. Internal server error.
      value:
        status: 500
        errorCode: '000'
        message: The server could not process the request.
        errorType: internal
    post-assignTerminals-assignTerminalStore-200:
      summary: Example response for request 'assignTerminalStore'
      value:
        results:
          P400Plus-275479597: RemoveConfigScheduled
    generic-403:
      summary: Response code 403. Forbidden.
      value:
        status: 403
        errorCode: '010'
        message: Insufficient permissions to process the request.
        errorType: security
    generic-422:
      summary: Response code 422. Unprocessable entity.
      value:
        status: 422
        errorCode: '901'
        message: Request validation error.
        errorType: validation
    post-assignTerminals-assignTerminalMerchant:
      summary: Assign a terminal to the inventory of a merchant account
      description: Assign one or more terminals to the inventory of the merchant account.
      value:
        companyAccount: YOUR_COMPANY_ACCOUNT
        merchantAccount: YOUR_MERCHANT_ACCOUNT
        merchantInventory: true
        terminals:
        - P400Plus-275479597
    generic-400:
      summary: Response code 400. Bad request.
      value:
        status: 400
        errorCode: '702'
        message: Problem reading or understanding the request.
        errorType: validation
    post-assignTerminals-assignTerminalMerchant-200:
      summary: Example response for request 'assignTerminalMerchant'
      value:
        results:
          P400Plus-275479597: RemoveConfigScheduled
  schemas:
    AssignTerminalsResponse:
      properties:
        results:
          additionalProperties:
            type: string
          description: "Array that returns a list of the terminals, and for each terminal the result of assigning it to an account or store.\n\nThe results can be: \n\n - `Done`: The terminal has been assigned.\n\n - `AssignmentScheduled`: The terminal will be assigned asynschronously.\n\n - `RemoveConfigScheduled`: The terminal was previously assigned and boarded. Wait for the terminal to synchronize with the Adyen platform. For more information, refer to [Reassigning boarded\nterminals](https://docs.adyen.com/point-of-sale/managing-terminals/assign-terminals#reassign-boarded-terminals).\n\n - `Error`: There was an error when assigning the terminal. "
          type: object
      required:
      - results
      type: object
    ServiceError:
      properties:
        errorCode:
          description: The error code mapped to the error message.
          type: string
        errorType:
          description: The category of the error.
          type: string
        message:
          description: A short explanation of the issue.
          type: string
        pspReference:
          description: The PSP reference of the payment.
          type: string
        status:
          description: The HTTP response status.
          format: int32
          type: integer
      type: object
    AssignTerminalsRequest:
      properties:
        companyAccount:
          description: Your company account. To return terminals to the company inventory, specify only this parameter and the `terminals`.
          type: string
        merchantAccount:
          description: Name of the merchant account. Specify this parameter to assign terminals to this merchant account or to a store under this merchant account.
          type: string
        merchantInventory:
          description: 'Boolean that indicates if you are assigning the terminals to the merchant inventory. Do not use when assigning terminals to a store. Required when assigning the terminal to a merchant account.


            - Set this to **true** to assign the terminals to the merchant inventory. This also means that the terminals cannot be boarded.


            - Set this to **false** to assign the terminals to the merchant account as in-store terminals. This makes the terminals ready to be boarded and to process payments through the specified merchant account.'
          type: boolean
        store:
          description: The store code of the store that you want to assign the terminals to.
          type: string
        terminals:
          description: 'Array containing a list of terminal IDs that you want to assign or reassign to the merchant account or store, or that you want to return to the company inventory.


            For example, `["V400m-324689776","P400Plus-329127412"]`.'
          items:
            type: string
          type: array
      required:
      - companyAccount
      - terminals
      type: object
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: X-API-Key
      type: apiKey
    BasicAuth:
      scheme: basic
      type: http