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

# Criar Subconta

> Cria uma subconta com saldo próprio, totalmente independente do saldo da conta principal.

**Permissão requerida:** `SUBACCOUNT:WRITE` ou `FULL_ACCESS`

<Note>
  **O `reference` é imutável.** Ele é o identificador que você envia no header `X-Sub-Account` para operar na subconta e o valor que chega no campo `subAccount` dos webhooks — escolha com cuidado, porque não é possível alterá-lo depois da criação.

  Formato: `^[a-z0-9][a-z0-9_-]{1,31}$` — de 2 a 32 caracteres, apenas letras minúsculas, números, `-` e `_`, começando por letra minúscula ou número. O `reference` precisa ser único dentro da conta: repetir um já existente retorna `409 SUB_ACCOUNT_REFERENCE_TAKEN`.

  A subconta nasce com saldo próprio, zerado e totalmente independente do saldo da conta principal. Veja [Subcontas](/#subcontas) para o comportamento do header `X-Sub-Account` e a tabela completa de erros.
</Note>


## OpenAPI

````yaml openapi.json POST /sub-accounts
openapi: 3.0.0
info:
  title: pague.dev API
  description: pague.dev Payment API documentation
  version: '1.0'
  contact: {}
servers:
  - url: https://api-gateway.pague.dev/v2
security: []
paths:
  /sub-accounts:
    post:
      tags:
        - External API - Sub-accounts (Subcontas)
      summary: Criar uma subconta
      description: >-
        Cria uma subconta com saldo próprio, totalmente independente do saldo da
        conta principal.


        **Permissão requerida:** `SUBACCOUNT:WRITE` ou `FULL_ACCESS`
      operationId: ExternalSubAccountsController_createSubAccount
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSubAccountInput'
      responses:
        '201':
          description: Subconta criada com sucesso
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateSubAccountOutput'
        '400':
          description: Bad Request - Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorResponse'
        '401':
          description: Unauthorized - Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorResponse'
        '403':
          description: Forbidden - Permission denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorResponse'
        '409':
          description: >-
            Conflict - `reference` já usado nesta conta
            (`SUB_ACCOUNT_REFERENCE_TAKEN`) ou limite de subcontas atingido
            (`SUB_ACCOUNT_QUOTA_EXCEEDED`)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorResponse'
      security:
        - bearerAuth: []
components:
  schemas:
    CreateSubAccountInput:
      type: object
      properties:
        reference:
          type: string
          description: >-
            Identificador da subconta definido por você. Único dentro da conta e
            imutável depois da criação. `principal` é palavra reservada da conta
            principal e não pode ser usada: devolve `400
            SUB_ACCOUNT_INVALID_REFERENCE`.
          pattern: ^[a-z0-9][a-z0-9_-]{1,31}$
          example: loja-centro
        name:
          type: string
          description: Nome de exibição da subconta
          maxLength: 255
          example: Loja Centro
      required:
        - reference
        - name
    CreateSubAccountOutput:
      type: object
      properties:
        id:
          type: string
          description: ID da subconta
          format: uuid
        reference:
          type: string
          description: Reference da subconta
          example: loja-centro
        name:
          type: string
          description: Nome da subconta
          example: Loja Centro
        status:
          type: string
          description: Status da subconta
          example: approved
        createdAt:
          type: string
          description: Data de criação
          format: date-time
      required:
        - id
        - reference
        - name
        - status
        - createdAt
    BadRequestErrorResponse:
      type: object
      properties:
        statusCode:
          type: number
          example: 400
        error:
          type: string
          example: BadRequest
        message:
          type: string
          example: name must be longer than or equal to 2 characters
        details:
          type: object
        timestamp:
          type: string
          example: '2025-12-15T22:00:00.000Z'
        traceId:
          type: string
      required:
        - statusCode
        - error
        - message
        - timestamp
    UnauthorizedErrorResponse:
      type: object
      properties:
        statusCode:
          type: number
          example: 401
        error:
          type: string
          example: Unauthorized
        message:
          type: string
          example: Authentication token is required
        details:
          type: object
        timestamp:
          type: string
          example: '2025-12-15T22:00:00.000Z'
        traceId:
          type: string
      required:
        - statusCode
        - error
        - message
        - timestamp
    ForbiddenErrorResponse:
      type: object
      properties:
        statusCode:
          type: number
          example: 403
        error:
          type: string
          example: Forbidden
        message:
          type: string
          example: You do not have permission to access this resource
        details:
          type: object
        timestamp:
          type: string
          example: '2025-12-15T22:00:00.000Z'
        traceId:
          type: string
      required:
        - statusCode
        - error
        - message
        - timestamp
    ConflictErrorResponse:
      type: object
      properties:
        statusCode:
          type: number
          example: 409
        error:
          type: string
          example: Conflict
        message:
          type: string
          example: Resource with name 'Example' already exists
        details:
          type: object
          example:
            resource: Example
            field: name
            value: Example
        timestamp:
          type: string
          example: '2025-12-15T22:00:00.000Z'
        traceId:
          type: string
      required:
        - statusCode
        - error
        - message
        - timestamp
    InternalServerErrorResponse:
      type: object
      properties:
        statusCode:
          type: number
          example: 500
        error:
          type: string
          example: InternalError
        message:
          type: string
          example: An unexpected error occurred
        details:
          type: object
        timestamp:
          type: string
          example: '2025-12-15T22:00:00.000Z'
        traceId:
          type: string
          example: 2771463d58840c8e116dc6dda1e1e5d0
      required:
        - statusCode
        - error
        - message
        - timestamp
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Access token obtido no POST /auth (client_id + client_secret). Válido
        por 300 segundos.

````