Adyen Get Stores Under Account API

openapi: 3.2.0
info:
  version: '1'
  x-publicVersion: true
  title: Adyen POS Terminal Management Get Stores 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: getStoresUnderAccount
paths:
  /getStoresUnderAccount:
    post:
      tags:
      - getStoresUnderAccount
      summary: Adyen Get the Stores of an Account
      description: Returns a list of stores associated with a company account or a merchant account, including the status of each store.
      operationId: post-getStoresUnderAccount
      x-sortIndex: 1
      x-methodName: getStoresUnderAccount
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      requestBody:
        content:
          application/json:
            examples:
              getStoresCompany:
                $ref: '#/components/examples/post-getStoresUnderAccount-getStoresCompany'
              getStoresMerchant:
                $ref: '#/components/examples/post-getStoresUnderAccount-getStoresMerchant'
            schema:
              $ref: '#/components/schemas/GetStoresUnderAccountRequest'
      responses:
        '200':
          content:
            application/json:
              examples:
                getStoresCompany:
                  $ref: '#/components/examples/post-getStoresUnderAccount-getStoresCompany-200'
                getStoresMerchant:
                  $ref: '#/components/examples/post-getStoresUnderAccount-getStoresMerchant-200'
              schema:
                $ref: '#/components/schemas/GetStoresUnderAccountResponse'
          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-getStoresUnderAccount401Example:
                  summary: Default post-getStoresUnderAccount 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-getStoresUnderAccount-getStoresMerchant:
      summary: Get all the stores under a merchant account
      description: Returns a list of all stores associated with the specified merchant account.
      value:
        companyAccount: YOUR_COMPANY_ACCOUNT
        merchantAccount: YOUR_MERCHANT_ACCOUNT
    post-getStoresUnderAccount-getStoresMerchant-200:
      summary: Example response for request 'getStoresMerchant'
      value:
        stores:
        - store: YOUR_STORE
          description: YOUR_STORE
          address:
            city: The City
            countryCode: NL
            postalCode: '1234'
            streetAddress: The Street
          status: Active
          merchantAccountCode: YOUR_MERCHANT_ACCOUNT
    post-getStoresUnderAccount-getStoresCompany:
      summary: Get all the stores under a company
      description: Returns a list of all stores associated with the specified company account.
      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
    generic-403:
      summary: Response code 403. Forbidden.
      value:
        status: 403
        errorCode: '010'
        message: Insufficient permissions to process the request.
        errorType: security
    post-getStoresUnderAccount-getStoresCompany-200:
      summary: Example response for request 'getStoresCompany'
      value:
        stores:
        - store: YOUR_STORE
          description: YOUR_STORE
          address:
            city: The City
            countryCode: NL
            postalCode: '1234'
            streetAddress: The Street
          status: Active
          merchantAccountCode: YOUR_MERCHANT_ACCOUNT
    generic-400:
      summary: Response code 400. Bad request.
      value:
        status: 400
        errorCode: '702'
        message: Problem reading or understanding the request.
        errorType: validation
    generic-422:
      summary: Response code 422. Unprocessable entity.
      value:
        status: 422
        errorCode: '901'
        message: Request validation error.
        errorType: validation
  schemas:
    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
    Address:
      properties:
        city:
          type: string
        countryCode:
          type: string
        postalCode:
          type: string
        stateOrProvince:
          type: string
        streetAddress:
          type: string
        streetAddress2:
          type: string
      type: object
    GetStoresUnderAccountRequest:
      properties:
        companyAccount:
          description: The company account. If you only specify this parameter, the response includes the stores of all merchant accounts that are associated with the company account.
          type: string
        merchantAccount:
          description: The merchant account. With this parameter, the response only includes the stores of the specified merchant account.
          type: string
      required:
      - companyAccount
      type: object
    GetStoresUnderAccountResponse:
      properties:
        stores:
          description: Array that returns a list of all stores for the specified merchant account, or for all merchant accounts under the company account.
          items:
            $ref: '#/components/schemas/Store'
          type: array
      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
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: X-API-Key
      type: apiKey
    BasicAuth:
      scheme: basic
      type: http