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

# Procesar una devolução Pix iniciada por el banco del beneficiario

> Procesa una devolução Pix iniciada por el banco del beneficiario y enviada por el sistema upstream; este endpoint no inicia la devolución. Acredita al pagador original el monto devuelto, sujeto a un tope acumulativo sobre los montos devueltos, deduplica sobre el end-to-end id de retorno asignado por el upstream y devuelve el acuse de crédito del settlement-gateway.



## OpenAPI

````yaml es/openapi/v3-current/pix.yaml POST /v1/webhooks/refunds
openapi: 3.0.3
info:
  title: Plugin BR Pix Directo - API completa
  description: >
    API completa para el sistema de pagos instantáneos Pix de Brasil,

    que incluye operaciones del diccionario de claves Pix,
    generación/decodificación

    de códigos QR, transacciones y límites transaccionales.
  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: Procesar una devolução Pix iniciada por el banco del beneficiario
      description: >-
        Procesa una devolução Pix iniciada por el banco del beneficiario y
        enviada por el sistema upstream; este endpoint no inicia la devolución.
        Acredita al pagador original el monto devuelto, sujeto a un tope
        acumulativo sobre los montos devueltos, deduplica sobre el end-to-end id
        de retorno asignado por el upstream y devuelve el acuse de crédito del
        settlement-gateway.
      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: Error
components:
  schemas:
    ExternalRefundBody:
      additionalProperties: false
      properties:
        codigoDevolucao:
          description: Código de motivo de retorno (eRefundCode).
          type: string
        endToEndIdDevolucao:
          description: >-
            Id de retorno asignado por el upstream (clave de idempotencia +
            deduplicación).
          type: string
        endToEndIdOriginal:
          description: End-to-end id del CASH_OUT original.
          type: string
        idReqJdPi:
          description: Id de solicitud del upstream (GUID), reflejado en el acuse.
          type: string
        infEntreClientes:
          description: Información entre clientes de texto libre.
          type: string
        motivoDevolucao:
          description: Motivo de retorno de texto libre.
          type: string
        valor:
          description: Monto de retorno en reales (un número JSON).
          format: double
          type: number
      required:
        - idReqJdPi
        - endToEndIdOriginal
        - endToEndIdDevolucao
        - valor
      type: object
    ExternalRefundResponse:
      additionalProperties: false
      properties:
        dtHrCreditoSgct:
          description: Marca de tiempo del crédito del settlement-gateway (ISO-8601).
          type: string
        dtHrValidacao:
          description: Marca de tiempo de la validación (ISO-8601).
          type: string
        idCreditoSgct:
          description: Id de crédito del settlement-gateway.
          type: string
        idReqJdPi:
          description: Id de solicitud del upstream, reflejado.
          type: string
        motivo:
          description: Código de motivo (en un retorno rechazado).
          type: string
        motivoComplemento:
          description: Complemento del motivo.
          type: string
        resultado:
          description: Resultado de la validación (0=Inválido, 1=Válido).
          format: int64
          type: integer
      type: object
    Detail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Código de error de dominio estable y legible por máquina, acotado al
            servicio emisor (formato: <SERVICE>-NNNN).
          type: string
        detail:
          description: >-
            Una explicación legible para humanos específica de esta ocurrencia
            del problema.
          type: string
        errors:
          description: Lista opcional de detalles de error individuales
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
          nullable: true
        instance:
          description: >-
            Una referencia URI que identifica la ocurrencia específica del
            problema.
          format: uri
          type: string
        status:
          description: Código de estado HTTP
          format: int64
          type: integer
        title:
          description: >-
            Un resumen breve y legible para humanos del tipo de problema. Este
            valor no debería cambiar entre ocurrencias del error.
          type: string
        type:
          default: about:blank
          description: >-
            Una referencia URI a la documentación legible para humanos del
            error.
          format: uri
          type: string
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: >-
            Dónde ocurrió el error, p. ej. 'body.items[3].tags' o
            'path.thing-id'
          type: string
        message:
          description: Texto del mensaje de error
          type: string
        value:
          description: El valor en la ubicación indicada
      type: object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Autenticación con token JWT Bearer. Obtén el token desde el endpoint
        `/v1/login/oauth/access_token`

        usando credenciales de cliente (`clientId` y `clientSecret`).


        Incluye el token en el encabezado Authorization:

        `Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...`


        El token expira después de 3600 segundos (1 hora).

````