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

# Criar Saque

> Cria uma nova solicitacao de transferencia para a chave PIX informada.



## OpenAPI

````yaml /api-reference/openapi.json post /api/withdraws
openapi: 3.0.3
info:
  title: Alpa Gateway API
  version: 2.30.0
  description: >-
    Documentação completa da API pública do Alpa Gateway (v2.23.0). Todas as
    rotas requerem autenticação via API Key, exceto validação de cupom, checkout
    público e checkout de assinaturas. Novidades em 2.23.0: sistema de
    assinaturas recorrentes com planos, retry automático e métricas MRR/churn;
    cart abandonment para recuperação de vendas.
  contact:
    email: suporte@usealpa.com
  license:
    name: MIT
servers:
  - url: https://alpa-sistema-api.onrender.com
    description: Produção
security:
  - apiKeyAuth: []
tags:
  - name: Transações
    description: Gerenciamento de transações de pagamento
  - name: Links de Pagamento
    description: Gerenciamento de links de pagamento
  - name: Produtos
    description: Gerenciamento de produtos do catálogo
  - name: Cupons
    description: Gerenciamento de cupons de desconto
  - name: Webhooks
    description: Gerenciamento de webhooks e assinaturas
  - name: Saldo
    description: Consulta de saldo e movimentações
  - name: Clientes
    description: Gerenciamento de clientes
  - name: Afiliados
    description: Marketplace de afiliados, links rastreáveis e comissões automáticas
  - name: Assinaturas
    description: Planos de assinatura recorrente, checkout público e métricas MRR/churn
  - name: Saques
    description: Solicitações de saque, saldo disponível e métodos de retirada
  - name: Antecipações
    description: Antecipação de recebíveis de transações de cartão parceladas
  - name: Indicações
    description: >-
      Programa de indicações — código de convite, estatísticas e histórico de
      recompensas
paths:
  /api/withdraws:
    post:
      tags:
        - Saques
      summary: Criar Saque
      description: Cria uma nova solicitacao de transferencia para a chave PIX informada.
      operationId: createWithdraw
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - amountCents
                - pixKey
                - pixKeyType
              properties:
                amountCents:
                  type: integer
                  minimum: 100
                  maximum: 10000000
                  example: 5000
                  description: Valor em centavos (min. R$ 1,00)
                pixKey:
                  type: string
                  example: joao@example.com
                  description: Chave PIX de destino
                pixKeyType:
                  type: string
                  enum:
                    - cpf
                    - cnpj
                    - email
                    - phone
                    - random
                  example: email
                description:
                  type: string
                  description: Descricao opcional
                idempotencyKey:
                  type: string
                  format: uuid
                  description: >-
                    Chave de idempotencia — evita criacao duplicada em
                    retentativas
      responses:
        '201':
          description: Saque criado com sucesso
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Requisicao de saque criada com sucesso
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                      userId:
                        type: string
                        format: uuid
                      amountCents:
                        type: integer
                        example: 5000
                        description: Valor solicitado em centavos
                      feeCents:
                        type: integer
                        example: 350
                        description: Taxa do saque em centavos
                      netAmount:
                        type: integer
                        example: 4650
                        description: Valor liquido a receber em centavos
                      status:
                        type: string
                        enum:
                          - PENDING
                          - PROCESSING
                          - COMPLETED
                          - FAILED
                          - CANCELLED
                      pixKeyType:
                        type: string
                        enum:
                          - cpf
                          - cnpj
                          - email
                          - phone
                          - random
                        nullable: true
                      pixKey:
                        type: string
                        nullable: true
                      externalId:
                        type: string
                        nullable: true
                      failureReason:
                        type: string
                        nullable: true
                      createdAt:
                        type: string
                        format: date-time
                      updatedAt:
                        type: string
                        format: date-time
                      processedAt:
                        type: string
                        format: date-time
                        nullable: true
                      completedAt:
                        type: string
                        format: date-time
                        nullable: true
                      failedAt:
                        type: string
                        format: date-time
                        nullable: true
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
      security:
        - apiKeyAuth: []
components:
  responses:
    BadRequest:
      description: Requisição inválida
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
              code:
                type: string
              timestamp:
                type: string
                format: date-time
              path:
                type: string
              errors:
                type: array
                items:
                  type: object
    Unauthorized:
      description: Não autorizado - API Key inválida ou ausente
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: API-Key
      description: >-
        Chave de API obtida através do endpoint /api/credentials. Também aceita
        formato Bearer Token: Authorization: Bearer <api_key>

````