> ## 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.

# Создать вывод средств PIX

> Создаёт новый вывод средств через PIX с указанием данных ключа PIX и владельца счёта назначения.

**Требуемое разрешение:** `WITHDRAWAL:WRITE` или `FULL_ACCESS`

**Ограничение по IP:** если для учётных данных настроен список разрешённых IP-адресов, запросы вне этого списка отклоняются с кодом `403`. Рекомендуется для учётных данных с этим разрешением.

<Note>
  **Асинхронная обработка.** Создание вывода возвращает нетерминальный статус (`pending` или `processing`) — окончательный результат всегда доставляется через вебхук (`withdrawal.completed` или `withdrawal.failed`). Считайте вебхук источником истины; не считайте ответ на создание окончательным результатом.

  Ошибки валидации (недостаточный баланс, превышение лимита, неверные данные) возвращают ошибку в самом вызове.
</Note>


## OpenAPI

````yaml openapi.ru.json POST /withdrawals
openapi: 3.0.0
info:
  title: pague.dev API
  description: Документация платёжного API pague.dev
  version: '1.0'
  contact: {}
servers:
  - url: https://api-gateway.pague.dev/v2
security: []
paths:
  /withdrawals:
    post:
      tags:
        - External API - Withdrawals (Saques)
      summary: Создать вывод средств через PIX
      description: >-
        Создаёт новый вывод средств через PIX с указанием данных ключа PIX и
        владельца счёта назначения.


        **Требуемое разрешение:** `WITHDRAWAL:WRITE` или `FULL_ACCESS`


        **Ограничение по IP:** если для учётных данных настроен список
        разрешённых IP-адресов, запросы вне этого списка отклоняются с кодом
        `403`. Рекомендуется для учётных данных с этим разрешением.
      operationId: ExternalWithdrawalsController_create
      parameters:
        - name: Idempotency-Key
          in: header
          required: false
          description: >-
            Уникальный клиентский ключ (8–255 символов), делающий запрос
            идемпотентным. Повторные запросы с тем же ключом возвращают
            закешированный ответ (TTL 24 ч). Тот же ключ с другим телом запроса
            возвращает 422.
          schema:
            type: string
            minLength: 8
            maxLength: 255
        - $ref: '#/components/parameters/SubAccount'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateExternalWithdrawalInput'
      responses:
        '201':
          description: Вывод средств успешно создан
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetExternalWithdrawalOutput'
        '400':
          description: Bad Request — ошибка валидации
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorResponse'
        '401':
          description: Unauthorized — требуется аутентификация
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorResponse'
        '403':
          description: Forbidden — доступ запрещён
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorResponse'
        '404':
          description: Not Found — ресурс не найден
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundErrorResponse'
        '500':
          description: Internal Server Error — внутренняя ошибка сервера
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorResponse'
      security:
        - bearerAuth: []
