> ## Documentation Index
> Fetch the complete documentation index at: https://docs.dintero.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List stores

> Get details about the account stores

scopes:
- admin:accounts
- read:accounts




## OpenAPI

````yaml /mintlify-docs/openapi/spec-payments-v2.yaml get /accounts/{aid}/stores
openapi: 3.0.0
info:
  title: Payments API v2
  contact:
    name: API Integration Support
    email: integration@dintero.com
  description: |
    Public endpoints for payments served under the account-scoped URL format
    `https://api.dintero.com/v1/accounts/{aid}/...`.
  version: LATEST
  license:
    name: UNLICENSED
    url: https://dintero.com
  x-logo:
    url: https://docs.dintero.com/img/dintero-dark-padded.svg
    altText: Dintero Logo
servers:
  - url: https://api.dintero.com/v1
security:
  - JWT: []
tags:
  - name: Transactions
    x-displayName: Transactions
    description: |
      View and perform operations on transactions
  - name: session
    x-displayName: Sessions
    description: |
      A Checkout Session relates to an order in your system.
      When an order has been placed you create a corresponding Checkout Session
      to receive payment for that order.
  - name: payment
    x-displayName: Payment
    description: |
      Resources used by the customer aka user to complete the payment of a
      session.
  - name: settlements
    x-displayName: Settlement reports
    description: Get settlement reports generated per payout
  - name: settlements.configuration
    x-displayName: Configuration
    description: Configure settlement reports
  - name: reports
    x-displayName: Reports
    description: List the generated monthly transaction reports
  - name: Sellers
    x-displayName: Sellers
    description: Manage the signup of a new Seller / Merchant account
  - name: example-session-callbacks
    x-displayName: Example Callbacks
    description: Example of callbacks delivered
  - name: v2-config-payout-destinations
    x-displayName: Sellers
    description: Get payout data for sellers
  - name: Card Tokens
    description: |
      Manage card tokens
  - name: terminals
    x-displayName: Terminals
    description: Terminal operations
  - name: v2-fund-transfers
    x-displayName: Fund transfers
    description: Transfer funds between sellers
  - name: payout-destinations
    x-displayName: payout destinations
    description: |
      Payout destinations
  - name: account-stores
    x-displayName: stores
    description: |
      Manage account stores
  - name: account-terminals
    x-displayName: terminals
    description: |
      Manage account terminals
  - name: report-configuration
    x-displayName: Report configuration
    description: Manage report configurations
  - name: kpi
    x-displayName: KPI
    description: Get KPI data
paths:
  /accounts/{aid}/stores:
    get:
      tags:
        - account-stores
      summary: aid_account_management_stores_get
      description: |
        Get details about the account stores

        scopes:
        - admin:accounts
        - read:accounts
      operationId: aid_account_management_stores_get
      parameters:
        - $ref: '#/components/parameters/accountId'
        - $ref: '#/components/parameters/PayoutDestinationId'
        - $ref: '#/components/parameters/TerminalId'
        - $ref: '#/components/parameters/StoreIncludes'
        - $ref: '#/components/parameters/StoreStatus'
        - $ref: '#/components/parameters/startingAfter'
        - $ref: '#/components/parameters/limit'
      responses:
        '200':
          $ref: '#/components/responses/StoreCollection'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/AccessForbidden'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/ServerError'
      security:
        - JWT: []
