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

# Solicitar saque

> Solicita a transferência do saldo disponível para a chave Pix informada ou para a conta cadastrada pela empresa. A `idempotencyKey` é obrigatória: um reenvio com a mesma chave devolve o saque já criado em vez de sacar duas vezes. Um saque pode ser liquidado em mais de uma perna quando o saldo vem de origens diferentes, por isso a resposta traz uma lista.



## OpenAPI

````yaml /openapi.yaml post /v1/transfers
openapi: 3.0.3
info:
  title: Ephra API
  description: >-
    API pública da Ephra: cobranças (PIX, cartão e boleto), transações, webhooks
    e a API do vendedor sobre catálogo, checkout, vendas, reembolsos,
    financeiro, crescimento e plataforma.


    **Limite de requisições.** 1000 requisições por minuto por IP de origem.
    Toda resposta traz `x-ratelimit-limit`, `x-ratelimit-remaining` e
    `x-ratelimit-reset` (segundos até a janela zerar); ao estourar o limite a
    resposta é `429` com `retry-after`.


    **Erros.** Toda falha responde o mesmo envelope: `{ "success": false,
    "message": "..." }`.
  version: 1.0.0
servers:
  - url: https://api.ephra.io
    description: Servidor de produção
security: []
tags:
  - name: Catálogo
    description: Produtos, ofertas, categorias e cupons — o que a empresa vende.
  - name: Checkout
    description: Checkouts, order bumps, upsells e links de pagamento.
  - name: Vendas
    description: Vendas, clientes, assinaturas e entregas já realizadas.
  - name: Reembolsos
    description: Pedidos de reembolso, contestações e o quiz de retenção.
  - name: Financeiro
    description: Saldo, saques, antecipações, taxas e extratos da empresa.
  - name: Crescimento
    description: Afiliados, coprodução, indicações, pixels e integrações de marketing.
  - name: Plataforma
    description: Conta, membros, chaves de API, webhooks e configurações gerais.
