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

# Solicitar reembolso PIX

> Devolve um depósito PIX recebido (estorno no SPI).

<RequestExample>
  ```bash cURL theme={null}
  curl -X POST 'https://api.goatpay.com.br/v1/refunds/create' \
    -H 'X-API-Key: gp_live_SUA_CHAVE' \
    -H 'Content-Type: application/json' \
    -d '{ "transactionId": "clx_pix_in", "refundId": "devolucao-pedido-123", "amount": 100, "nature": "ORIGINAL", "description": "Estorno pedido #123" }'
  ```
</RequestExample>

<ResponseExample>
  ```json Success theme={null}
  {
    "success": true,
    "message": "Reembolso PIX solicitado com sucesso",
    "data": {
      "id": "clx_pix_in",
      "status": "PROCESSING",
      "amount": 100,
      "endToEndId": "E12345678202505301234567890123456",
      "refund": {
        "status": "PROCESSING",
        "refundId": "devolucao-pedido-123"
      }
    },
    "requestId": "req_abc"
  }
  ```
</ResponseExample>

### Corpo da requisição

<ParamField body="transactionId" type="string">
  ID da cobrança PIX (depósito) na GoatPay. Obrigatório se não enviar e2eId.
</ParamField>

<ParamField body="e2eId" type="string">
  EndToEndId do PIX recebido (alternativa ao transactionId).
</ParamField>

<ParamField body="refundId" type="string">
  ID único da devolução (1–35 alfanuméricos). Padrão: ID da transação.
</ParamField>

<ParamField body="amount" type="number">
  Valor bruto a devolver — deve ser igual ao depósito (estorno integral).
</ParamField>

<ParamField body="nature" type="string">
  ORIGINAL (PIX padrão) ou RETIRADA (PIX saque/troco). Padrão ORIGINAL.
</ParamField>

<ParamField body="description" type="string">
  Texto opcional para o pagador (máx. 140 caracteres).
</ParamField>

<Note>
  Disponível no trilho PADRÃO. Estorno integral do depósito.
</Note>


## OpenAPI

````yaml POST /refunds/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:
  /refunds/create:
    post:
      tags:
        - pix
      summary: Solicitar reembolso PIX
      description: >
        Devolve um depósito PIX recebido (estorno SPI). Trilho **PADRÃO**
        apenas.

        Informe `transactionId` (ID da cobrança) ou `e2eId`. Estorno integral:
        `amount` deve igualar o bruto do depósito.

        Debita o líquido retido na subconta (ou conta principal) mais a taxa de
        saída PIX. Use `subaccountId` quando o depósito foi creditado em
        subconta.
      operationId: createPixRefund
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePixRefund'
            examples:
              porTransacao:
                summary: Por ID da cobrança
                value:
                  transactionId: clx_pix_in
                  refundId: devolucao-pedido-123
                  amount: 100
                  nature: ORIGINAL
                  description: Estorno pedido
              porE2e:
                summary: Por EndToEndId
                value:
                  e2eId: E12345678202505301234567890123456
                  refundId: devolucao-pedido-123
      responses:
        '200':
          $ref: '#/components/responses/PixRefundSuccess'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  schemas:
    CreatePixRefund:
      type: object
      description: Informe `transactionId` ou `e2eId` (pelo menos um).
      properties:
        transactionId:
          type: string
          description: ID da cobrança PIX (depósito) na GoatPay.
        e2eId:
          type: string
          description: EndToEndId do PIX recebido.
        refundId:
          type: string
          minLength: 1
          maxLength: 35
          description: >-
            ID único da devolução no SPI (alfanumérico). Padrão — ID da
            transação.
        amount:
          type: number
          description: >-
            Valor bruto a devolver; deve ser igual ao depósito (estorno
            integral).
        nature:
          type: string
          enum:
            - ORIGINAL
            - RETIRADA
          default: ORIGINAL
          description: ORIGINAL (PIX padrão) ou RETIRADA (PIX saque/troco).
        description:
          type: string
          maxLength: 140
          description: Texto opcional exibido ao pagador.
        subaccountId:
          type: string
          description: >-
            ID da subconta; estorno debita saldo e taxa da subconta quando o
            depósito pertence a ela.
    PublicPixRefund:
      allOf:
        - $ref: '#/components/schemas/PublicTransaction'
        - type: object
          properties:
            refund:
              $ref: '#/components/schemas/PublicRefundDetail'
    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
    PublicRefundDetail:
      type: object
      properties:
        status:
          type: string
          enum:
            - AVAILABLE
            - PROCESSING
            - COMPLETED
            - UNAVAILABLE
        refundId:
          type: string
        requestedAt:
          type: string
          format: date-time
        completedAt:
          type: string
          format: date-time
        debitNet:
          type: number
        depositNet:
          type: number
        transferFee:
          type: number
        nature:
          type: string
          enum:
            - ORIGINAL
            - RETIRADA
        description:
          type: string
  responses:
    PixRefundSuccess:
      description: Reembolso PIX solicitado ou consultado.
      content:
        application/json:
          schema:
            type: object
            required:
              - success
              - message
              - data
            properties:
              success:
                type: boolean
              message:
                type: string
              data:
                $ref: '#/components/schemas/PublicPixRefund'
              requestId:
                type: string
    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'
    NotFound:
      description: Recurso não encontrado.
      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.

````