components:
  parameters:
    SubAccount:
      name: X-Sub-Account
      in: header
      required: false
      description: >-
        Reference субсчёта, в котором должна выполняться операция. Если
        заголовок не передан, операция выполняется в основном аккаунте;
        зарезервированное значение `principal` также указывает на основной
        аккаунт и равнозначно отсутствию заголовка. Принимается всеми
        эндпоинтами, кроме `POST /auth` и самих эндпоинтов `/sub-accounts`,
        которые всегда работают с основным аккаунтом.


        Возможные ошибки: `404 SUB_ACCOUNT_NOT_FOUND`, `403
        SUB_ACCOUNT_FORBIDDEN`, `403 SUB_ACCOUNT_SUSPENDED`.


        Требует, чтобы у учётных данных был включён **доступ к субсчетам**
        (Настройки → Интеграция → Учётные данные API). По умолчанию он выключен
        и не заменяется никаким разрешением, даже `FULL_ACCESS`: без него ответ
        — `403 SUB_ACCOUNT_FORBIDDEN`.
      schema:
        type: string
        pattern: ^[a-z0-9][a-z0-9_-]{1,31}$
        example: loja-centro
  schemas:
    CreateExternalWithdrawalInput:
      type: object
      description: >-
        Данные для создания вывода средств через PIX. Укажите **ровно одно** из
        полей: `amount` (валовая сумма, списываемая с баланса) **или**
        `netAmount` (чистая сумма, которую должен получить получатель).
      properties:
        projectId:
          type: string
          description: >-
            ID проекта, к которому относится вывод. Если не указан и у аккаунта
            один проект, вывод наследует этот проект; если проектов несколько —
            вывод создаётся без проекта (так же, как при создании PIX-платежа).
          format: uuid
          example: 3c90c3cc-0d44-4b50-8888-8dd25736052a
        amount:
          type: number
          minimum: 1
          description: >-
            **Валовая** сумма в BRL, списываемая с баланса. Получатель получает
            `amount - feeAmount`. Минимум R$ 1,00. Укажите `amount` ИЛИ
            `netAmount` — никогда оба одновременно.
          example: 150.75
        netAmount:
          type: number
          minimum: 1
          description: >-
            **Чистая** сумма в BRL, которую должен получить получатель. API
            вычисляет необходимую валовую сумму (`gross = netAmount +
            feeAmount`) и списывает её с баланса. Минимум R$ 1,00. Укажите
            `amount` ИЛИ `netAmount` — никогда оба одновременно.
          example: 150
        pixKey:
          type: string
          description: Ключ PIX получателя.
          example: '12345678901'
        pixKeyType:
          type: string
          enum:
            - cpf
            - cnpj
            - email
            - phone
            - random
          description: Тип ключа PIX.
          example: cpf
        holderName:
          type: string
          description: Имя владельца счёта PIX.
          example: João da Silva
        holderDocument:
          type: string
          description: CPF или CNPJ владельца.
          example: '12345678901'
        holderDocumentType:
          type: string
          enum:
            - cpf
            - cnpj
          description: Тип документа владельца.
          example: cpf
        externalReference:
          type: string
          maxLength: 255
          description: >-
            Ваш внешний референс-ID (необязательно). Возвращается в ответе и в
            вебхуках `withdrawal_completed` и `withdrawal_failed` для упрощения
            сверки с вашими внутренними системами.
          example: saque-empresa-001
      required:
        - pixKey
        - pixKeyType
        - holderName
        - holderDocument
        - holderDocumentType
    GetExternalWithdrawalOutput:
      type: object
      description: Данные созданного вывода средств.
      properties:
        id:
          type: string
          format: uuid
          description: ID вывода средств
          example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
        projectId:
          type: string
          nullable: true
          description: >-
            ID проекта вывода (null, если не указан при создании и у аккаунта 2+
            проекта)
          format: uuid
        amount:
          type: number
          description: Сумма вывода средств в BRL
          example: 150.75
        feeAmount:
          type: number
          description: Сумма комиссии в BRL
          example: 2.5
        netAmount:
          type: number
          description: Чистая сумма в BRL
          example: 148.25
        status:
          type: string
          enum:
            - pending
            - processing
            - completed
            - failed
          description: Статус вывода средств
          example: completed
        snapshotPixKey:
          type: string
          nullable: true
          description: Ключ PIX, использованный в момент вывода средств
          example: '12345678901'
        snapshotPixKeyType:
          type: string
          enum:
            - cpf
            - cnpj
            - email
            - phone
            - random
          nullable: true
          description: Тип ключа PIX, использованного в момент вывода средств
          example: cpf
        snapshotHolderName:
          type: string
          description: Имя владельца в момент вывода средств
          example: João da Silva
        snapshotHolderDocument:
          type: string
          description: Документ владельца в момент вывода средств
          example: '12345678901'
        failureReason:
          type: string
          nullable: true
          description: Причина сбоя (когда status = failed)
          example: null
        pspReference:
          type: string
          nullable: true
          description: Референс PSP (платёжного провайдера)
          example: null
        createdAt:
          type: string
          format: date-time
          description: Дата создания
          example: '2026-02-10T14:30:00.000Z'
        processedAt:
          type: string
          format: date-time
          nullable: true
          description: Дата обработки
          example: '2026-02-10T14:30:01.000Z'
        externalReference:
          type: string
          nullable: true
          description: >-
            Ваш внешний референс, отправленный при создании вывода средств
            (необязательно)
          example: saque-empresa-001
      required:
        - id
        - amount
        - feeAmount
        - netAmount
        - status
        - snapshotHolderName
        - snapshotHolderDocument
        - 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
    NotFoundErrorResponse:
      type: object
      properties:
        statusCode:
          type: number
          example: 404
        error:
          type: string
          example: NotFound
        message:
          type: string
          example: Resource with id 550e8400-e29b-41d4-a716-446655440000 not found
        details:
          type: object
          example:
            resource: Example
            id: 550e8400-e29b-41d4-a716-446655440000
        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: >-
        Токен доступа, полученный через POST /auth (client_id + client_secret).
        Действителен в течение 300 секунд.

````