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

# Criar cobrança PIX

> Gera QR Code para o cliente pagar.

<RequestExample>
  ```bash cURL theme={null}
  curl -X POST 'https://api.goatpay.com.br/v1/payment-pix/create' \
    -H 'X-API-Key: gp_live_SUA_CHAVE' \
    -H 'Content-Type: application/json' \
    -d '{ "amount": 100, "description": "Pedido 123", "coverFee": false, "emitFiscalInvoice": false }'
  ```
</RequestExample>

<ResponseExample>
  ```json Success theme={null}
  {
    "success": true,
    "message": "Pagamento PIX criado com sucesso",
    "data": {
      "id": "clx_transacao",
      "status": "PENDING",
      "amount": 100,
      "copyPaste": "000201010212...",
      "qrCodeImage": "data:image/png;base64,...",
      "expiresAt": "2026-07-08T12:00:00.000Z"
    },
    "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 cobrança (3 a 180 caracteres).
</ParamField>

<ParamField body="coverFee" type="boolean">
  Se true, `amount` é o líquido desejado. Padrão false (valor bruto do QR).
</ParamField>

<ParamField body="emitFiscalInvoice" type="boolean">
  Se true, emite nota fiscal após pagamento (requer emissão fiscal automática ativa no dashboard).
</ParamField>

<ParamField body="expirationSeconds" type="integer">
  Tempo de expiração do QR Code PIX em segundos. Padrão `86400` (24 horas). Mínimo `60`, máximo `604800` (7 dias).
</ParamField>

<ParamField body="payerName" type="string">
  Nome do pagador.
</ParamField>

<ParamField body="payerDocument" type="string">
  CPF ou CNPJ do pagador.
</ParamField>

<ParamField body="externalReference" type="string">
  Referência externa do seu sistema.
</ParamField>

<ParamField body="splitUser" type="string">
  E-mail GoatPay do parceiro no split interno.
</ParamField>

<ParamField body="splitTax" type="number">
  Percentual do líquido repassado ao splitUser (0,01 a 100).
</ParamField>

<Note>
  Use webhooks (`payment.created`, `payment.paid`) para confirmar pagamento sem polling.
</Note>


## OpenAPI

````yaml POST /payment-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:
  /payment-pix/create:
    post:
      tags:
        - pix
      summary: Criar cobrança PIX
      description: >
        Taxa GoatPay conforme configuração da conta (taxa fixa no trilho
        PADRAO).

        Com `coverFee: true`, `amount` é o líquido desejado (taxa somada no QR).

        Com `coverFee: false` (padrão), `amount` é o valor bruto do QR.

        Split interno opcional via `splitUser` + `splitTax` (% do líquido).

        Com `subaccountId`, o líquido credita a subconta no trilho PADRAO
        (requer PIX em subcontas habilitado).
      operationId: createPaymentPix
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePixDeposit'
            examples:
              bruto:
                summary: Valor bruto no QR
                value:
                  amount: 100
                  description: Pedido 123
                  coverFee: false
              liquido:
                summary: Líquido fixo (taxa no QR)
                value:
                  amount: 100
                  description: Pedido 123
                  coverFee: true
      responses:
        '200':
          $ref: '#/components/responses/PixDepositSuccess'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  schemas:
    CreatePixDeposit:
      type: object
      required:
        - amount
        - description
      properties:
        amount:
          type: number
          minimum: 1
          maximum: 1000000
          description: Valor em reais. Mínimo R$ 1,00 no trilho PADRAO.
        description:
          type: string
          minLength: 3
          maxLength: 180
        payerName:
          type: string
          maxLength: 120
        payerDocument:
          type: string
          maxLength: 14
        externalReference:
          type: string
          maxLength: 120
        coverFee:
          type: boolean
          default: false
          description: Taxa fixa configurada no trilho PADRAO (ex. R$ 0,50 ou R$ 0,80).
        emitFiscalInvoice:
          type: boolean
          default: false
          description: >-
            Emite nota fiscal após pagamento confirmado (requer emissão fiscal
            automática ativa no dashboard).
        expirationSeconds:
          type: integer
          minimum: 60
          maximum: 604800
          default: 86400
          description: >-
            Tempo de expiração do QR Code PIX em segundos. Padrão 86400 (24
            horas).
        splitUser:
          type: string
          format: email
          description: E-mail GoatPay do parceiro no split interno.
        splitTax:
          type: number
          minimum: 0.01
          maximum: 100
        subaccountId:
          type: string
          description: >-
            ID da subconta merchant. Líquido credita na subconta; disponível
            apenas no trilho PADRAO (requer merchantSubaccountsPixEnabled).
    PublicPixDeposit:
      allOf:
        - $ref: '#/components/schemas/PublicTransaction'
        - type: object
          properties:
            copyPaste:
              type: string
              description: BR Code (copia e cola).
            qrCodeBase64:
              type: string
            qrcodeUrl:
              type: string
              format: uri
            split:
              type: object
              description: >-
                Presente na resposta de criação quando `splitUser` e `splitTax`
                são enviados.
              properties:
                userEmail:
                  type: string
                  format: email
                taxPercent:
                  type: number
                estimatedSplitAmount:
                  type: number
    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
    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
  responses:
    PixDepositSuccess:
      description: Cobrança PIX criada ou consultada.
      content:
        application/json:
          schema:
            type: object
            required:
              - success
              - message
              - data
            properties:
              success:
                type: boolean
                example: true
              message:
                type: string
              data:
                $ref: '#/components/schemas/PublicPixDeposit'
              requestId:
                type: string
          examples:
            created:
              summary: Cobrança criada
              value:
                success: true
                message: Pagamento PIX criado com sucesso
                data:
                  id: clx_transacao
                  type: PIX_IN
                  status: PENDING
                  amount: 100
                  feeAmount: 0.5
                  netAmount: 99.5
                  coverFee: false
                  currency: BRL
                  countsTowardPixBalance: true
                  settlementScope: goatpay
                  description: Pedido 123
                  externalReference: pedido-123
                  referenceId: ref_pix_abc
                  copyPaste: 000201010212...
                  qrCodeBase64: data:image/png;base64,...
                  qrcodeUrl: https://pay.goatpay.com.br/p/clx_transacao
                  expiresAt: '2026-06-02T12:00:00.000Z'
                  createdAt: '2026-06-01T12:00:00.000Z'
                requestId: req_abc123
            paid:
              summary: Cobrança paga (com pagador)
              value:
                success: true
                message: Pagamento PIX encontrado
                data:
                  id: clx_transacao
                  type: PIX_IN
                  status: COMPLETED
                  amount: 100
                  feeAmount: 0.5
                  netAmount: 99.5
                  coverFee: false
                  currency: BRL
                  countsTowardPixBalance: true
                  settlementScope: goatpay
                  description: Pedido 123
                  externalReference: pedido-123
                  referenceId: ref_pix_abc
                  endToEndId: E12345678202505301234567890123456
                  payer:
                    name: João da Silva
                    document: '12345678909'
                  completedAt: '2026-06-01T12:05:00.000Z'
                  createdAt: '2026-06-01T12:00:00.000Z'
                requestId: req_abc123
    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.

````