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

# Enviar PIX

> Envia PIX para chave PIX ou copia e cola (BR Code).

<RequestExample>
  ```bash cURL theme={null}
  curl -X POST 'https://api.goatpay.com.br/v1/transfer-pix/create' \
    -H 'X-API-Key: gp_live_SUA_CHAVE' \
    -H 'Content-Type: application/json' \
    -d '{ "amount": 50, "pixKey": "12345678909", "pixKeyType": "CPF", "description": "Saque PIX", "coverFee": true }'
  ```
</RequestExample>

<ResponseExample>
  ```json Success theme={null}
  {
    "success": true,
    "message": "Transferência PIX criada com sucesso",
    "data": { "id": "clx_transacao", "status": "PENDING" },
    "requestId": "req_abc"
  }
  ```
</ResponseExample>

### Corpo da requisição

<ParamField body="amount" type="number" required>
  Valor em reais. Mínimo R\$ 1,00.
</ParamField>

<ParamField body="description" type="string" required>
  Descrição da transferência.
</ParamField>

<ParamField body="pixKey" type="string">
  Chave PIX (obrigatório se não usar pixCopyPaste).
</ParamField>

<ParamField body="pixKeyType" type="string">
  CPF, CNPJ, EMAIL, TELEFONE ou CHAVE\_ALEATORIA.
</ParamField>

<ParamField body="pixKeyOwnerDocument" type="string">
  CPF/CNPJ do titular (dígitos). Opcional/legado; transferências por chave PIX não exigem mais esse dado.
</ParamField>

<ParamField body="pixCopyPaste" type="string">
  BR Code para pagar QR de terceiros.
</ParamField>

<ParamField body="coverFee" type="boolean">
  Padrão true: `amount` é o valor recebido pelo destinatário.
</ParamField>

<Note>
  `pixCopyPaste` (BR Code) exige trilho PADRÃO. `/payouts/*` é alias de `/transfer-pix/*`.
</Note>


## OpenAPI

````yaml POST /transfer-pix/create
openapi: 3.1.0
info:
  title: GoatPay API
  description: >
    API pública merchant da GoatPay. Autenticação via header `X-API-Key:
    gp_live_...`.

    Respostas de sucesso usam o envelope `{ success, message, data, requestId
    }`.

    Campos internos (`accountId`, `metadata`, histórico de entregas de webhook,
    etc.) não são expostos.

    `providerTransactionId` aparece como `referenceId`; `providerInfractionId`
    como `infractionId`.

    Rate limit global: 100 requisições por minuto por API key (HTTP 429). Sem
    chave, limite por IP.
  version: 1.0.0
servers:
  - url: https://api.goatpay.com.br/v1
    description: Produção
security:
  - apiKeyAuth: []