paths:
  /v1/transfers:
    post:
      tags:
        - Financeiro
      summary: Solicitar saque
      description: >-
        Solicita a transferência do saldo disponível para a chave Pix informada
        ou para a conta cadastrada pela empresa. A `idempotencyKey` é
        obrigatória: um reenvio com a mesma chave devolve o saque já criado em
        vez de sacar duas vezes. Um saque pode ser liquidado em mais de uma
        perna quando o saldo vem de origens diferentes, por isso a resposta traz
        uma lista.
      operationId: createTransfer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                amount:
                  type: integer
                  exclusiveMinimum: true
                  minimum: 0
                  description: Valor bruto do saque, em centavos (R$ 500,00 = 50000).
                idempotencyKey:
                  type: string
                  minLength: 1
                  maxLength: 255
                  description: >-
                    Chave única desta solicitação. Um reenvio com a mesma chave
                    devolve o saque já criado, sem duplicar.
                pixKey:
                  type: string
                  minLength: 1
                  description: >-
                    Chave Pix de destino. Omitida, o saque vai para a chave
                    cadastrada em `GET /v1/pix-key`.
                description:
                  type: string
                  maxLength: 255
                  description: Descrição livre gravada no saque.
              required:
                - amount
                - idempotencyKey
              additionalProperties: false
            example:
              amount: 50000
              idempotencyKey: saque-2026-09-11-001
              pixKey: '11144477735'
              description: Saque semanal
      responses:
        '201':
          description: Saque solicitado.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `true` em uma resposta bem-sucedida.
                  data:
                    type: object
                    properties:
                      requestedAmount:
                        type: integer
                        description: Valor total solicitado nesta chamada, em centavos.
                      transfers:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              description: Identificador do saque.
                            status:
                              type: string
                              enum:
                                - pending
                                - queued
                                - processing
                                - pending_analysis
                                - banking_processing
                                - banking_refused
                                - banking_error
                                - manual_analysis
                                - canceled
                                - refused
                                - completed
                                - error
                                - reserved
                                - dispatched
                                - failed
                              description: Situação atual do saque na esteira de pagamento.
                            amount:
                              type: integer
                              description: Valor bruto solicitado, em centavos.
                            fees:
                              type: integer
                              description: Taxa cobrada pelo saque, em centavos.
                            netAmount:
                              type: integer
                              description: >-
                                Valor que chega na conta de destino, em centavos
                                (bruto menos taxa).
                            pixKey:
                              type: string
                              description: >-
                                Chave Pix de destino, ou `TED` quando a
                                liquidação é por transferência bancária.
                            method:
                              type: string
                              enum:
                                - manual
                                - baas
                              description: >-
                                Como o saque é liquidado: `baas` automático ou
                                `manual`.
                            type:
                              type: string
                              enum:
                                - send_analysis
                                - automatic
                              description: >-
                                Se o saque é aprovado automaticamente ou vai
                                para análise.
                            requestSource:
                              type: string
                              enum:
                                - api
                                - app
                              description: 'Origem do pedido: `api` ou `app`.'
                            source:
                              type: string
                              enum:
                                - internal
                                - fastpay
                                - pagarme
                                - uvvipay
                              description: De qual saldo o dinheiro saiu.
                            externalId:
                              type: string
                              nullable: true
                              description: >-
                                Identificador do saque no parceiro bancário,
                                quando já existe.
                            endToEndId:
                              type: string
                              nullable: true
                              description: E2E id do Pix, disponível depois da liquidação.
                            description:
                              type: string
                              nullable: true
                              description: Descrição do saque.
                            message:
                              type: string
                              nullable: true
                              description: >-
                                Motivo da recusa ou último aviso do
                                processamento.
                            createdAt:
                              type: string
                              format: date-time
                              description: Momento em que o saque foi solicitado.
                            updatedAt:
                              type: string
                              format: date-time
                              description: Momento da última alteração.
                            processedAt:
                              type: string
                              format: date-time
                              nullable: true
                              description: Momento em que o saque foi processado.
                          required:
                            - id
                            - status
                            - amount
                            - fees
                            - netAmount
                            - pixKey
                            - method
                            - type
                            - requestSource
                            - source
                            - externalId
                            - endToEndId
                            - description
                            - message
                            - createdAt
                            - updatedAt
                            - processedAt
                          additionalProperties: false
                        description: Saques criados por esta solicitação.
                    required:
                      - requestedAmount
                      - transfers
                    additionalProperties: false
                required:
                  - success
                  - data
                additionalProperties: false
                description: Saque solicitado.
              example:
                success: true
                data:
                  requestedAmount: 50000
                  transfers:
                    - id: clx9k1p7t0002qz0a5c6d7e8f
                      status: pending_analysis
                      amount: 50000
                      fees: 350
                      netAmount: 49650
                      pixKey: '11144477735'
                      method: manual
                      type: send_analysis
                      requestSource: api
                      source: internal
                      externalId: null
                      endToEndId: null
                      description: Saque semanal
                      message: null
                      createdAt: '2026-09-11T18:05:12.000Z'
                      updatedAt: '2026-09-11T18:05:12.000Z'
                      processedAt: null
        '400':
          description: A requisição está bem formada, mas uma regra de negócio a recusou.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `false` em uma resposta de erro.
                  message:
                    type: string
                    description: Mensagem legível explicando a falha.
                required:
                  - success
                  - message
                additionalProperties: false
                description: >-
                  A requisição está bem formada, mas uma regra de negócio a
                  recusou.
              example:
                success: false
                message: >-
                  Não foi possível concluir: uma regra de negócio recusou os
                  dados enviados.
        '401':
          description: Token ausente, inválido, expirado ou de empresa bloqueada.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `false` em uma resposta de erro.
                  message:
                    type: string
                    description: Mensagem legível explicando a falha.
                required:
                  - success
                  - message
                additionalProperties: false
                description: Token ausente, inválido, expirado ou de empresa bloqueada.
              example:
                success: false
                message: Token inválido ou expirado
        '403':
          description: A empresa não está habilitada a sacar com as configurações atuais.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `false` em uma resposta de erro.
                  message:
                    type: string
                    description: Mensagem legível explicando a falha.
                required:
                  - success
                  - message
                additionalProperties: false
                description: >-
                  A empresa não está habilitada a sacar com as configurações
                  atuais.
              example:
                success: false
                message: Acesso negado para esta empresa.
        '422':
          description: A requisição não passou na validação de schema.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `false` em uma resposta de erro.
                  message:
                    type: string
                    description: Mensagem legível explicando a falha.
                required:
                  - success
                  - message
                additionalProperties: false
                description: A requisição não passou na validação de schema.
              example:
                success: false
                message: 'name: Nome é obrigatório'
        '429':
          description: >-
            Requisições demais: o limite é de 1000 requisições por minuto por IP
            de origem. Espere o número de segundos do header `retry-after` e
            repita com recuo exponencial.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `false` em uma resposta de erro.
                  message:
                    type: string
                    description: Mensagem legível explicando a falha.
                required:
                  - success
                  - message
                additionalProperties: false
                description: >-
                  Requisições demais: o limite é de 1000 requisições por minuto
                  por IP de origem. Espere o número de segundos do header
                  `retry-after` e repita com recuo exponencial.
              example:
                success: false
                message: Muitas requisições. Tente novamente em breve.
          headers:
            retry-after:
              $ref: '#/components/headers/retry-after'
            x-ratelimit-limit:
              $ref: '#/components/headers/x-ratelimit-limit'
            x-ratelimit-remaining:
              $ref: '#/components/headers/x-ratelimit-remaining'
            x-ratelimit-reset:
              $ref: '#/components/headers/x-ratelimit-reset'
        '500':
          description: >-
            Falha interna ao processar a requisição. Repita; se persistir, abra
            chamado com o horário e a rota.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `false` em uma resposta de erro.
                  message:
                    type: string
                    description: Mensagem legível explicando a falha.
                required:
                  - success
                  - message
                additionalProperties: false
                description: >-
                  Falha interna ao processar a requisição. Repita; se persistir,
                  abra chamado com o horário e a rota.
              example:
                success: false
                message: Erro interno do servidor
      security:
        - bearerAuth: []
components:
  headers:
    retry-after:
      description: Segundos a esperar antes de repetir a requisição.
      schema:
        type: integer
    x-ratelimit-limit:
      description: Teto de requisições na janela (1000). Presente em toda resposta.
      schema:
        type: integer
    x-ratelimit-remaining:
      description: >-
        Quantas requisições ainda cabem na janela atual. Presente em toda
        resposta.
      schema:
        type: integer
    x-ratelimit-reset:
      description: Segundos até o contador da janela zerar. Presente em toda resposta.
      schema:
        type: integer
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````