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

# Processar devolução Pix iniciada pelo banco recebedor

> Processa uma devolução Pix iniciada pelo banco recebedor e enviada pelo sistema upstream; este endpoint não inicia a devolução. Credita ao pagador original o valor retornado, sujeito a um teto cumulativo sobre os valores retornados, deduplica pelo id ponta a ponta de retorno atribuído pelo upstream e retorna o reconhecimento de crédito do gateway de liquidação.



## OpenAPI

````yaml pt/openapi/v3-current/pix.yaml POST /v1/webhooks/refunds
openapi: 3.0.3
info:
  title: Plugin BR Pix Direct - API Completa
  description: >
    API completa para o sistema de pagamentos instantaneos PIX brasileiro,
    incluindo

    operacoes de dicionario de chaves PIX, geracao/decodificacao de QR codes,
    transacoes e

    limites de transacao.
  version: 1.0.0
servers:
  - url: https://plugin-pix-direct.api.lerian.net
  - url: https://plugin-pix-direct-qrcode.api.lerian.net
security:
  - bearerAuth: []
paths:
  /v1/webhooks/refunds:
    post:
      tags:
        - Webhooks API
      summary: Processar devolução Pix iniciada pelo banco recebedor
      description: >-
        Processa uma devolução Pix iniciada pelo banco recebedor e enviada pelo
        sistema upstream; este endpoint não inicia a devolução. Credita ao
        pagador original o valor retornado, sujeito a um teto cumulativo sobre
        os valores retornados, deduplica pelo id ponta a ponta de retorno
        atribuído pelo upstream e retorna o reconhecimento de crédito do gateway
        de liquidação.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalRefundBody'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalRefundResponse'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Erro
components:
  schemas:
    ExternalRefundBody:
      additionalProperties: false
      properties:
        codigoDevolucao:
          description: Código de motivo de retorno (eRefundCode).
          type: string
        endToEndIdDevolucao:
          description: >-
            Id de retorno atribuído pelo upstream (chave de idempotência +
            dedup).
          type: string
        endToEndIdOriginal:
          description: Id ponta a ponta do CASH_OUT original.
          type: string
        idReqJdPi:
          description: Id da requisição upstream (GUID), ecoado no reconhecimento.
          type: string
        infEntreClientes:
          description: Informação inter-clientes em texto livre.
          type: string
        motivoDevolucao:
          description: Motivo de retorno em texto livre.
          type: string
        valor:
          description: Valor de retorno em reais (um número JSON).
          format: double
          type: number
      required:
        - idReqJdPi
        - endToEndIdOriginal
        - endToEndIdDevolucao
        - valor
      type: object
    ExternalRefundResponse:
      additionalProperties: false
      properties:
        dtHrCreditoSgct:
          description: carimbo de data/hora de crédito do gateway de liquidação (ISO-8601).
          type: string
        dtHrValidacao:
          description: Data/hora da validação (ISO-8601).
          type: string
        idCreditoSgct:
          description: id de crédito do gateway de liquidação.
          type: string
        idReqJdPi:
          description: Id da requisição upstream ecoado.
          type: string
        motivo:
          description: Código de motivo (em um retorno rejeitado).
          type: string
        motivoComplemento:
          description: Complemento do motivo.
          type: string
        resultado:
          description: Resultado da validação (0=Inválido, 1=Válido).
          format: int64
          type: integer
      type: object
    Detail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Código de erro de domínio estável e legível por máquina, escopado ao
            serviço emissor (formato: <SERVICE>-NNNN).
          type: string
        detail:
          description: Uma explicação legível específica desta ocorrência do problema.
          type: string
        errors:
          description: Lista opcional de detalhes individuais de erro
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
          nullable: true
        instance:
          description: >-
            Uma referência URI que identifica a ocorrência específica do
            problema.
          format: uri
          type: string
        status:
          description: Código de status HTTP
          format: int64
          type: integer
        title:
          description: >-
            Um resumo curto e legível do tipo de problema. Este valor não deve
            mudar entre ocorrências do erro.
          type: string
        type:
          default: about:blank
          description: Uma referência URI para a documentação legível do erro.
          format: uri
          type: string
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: Onde o erro ocorreu, ex. 'body.items[3].tags' ou 'path.thing-id'
          type: string
        message:
          description: Texto da mensagem de erro
          type: string
        value:
          description: O valor no local informado
      type: object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Autenticacao por token JWT Bearer. Obtenha o token no endpoint
        `/v1/login/oauth/access_token`

        usando credenciais do cliente (clientId e clientSecret).


        Inclua o token no header Authorization:

        `Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...`


        O token expira apos 3600 segundos (1 hora).

````