openapi: 3.1.0
info:
  version: '6'
  x-publicVersion: true
  title: Adyen Account acceptDispute findTerminal API
  description: "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms) instead.\n\nThe Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and verification-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic).\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Account API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder\n```"
  x-timestamp: '2023-05-30T15:27:20Z'
  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://cal-test.adyen.com/cal/services/Account/v6
tags:
- name: findTerminal
paths:
  /findTerminal:
    post:
      tags:
      - findTerminal
      summary: Adyen Get the Account or Store of a Terminal
      description: Returns the company account, merchant account, or store that a payment terminal is assigned to.
      operationId: post-findTerminal
      x-sortIndex: 1
      x-methodName: findTerminal
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      requestBody:
        content:
          application/json:
            examples:
              findTerminal:
                $ref: '#/components/examples/post-findTerminal-findTerminal'
            schema:
              $ref: '#/components/schemas/FindTerminalRequest'
      responses:
        '200':
          content:
            application/json:
              examples:
                findTerminal:
                  $ref: '#/components/examples/post-findTerminal-findTerminal-200'
              schema:
                $ref: '#/components/schemas/FindTerminalResponse'
          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-findTerminal401Example:
                  summary: Default post-findTerminal 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:
  schemas:
    FindTerminalResponse:
      properties:
        companyAccount:
          description: The company account that the terminal is associated with. If this is the only account level shown in the response, the terminal is assigned to the inventory of the company account.
          type: string
        merchantAccount:
          description: The merchant account that the terminal is associated with. If the response doesn't contain a `store` the terminal is assigned to this merchant account.
          type: string
        merchantInventory:
          description: 'Boolean that indicates if the terminal is assigned to the merchant inventory. This is returned when the terminal is assigned to a merchant account.


            - If **true**, this indicates that the terminal is in the merchant inventory. This also means that the terminal cannot be boarded.


            - If **false**, this indicates that the terminal is assigned to the merchant account as an in-store terminal. This means that the terminal is ready to be boarded, or is already boarded.'
          type: boolean
        store:
          description: The store code of the store that the terminal is assigned to.
          type: string
        terminal:
          description: The unique terminal ID.
          type: string
      required:
      - companyAccount
      - terminal
      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
    FindTerminalRequest:
      properties:
        terminal:
          description: "The unique terminal ID in the format `[Device model]-[Serial number]`. \n\nFor example, **V400m-324689776**."
          type: string
      required:
      - terminal
      type: object
  examples:
    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-findTerminal-findTerminal:
      summary: Find where a terminal is assigned to
      description: Returns the company account, merchant account, or store that the payment terminal is assigned to.
      value:
        terminal: M400-401972715
    post-findTerminal-findTerminal-200:
      summary: Example response for request 'findTerminal'
      value:
        companyAccount: YOUR_COMPANY_ACCOUNT
        merchantAccount: YOUR_MERCHANT_ACCOUNT
        merchantInventory: false
        store: YOUR_STORE
        terminal: M400-401972715
    generic-400:
      summary: Response code 400. Bad request.
      value:
        status: 400
        errorCode: '702'
        message: Problem reading or understanding the request.
        errorType: validation
    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
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: X-API-Key
      type: apiKey
    BasicAuth:
      scheme: basic
      type: http
x-groups:
- Account holders
- Accounts
- Verification