tags:
  - name: pix
    description: >-
      Cobranças PIX (receber), reembolsos de depósito recebido e transferências
      PIX (enviar). Alias legado em payouts/* para envios.
  - name: transfer-internal
    description: Transferências entre contas GoatPay
  - name: transfer-scheduled
    description: Transferências programadas (agendar, repetir ou por saldo)
  - name: crypto
    description: Depósitos e transferências em criptomoeda
  - name: billings
    description: >-
      Cobranças avulsas (pagamento único) — boleto, cartão ou PIX na Conta
      Padrão (PF ou PJ)
  - name: subscriptions
    description: >-
      Assinaturas recorrentes com ciclo fixo — boleto, cartão ou PIX na Conta
      Padrão (PF ou PJ)
  - name: account
    description: Saldo e extrato
  - name: subaccount
    description: Subcontas merchant (carteiras lógicas sob a conta principal)
  - name: meds
    description: Disputas MED
  - name: webhooks
    description: Endpoints de webhook de saída
  - name: payouts
    description: Alias de transfer-pix para saques PIX
  - name: customers
    description: Clientes da loja (CRM)
  - name: products
    description: Produtos e entregas digitais
  - name: coupons
    description: Cupons de desconto para links
  - name: payment-links
    description: Links de pagamento e checkout hospedado
paths:
  /transfer-pix/create:
    post:
      tags:
        - pix
      summary: Criar transferência PIX
      description: >
        Envia PIX para chave ou BR Code (saque). Taxa conforme configuração da
        conta (trilho PADRAO).

        Com `coverFee: true` (padrão), `amount` é o valor recebido pelo
        destinatário.

        `pixCopyPaste` (QR Code) só no trilho `PADRAO`.

        Com `subaccountId`, o débito sai do saldo da subconta (requer PIX em
        subcontas habilitado).

        Permissões legadas `payouts/*` usam as mesmas rotas em
        `/payouts/create`, `/payouts/get/{id}` e `/payouts/list`.
      operationId: createTransferPix
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePixTransfer'
      responses:
        '200':
          $ref: '#/components/responses/PixTransferSuccess'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  schemas:
    CreatePixTransfer:
      type: object
      required:
        - amount
        - description
      properties:
        amount:
          type: number
          minimum: 1
          description: Valor em reais. Mínimo R$ 1,00 no trilho PADRAO.
        description:
          type: string
          minLength: 3
          maxLength: 180
        pixKey:
          type: string
        pixKeyType:
          type: string
          enum:
            - CPF
            - CNPJ
            - EMAIL
            - TELEFONE
            - CHAVE_ALEATORIA
        pixKeyOwnerDocument:
          type: string
          description: >
            CPF ou CNPJ do titular da chave (11 ou 14 dígitos, sem formatação).

            Campo opcional/legado; transferências por chave PIX não exigem mais
            CPF/CNPJ do titular.

            Em pagamentos por `pixCopyPaste`, o PSP pode inferir esse dado do BR
            Code quando disponível.
        pixCopyPaste:
          type: string
          description: BR Code para pagar QR de terceiros.
        externalReference:
          type: string
        coverFee:
          type: boolean
          default: true
          description: >-
            Taxa de saída conforme configuração da conta (ex. R$ 0,80 no
            PADRAO).
        subaccountId:
          type: string
          description: >-
            ID da subconta merchant. Débito no saldo da subconta; disponível
            apenas no trilho PADRAO (requer merchantSubaccountsPixEnabled).
    PublicTransaction:
      type: object
      description: >
        Transação exposta na API pública após sanitização.

        Não inclui `provider`, `accountId`, `metadata`, `pixRail`, `direction`,
        `updatedAt` nem `providerStatus`.
      properties:
        id:
          type: string
        type:
          type: string
          description: Ex. PIX_IN, PIX_OUT, INTERNAL_TRANSFER_OUT, CRYPTO_IN.
        status:
          type: string
          enum:
            - PENDING
            - PROCESSING
            - COMPLETED
            - FAILED
            - CANCELED
            - REVERSED
        amount:
          type: number
        feeAmount:
          type: number
        netAmount:
          type: number
        coverFee:
          type: boolean
        emitFiscalInvoice:
          type: boolean
          description: Indica se a cobrança deve gerar nota fiscal ao ser paga.
        currency:
          type: string
          example: BRL
        countsTowardPixBalance:
          type: boolean
          description: Indica se a transação movimenta o saldo PIX GoatPay.
        settlementScope:
          type: string
          enum:
            - goatpay
          description: Escopo de liquidação/saldo da transação.
        description:
          type: string
        externalReference:
          type: string
        referenceId:
          type: string
          description: Identificador da operação no processador de pagamento.
        endToEndId:
          type: string
        pixKey:
          type: string
        pixKeyType:
          type: string
        payer:
          type: object
          description: >-
            Cliente/pagador da transação. Em PIX recebido após confirmação,
            `name` e `document` vêm do comprovante PIX Padrão. Em cobranças de
            link de pagamento, `email` e `phone` (e nome/documento do checkout
            quando ainda não houver pagamento confirmado) vêm do formulário do
            comprador. Presente em entradas (PIX, boleto, cartão, etc.) quando
            há dados identificáveis; ausente em saídas PIX e quando não há
            nenhum dado.
          properties:
            name:
              type: string
              nullable: true
              description: Nome do pagador (comprovante PIX ou checkout do link).
            document:
              type: string
              nullable: true
              description: CPF ou CNPJ do pagador (apenas dígitos).
            email:
              type: string
              nullable: true
              description: E-mail informado no checkout do link de pagamento.
            phone:
              type: string
              nullable: true
              description: Telefone informado no checkout do link de pagamento.
        recipient:
          type: object
          description: >-
            Favorecido (recebedor) da transferência PIX, com nome e documento
            confirmados na liquidação PIX (`creditorAccount`). Presente apenas
            em `PIX_OUT` após a liquidação; ausente em saídas pendentes, em PIX
            recebido e quando o favorecido não é confirmado.
          properties:
            name:
              type: string
              nullable: true
              description: Nome do favorecido confirmado pelo banco.
            document:
              type: string
              nullable: true
              description: CPF ou CNPJ do favorecido (apenas dígitos).
        subaccountId:
          type: string
        completedAt:
          type: string
          format: date-time
        expiresAt:
          type: string
          format: date-time
        createdAt:
          type: string
          format: date-time
    ErrorEnvelope:
      type: object
      required:
        - success
        - message
        - error
      properties:
        success:
          type: boolean
          example: false
        message:
          type: string
          example: Subconta inativa
        error:
          type: object
          properties:
            code:
              type: string
              example: Bad Request
            statusCode:
              type: integer
              example: 400
        requestId:
          type: string
          example: req_abc123
  responses:
    PixTransferSuccess:
      description: Transferência PIX criada ou consultada.
      content:
        application/json:
          schema:
            type: object
            required:
              - success
              - message
              - data
            properties:
              success:
                type: boolean
              message:
                type: string
              data:
                $ref: '#/components/schemas/PublicTransaction'
              requestId:
                type: string
          examples:
            created:
              summary: Saque criado
              value:
                success: true
                message: Transferência PIX criada com sucesso
                data:
                  id: clx_pix_out
                  type: PIX_OUT
                  status: PROCESSING
                  amount: 50
                  feeAmount: 2
                  netAmount: 52
                  coverFee: true
                  currency: BRL
                  countsTowardPixBalance: true
                  settlementScope: goatpay
                  description: Saque parceiro
                  pixKey: '11999999999'
                  pixKeyType: TELEFONE
                  referenceId: ref_out_xyz
                  createdAt: '2026-06-01T14:00:00.000Z'
                requestId: req_def456
            completed:
              summary: Saque liquidado (com favorecido)
              value:
                success: true
                message: Transferência PIX encontrada
                data:
                  id: clx_pix_out
                  type: PIX_OUT
                  status: COMPLETED
                  amount: 50
                  feeAmount: 2
                  netAmount: 52
                  coverFee: true
                  currency: BRL
                  countsTowardPixBalance: true
                  settlementScope: goatpay
                  description: Saque parceiro
                  pixKey: '11999999999'
                  pixKeyType: TELEFONE
                  referenceId: ref_out_xyz
                  endToEndId: E12345678202505301234567890123456
                  recipient:
                    name: Maria Recebedora
                    document: '12345678909'
                  completedAt: '2026-06-01T14:05:00.000Z'
                  createdAt: '2026-06-01T14:00:00.000Z'
                requestId: req_def456
    Unauthorized:
      description: Chave ausente, inválida ou revogada.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    Forbidden:
      description: Chave sem permissão para este endpoint.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    RateLimited:
      description: Limite de 100 requisições por minuto excedido.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Chave `gp_live_...` criada em Integrações → Chaves de API no dashboard.

````