Adyen getTerminalsUnderAccount API

openapi: 3.2.0
info:
  version: '1'
  x-publicVersion: true
  title: Adyen POS Terminal Management Get Terminals Under Account 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: getTerminalsUnderAccount
paths:
  /getTerminalsUnderAccount:
    post:
      tags:
      - getTerminalsUnderAccount
      summary: Adyen Get the List of Terminals
      description: Returns a list of payment terminals associated with a company account, merchant account, or store. The response shows whether the terminals are in the inventory, or in-store (ready for boarding or already boarded).
      operationId: post-getTerminalsUnderAccount
      x-sortIndex: 1
      x-methodName: getTerminalsUnderAccount
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      requestBody:
        content:
          application/json:
            examples:
              getTerminalsCompany:
                $ref: '#/components/examples/post-getTerminalsUnderAccount-getTerminalsCompany'
              getTerminalsMerchant:
                $ref: '#/components/examples/post-getTerminalsUnderAccount-getTerminalsMerchant'
              getTerminalsStore:
                $ref: '#/components/examples/post-getTerminalsUnderAccount-getTerminalsStore'
            schema:
              $ref: '#/components/schemas/GetTerminalsUnderAccountRequest'
      responses:
        '200':
          content:
            application/json:
              examples:
                getTerminalsCompany:
                  $ref: '#/components/examples/post-getTerminalsUnderAccount-getTerminalsCompany-200'
                getTerminalsMerchant:
                  $ref: '#/components/examples/post-getTerminalsUnderAccount-getTerminalsMerchant-200'
                getTerminalsStore:
                  $ref: '#/components/examples/post-getTerminalsUnderAccount-getTerminalsStore-200'
              schema:
                $ref: '#/components/schemas/GetTerminalsUnderAccountResponse'
          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-getTerminalsUnderAccount401Example:
                  summary: Default post-getTerminalsUnderAccount 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-getTerminalsUnderAccount-getTerminalsStore-200:
      summary: Example response for request 'getTerminalsStore'
      value:
        companyAccount: YOUR_COMPANY_ACCOUNT
        merchantAccounts:
        - merchantAccount: YOUR_MERCHANT_ACCOUNT
          stores:
          - store: YOUR_STORE
            inStoreTerminals:
            - M400-401972715
    post-getTerminalsUnderAccount-getTerminalsCompany:
      summary: Get all the terminals under a company account
      description: Returns a list of terminals associated with the company, indicating where each terminal is assigned to.
      value:
        companyAccount: YOUR_COMPANY_ACCOUNT
    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-getTerminalsUnderAccount-getTerminalsMerchant:
      summary: Get all the terminals under a merchant account
      description: Returns a list of terminals associated with the merchant account, indicating where each terminal is assigned to.
      value:
        companyAccount: YOUR_COMPANY_ACCOUNT
        merchantAccount: YOUR_MERCHANT_ACCOUNT
    post-getTerminalsUnderAccount-getTerminalsStore:
      summary: Get all the terminals assigned to a store
      description: Returns a list of terminals assigned to the specified store.
      value:
        companyAccount: YOUR_COMPANY_ACCOUNT
        merchantAccount: YOUR_MERCHANT_ACCOUNT
        store: YOUR_STORE
    post-getTerminalsUnderAccount-getTerminalsCompany-200:
      summary: Example response for request 'getTerminalsCompany'
      value:
        companyAccount: YOUR_COMPANY_ACCOUNT
        merchantAccounts:
        - merchantAccount: YOUR_MERCHANT_ACCOUNT
          inStoreTerminals:
          - P400Plus-275479597
          stores:
          - store: YOUR_STORE
            inStoreTerminals:
            - M400-401972715
    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
    generic-400:
      summary: Response code 400. Bad request.
      value:
        status: 400
        errorCode: '702'
        message: Problem reading or understanding the request.
        errorType: validation
    post-getTerminalsUnderAccount-getTerminalsMerchant-200:
      summary: Example response for request 'getTerminalsMerchant'
      value:
        companyAccount: YOUR_COMPANY_ACCOUNT
        merchantAccounts:
        - merchantAccount: YOUR_MERCHANT_ACCOUNT
          inStoreTerminals:
          - P400Plus-275479597
          stores:
          - store: YOUR_STORE
            inStoreTerminals:
            - M400-401972715
  schemas:
    GetTerminalsUnderAccountResponse:
      properties:
        companyAccount:
          description: Your company account.
          type: string
        inventoryTerminals:
          description: Array that returns a list of all terminals that are in the inventory of the company account.
          items:
            type: string
          type: array
        merchantAccounts:
          description: Array that returns a list of all merchant accounts belonging to the company account.
          items:
            $ref: '#/components/schemas/MerchantAccount'
          type: array
      required:
      - companyAccount
      type: object
    Address:
      properties:
        city:
          type: string
        countryCode:
          type: string
        postalCode:
          type: string
        stateOrProvince:
          type: string
        streetAddress:
          type: string
        streetAddress2:
          type: string
      type: object
    MerchantAccount:
      properties:
        inStoreTerminals:
          description: List of terminals assigned to this merchant account as in-store terminals. This means that the terminal is ready to be boarded, or is already boarded.
          items:
            type: string
          type: array
        inventoryTerminals:
          description: List of terminals assigned to the inventory of this merchant account.
          items:
            type: string
          type: array
        merchantAccount:
          description: The merchant account.
          type: string
        stores:
          description: Array of stores under this merchant account.
          items:
            $ref: '#/components/schemas/Store'
          type: array
      required:
      - merchantAccount
      type: object
    GetTerminalsUnderAccountRequest:
      properties:
        companyAccount:
          description: Your company account. If you only specify this parameter, the response includes all terminals at all account levels.
          type: string
        merchantAccount:
          description: The merchant account. This is required if you are retrieving the terminals assigned to a store.If you don't specify a `store` the response includes the terminals assigned to the specified merchant account and the terminals assigned to the stores under this merchant account.
          type: string
        store:
          description: The store code of the store. With this parameter, the response only includes the terminals assigned to the specified store.
          type: string
      required:
      - companyAccount
      type: object
    Store:
      properties:
        address:
          description: The address of the store.
          $ref: '#/components/schemas/Address'
        description:
          description: The description of the store.
          type: string
        inStoreTerminals:
          description: The list of terminals assigned to the store.
          items:
            type: string
          type: array
        merchantAccountCode:
          description: The code of the merchant account.
          type: string
        status:
          description: "The status of the store:\n\n- `PreActive`: the store has been created, but not yet activated. \n\n- `Active`: the store has been activated. This means you can process payments for this store. \n\n- `Inactive`: the store is currently not active. \n\n- `InactiveWithModifications`: the store is currently not active, but payment modifications such as refunds are possible. \n\n- `Closed`: the store has been closed. "
          type: string
        store:
          description: The code of the store.
          type: string
      required:
      - store
      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
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: X-API-Key
      type: apiKey
    BasicAuth:
      scheme: basic
      type: http