components:
  parameters:
    accountId:
      name: aid
      description: |
        An id that uniquely identifies the account.
      in: path
      required: true
      schema:
        type: string
        format: ^[PT]{1}\d{8}$
        minLength: 9
        maxLength: 9
    PayoutDestinationId:
      name: payout_destination_id
      description: Filter by Payout Destination ID
      in: query
      required: false
      example: PPD-MX9421N
      explode: true
      schema:
        type: array
        items:
          type: string
          maxItems: 10
    TerminalId:
      name: terminal_id
      description: Filter by Terminal ID
      in: query
      required: false
      example: P12345678-T0075
      explode: true
      schema:
        type: array
        items:
          type: string
        maxItems: 10
    StoreIncludes:
      name: includes
      description: >
        Include related data.

        Use `operator_payout_destinations` to include payout destinations for
        terminal operators associated with this store.
      in: query
      required: false
      example: operator_payout_destinations
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          enum:
            - operator_payout_destinations
        maxItems: 1
    StoreStatus:
      name: status
      description: Filter stores by status
      in: query
      required: false
      example: ACTIVE
      explode: true
      schema:
        type: array
        items:
          type: string
          enum:
            - ACTIVE
            - PENDING
            - SUSPENDED
            - DELETED
            - ERROR
        maxItems: 10
    startingAfter:
      name: starting_after
      in: query
      description: |
        cursor for use in pagination. starting_after is an object ID
        that defines your place in the list. For instance, if you make
        a list request and receive 100 objects, end the result contains
          `paging_token=pt1`, your subsequent call can include
        `starting_after=pt1` in order to fetch the next page of the list.
      required: false
      schema:
        type: string
    limit:
      name: limit
      in: query
      description: |
        A limit on the number of objects to be returned. Limit can range
        between 1 and 100 items, and the default is 10 items.
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 10
  responses:
    StoreCollection:
      description: List of stores
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/StoreCollection'
    BadRequest:
      description: Bad / Invalid request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    AccessForbidden:
      description: Access forbidden, invalid JWT token was used
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ServerError:
      description: Unexpected Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    StoreCollection:
      type: object
      additionalProperties: false
      required:
        - stores
      properties:
        starting_after:
          type: string
        stores:
          type: array
          items:
            allOf:
              - type: object
                properties:
                  terminals_summary:
                    type: array
                    description: |
                      Summary of terminals for this store.
                    readOnly: true
                    items:
                      $ref: '#/components/schemas/StoreTerminalSummary'
              - $ref: '#/components/schemas/StoreBase'
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - message
          properties:
            code:
              type: string
              description: The code used to identify the error/warning
            errors:
              type: array
              description: The nested error(s) encountered during validation
              items:
                type: object
            message:
              type: string
              description: The human readable description of the error/warning
    StoreTerminalSummary:
      type: object
      description: Summary of terminal statuses for this store
      required:
        - status
        - count
      properties:
        status:
          $ref: '#/components/schemas/TerminalStatus'
        count:
          type: integer
          description: Number of terminals with this status
          example: 1
    StoreBase:
      type: object
      required:
        - store_id
      allOf:
        - $ref: '#/components/schemas/StoreInput'
        - $ref: '#/components/schemas/StoreReadOnly'
    TerminalStatus:
      type: string
      description: >
        How far the terminal has got through setup, and whether it can take
        payments. Only an `ACTIVE` terminal can be used for a payment; a session
        referencing a terminal in any other status is rejected.


        This says nothing about whether the terminal is online right now - for
        that, send a [`poll_terminal` terminal
        operation](/docs/checkout/in-person/terminal-operations#check-that-a-terminal-is-reachable).


        - `PENDING`: The terminal has been registered and Dintero is configuring
        it. No action needed, the status updates on its own. See `status_reason`
        for what is currently happening.

        - `ACTION_REQUIRED`: Dintero has finished its side, and the terminal now
        has to fetch its configuration from its own on-screen menu before it can
        be activated. Also set when a configuration fetch was attempted and did
        not complete, in which case fetch the settings again.

        - `ACTIVE`: The terminal is configured and ready to accept payments.

        - `INACTIVE`: The device has been disabled and cannot take payments.
        Re-enabling it is not self-service - contact Dintero support.

        - `ERROR`: Setting up the terminal failed. Delete the terminal and
        register it again, or contact Dintero support.

        - `DELETED`: The terminal has been removed from the account. Register
        the terminal again to reuse it.
      readOnly: true
      enum:
        - DELETED
        - PENDING
        - ACTION_REQUIRED
        - ACTIVE
        - INACTIVE
        - ERROR
    StoreInput:
      allOf:
        - $ref: '#/components/schemas/StoreUpdateInput'
        - type: object
          properties:
            store_id:
              type: string
              example: S312
              maxLength: 20
              pattern: ^[A-Za-z0-9._~-]{1,20}$
              description: >
                Client-supplied store identifier. If omitted, a server-side
                generated identifier is used (e.g. `T12345678-0001`).
    StoreReadOnly:
      type: object
      required:
        - id
        - created_at
        - created_by
        - updated_at
        - updated_by
        - status
        - verified
        - number_of_terminals
      properties:
        id:
          type: string
        created_at:
          type: string
        created_by:
          type: string
        updated_at:
          type: string
        updated_by:
          type: string
        status:
          type: string
          enum:
            - ACTIVE
            - PENDING
            - SUSPENDED
            - DELETED
            - ERROR
        verified:
          type: boolean
          description: The store data have been verified
        number_of_terminals:
          type: integer
          description: Number of terminals associated with a store
        payout_destination:
          $ref: '#/components/schemas/StorePayoutDestination'
        operator_payout_destinations:
          type: array
          description: >
            Operator destinations associated with this store. Included when
            `includes=operator_payout_destinations` is used.
          items:
            $ref: '#/components/schemas/OperatorPayoutDestination'
    StoreUpdateInput:
      type: object
      required:
        - store_name
        - phone_number
        - organization
      properties:
        organization:
          type: object
          description: The organization for the store
          required:
            - organization_number
          properties:
            organization_number:
              type: string
            country:
              type: string
              readOnly: true
              pattern: ^[A-Z]{2}$
              description: ISO 3166-1 country code for the organization number
              example: 'NO'
            type:
              type: string
              default: main_unit
              enum:
                - main_unit
                - sub_unit
              description: >
                - `main_unit` - the store is the payout destination's company.
                The store shows the payout destination's organization and
                address.

                - `sub_unit` - the store is a sub-unit of the payout
                destination's company in the Norwegian business register
                (BRREG). `organization.name` and `address` are taken from BRREG.
                The request fails if BRREG has no address for the sub-unit.
            name:
              type: string
            trade_name:
              type: string
        store_name:
          type: string
        email:
          type: string
          format: email
        phone_number:
          type: string
          format: E.164
          pattern: ^\+[1-9]\d{1,14}$
          description: A phone number in E.164 format
          example: '+4799999999'
        address:
          allOf:
            - $ref: '#/components/schemas/Address'
            - required:
                - postal_code
        coordinates:
          type: object
          properties:
            latitude:
              type: number
              format: float
              example: 59.949923
            longitude:
              type: number
              format: float
              example: 10.766888
          required:
            - latitude
            - longitude
          description: The coordinates of the store
        website:
          type: string
        payout_destination:
          type: object
          description: >
            The payout destination associated with this store.


            A store with a payout destination will get all its properties
            (`address`, `phone_number`, etc.) set by validated data, so you will
            not be allowed to set a custom address when a payout destination is
            set.


            The `organization_number` must match the organization number of the
            payout destination.


            These exceptions do not apply to the payout destination's sub-units,
            where a different sub-unit `organization_number` is allowed and the
            details will be set by what is available in the public registers.
          required:
            - payout_destination_id
          properties:
            payout_destination_id:
              $ref: '#/components/schemas/PayoutDestinationId'
    StorePayoutDestination:
      type: object
      required:
        - status
        - type
      properties:
        merchant_category_code:
          type: string
          pattern: ^\d{1,4}
          format: mcc
          example: '2741'
        status:
          $ref: '#/components/schemas/ApprovalStatus'
        type:
          $ref: '#/components/schemas/LegalEntityType'
    OperatorPayoutDestination:
      type: object
      required:
        - payout_destination_id
        - status
        - type
      properties:
        payout_destination_id:
          type: string
          description: The unique identifier of the payout destination
        organization_number:
          type: string
          description: National organization number valid in the country specified
        name:
          type: string
          description: The name of the organization
        trade_name:
          type: string
          description: The trade name of the organization
        merchant_category_code:
          type: string
          pattern: ^\d{1,4}
          format: mcc
          example: '2741'
        status:
          $ref: '#/components/schemas/ApprovalStatus'
        type:
          $ref: '#/components/schemas/LegalEntityType'
    Address:
      type: object
      required:
        - address_line
        - postal_place
        - country
      properties:
        address_line:
          type: string
          example: Sommerkroveien 34
        address_line_2:
          type: string
          example: PB 123
        postal_code:
          type: string
          example: '0349'
        postal_place:
          type: string
          example: Oslo
        country:
          type: string
          format: iso-3166-1
          description: |
            ISO 3166-1 country code
          example: 'NO'
    PayoutDestinationId:
      type: string
      maxLength: 40
      pattern: ^[A-Za-z0-9_-]+$
      example: PD032
    ApprovalStatus:
      type: string
      enum:
        - ACTIVE
        - DECLINED
        - UNDER_MANUAL_REVIEW
        - AUTOMATIC_REVIEW
        - WAITING_FOR_SIGNATURE
        - WAITING_FOR_DECLARATION
        - ERROR
        - ARCHIVED
        - WAITING_FOR_DETAILS
        - TERMINATED
    LegalEntityType:
      type: string
      description: >
        - For a company seller select `company` or leave blank. Required fields
        are
          `organization_number` and `country_code`.
        - For an individual seller select `individual`. Provide optional fields
        in
          the individual object.
      enum:
        - company
        - individual
  securitySchemes:
    JWT:
      type: http
      description: >
        Bearer authentication (token authentication) should be used for
        accessing the API.


        Use [Get Token](/api-reference/authenticate/aid_auths_oauth_token_post)
        to get an access token for client credentials.

        Pass the token in the request header:

            Authorization: Bearer {access_token}

        where the **access_token** is JSON Web Tokens (JWT).
      scheme: bearer
      bearerFormat: JWT

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.