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

# Criar um novo saque

> Cria um novo pedido de saque.



## OpenAPI

````yaml openapi.yaml post /withdraw/create
openapi: 3.1.0
info:
  title: API AobaPay
  description: API para gerenciamento de cobranças e pagamentos usando o AobaPay.
  version: 1.0.0
servers:
  - url: https://api.aobapay.com/v1
    description: Único servidor para os ambientes de produção e sandbox.
security: []
paths:
  /withdraw/create:
    post:
      summary: Criar um novo saque
      description: Cria um novo pedido de saque.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                amount:
                  type: number
                  description: Valor do saque em centavos.
                  example: 200
                  minimum: 200
                pix_type:
                  type: string
                  description: Tipo da chave PIX.
                  enum:
                    - EMAIL
                    - PHONE
                    - CPF
                    - CNPJ
                    - RANDOM
                pix_key:
                  type: string
                  description: Chave PIX.
                comment:
                  type: string
                  maxLength: 35
                  description: Comentário para o saque.
                externalID:
                  type: string
                  description: ID externo para referência na sua aplicação.
                postbackUrl:
                  type: string
                  description: >-
                    URL para receber notificações sobre o status do pagamento,
                    dos eventos de cobrança paga, expirada e extornada.
                  example: https://webhook.example.com/pix
      responses:
        '200':
          description: Saque criado com sucesso.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: 'null'
                  status:
                    type: integer
                    example: 200
                  data:
                    $ref: '#/components/schemas/WithdrawalCreateResponse'
        '400':
          description: Requisição inválida. Verifique os parâmetros enviados.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: O campo amount é obrigatório.
                  status:
                    type: integer
                    example: 400
                  data:
                    type: array
                    example: []
        '401':
          description: Não autorizado. Falha na autenticação.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Header com Authorization está vazio
                  status:
                    type: integer
                    example: 401
                  data:
                    type: array
                    example: []
      security:
        - bearerAuth: []
components:
  schemas:
    WithdrawalCreateResponse:
      type: object
      properties:
        id:
          type: string
        amount:
          type: number
        pixKey:
          type: string
        pixType:
          type: string
        externalID:
          type: string
        status:
          type: string
        comment:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Cabeçalho de autenticação Bearer no formato `Bearer <aobapay-api-key>`
        onde `<aobapay-api-key>` é a sua chave de API.

````