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

# Listar suas subcontas

> Exige subaccounts:read. Consulta somente a organização e o ambiente da chave. O saldo da subconta não faz parte do saldo principal.



## OpenAPI

````yaml /openapi.json get /v1/subaccounts
openapi: 3.1.0
info:
  title: MingoPay API
  version: 1.0.0
  description: >-
    API pública para cobranças Pix, subcontas, devoluções e consulta de saldo.
    Valores monetários em centavos; ambientes e saldos são isolados.
servers:
  - url: https://api.mingopay.com.br
    description: API MingoPay
security:
  - bearerAuth: []
tags:
  - name: Cobranças
    description: Criação, consulta e reconciliação de cobranças Pix.
  - name: Devoluções
    description: Devoluções parciais ou totais de cobranças pagas.
  - name: Saldo
    description: Saldo disponível calculado pelo ledger da organização.
  - name: Sandbox
    description: Simulações disponíveis somente para chaves mp_test_.
  - name: Subcontas
    description: >-
      Subcontas administradas pela sua organização, com cobranças e saldos
      separados.
paths:
  /v1/subaccounts:
    get:
      tags:
        - Subcontas
      summary: Listar suas subcontas
      description: >-
        Exige subaccounts:read. Consulta somente a organização e o ambiente da
        chave. O saldo da subconta não faz parte do saldo principal.
      operationId: listSubaccounts
      parameters:
        - name: limit
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 20
        - name: offset
          in: query
          schema:
            type: integer
            minimum: 0
            maximum: 1000000
            default: 0
        - name: search
          in: query
          schema:
            type: string
            maxLength: 120
        - name: status
          in: query
          schema:
            type: string
            enum:
              - all
              - active
              - inactive
            default: all
      responses:
        '200':
          description: Operação concluída.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Subaccount'
                  total:
                    type: integer
                  limit:
                    type: integer
                  offset:
                    type: integer
                  environment:
                    type: string
                    enum:
                      - sandbox
                      - production
                  permissions:
                    type: object
                    properties:
                      canManage:
                        type: boolean
                      canCreateCharges:
                        type: boolean
                      canPayout:
                        type: boolean
                        description: >-
                          Chaves de API não autorizam saques; false para
                          chamadas Bearer.
                    required:
                      - canManage
                      - canCreateCharges
                      - canPayout
                  globalFees:
                    $ref: '#/components/schemas/SubaccountFees'
                required:
                  - data
                  - total
                  - limit
                  - offset
                  - environment
                  - permissions
                  - globalFees
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
components:
  schemas:
    Subaccount:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        email:
          type:
            - string
            - 'null'
        externalReference:
          type: string
        environment:
          type: string
          enum:
            - sandbox
            - production
        active:
          type: boolean
        linked:
          type: boolean
        availableCents:
          type: integer
        reservedCents:
          type: integer
        providerAvailableCents:
          type:
            - integer
            - 'null'
        providerBlockedCents:
          type:
            - integer
            - 'null'
        syncErrorCode:
          type:
            - string
            - 'null'
        provider:
          type: string
        providerBalanceCents:
          type:
            - integer
            - 'null'
        syncedAt:
          type:
            - string
            - 'null'
          format: date-time
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        feeMode:
          type: string
          enum:
            - global
            - custom
        customFees:
          $ref: '#/components/schemas/SubaccountFees'
        blockMode:
          type: string
          enum:
            - none
            - payouts
            - all
        payoutLimits:
          $ref: '#/components/schemas/SubaccountPayoutLimits'
        effectiveFees:
          $ref: '#/components/schemas/SubaccountFees'
        pixKeyMasked:
          type:
            - string
            - 'null'
        holderTaxIdMasked:
          type:
            - string
            - 'null'
      required:
        - id
        - name
        - email
        - externalReference
        - environment
        - active
        - linked
        - availableCents
        - reservedCents
        - providerAvailableCents
        - providerBlockedCents
        - syncErrorCode
        - provider
        - providerBalanceCents
        - syncedAt
        - createdAt
        - updatedAt
        - feeMode
        - customFees
        - effectiveFees
        - pixKeyMasked
        - holderTaxIdMasked
        - blockMode
        - payoutLimits
    SubaccountFees:
      type: object
      additionalProperties: false
      required:
        - saleFeePercent
        - saleFeeFixedCents
        - payoutFeePercent
        - payoutFeeFixedCents
      properties:
        saleFeePercent:
          type: number
          minimum: 0
          maximum: 100
          multipleOf: 0.01
        saleFeeFixedCents:
          type: integer
          minimum: 0
          maximum: 100000000
        payoutFeePercent:
          type: number
          minimum: 0
          maximum: 100
          multipleOf: 0.01
        payoutFeeFixedCents:
          type: integer
          minimum: 0
          maximum: 100000000
    SubaccountPayoutLimits:
      type: object
      additionalProperties: false
      required:
        - perPayoutCents
        - dailyCents
        - monthlyCents
      properties:
        perPayoutCents:
          type: integer
          minimum: 0
          maximum: 100000000
        dailyCents:
          type: integer
          minimum: 0
          maximum: 100000000
        monthlyCents:
          type: integer
          minimum: 0
          maximum: 100000000
      description: >-
        Débito total, incluindo tarifa e comissão. Zero = sem limite adicional.
        Dias e meses em America/Sao_Paulo.
    ApiError:
      type: object
      required:
        - error
        - message
        - requestId
      properties:
        error:
          type: string
        message:
          type: string
        requestId:
          type: string
        details:
          type: array
          items:
            type: object
            required:
              - path
              - message
            properties:
              path:
                type: string
              message:
                type: string
  responses:
    BadRequest:
      description: Requisição inválida.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    Unauthorized:
      description: Chave ausente ou inválida.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    Forbidden:
      description: >-
        Ambiente, organização ou escopo não autorizado. Organizações suspensas
        (restricted) ou encerradas (closed) retornam organization_not_active em
        sandbox e produção.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    NotFound:
      description: Recurso não encontrado.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    Conflict:
      description: Conflito de estado ou idempotência.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    ServiceUnavailable:
      description: Provedor ou operação temporariamente indisponível.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Chave de API MingoPay com prefixo mp_test_ ou mp_live_.

````

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