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

# Simular devolução

> Força o evento refund para uma transação cujo processador é elegível para simulação em modo de teste.

## Comportamento observado

* Use esta rota somente quando o processador estiver em modo de teste e aceitar este auxiliar.
* O modo de teste é necessário, mas não garante que o processador seja elegível.
* A simulação emite o webhook `refund` quando altera a transação.
* A rota é pública no Gateway atual. Restrinja o acesso ao ambiente de sandbox pela rede e pela configuração do ambiente.

> [!NOTE]
>
> Os exemplos usam identificadores e credenciais sintéticos. Os resultados do processador dependem do credenciamento e da configuração do estabelecimento.


## OpenAPI

````yaml openapi.json GET /api/transactions/{id}/refund
openapi: 3.1.0
info:
  title: Azentech Payments API
  version: 1.0.0
  description: >-
    Contrato HTTP público das operações de pagamento, consulta, sandbox e
    webhooks da Azentech. A especificação contém apenas o ambiente de
    homologação confirmado.
servers:
  - url: https://gateway.staging.azentech.dev
    description: Homologação (staging)
security: []
tags:
  - name: Pix
    description: Cobranças, pagamentos, aportes, retiradas e jornada biométrica.
  - name: Transações
    description: Consulta e reembolso de transações.
  - name: Saldos
    description: Saldos atuais, históricos e resumo financeiro.
  - name: Relatórios
    description: Extrato e posição financeira.
  - name: Sandbox
    description: Simulações disponíveis para processadores elegíveis em modo de teste.
paths:
  /api/transactions/{id}/refund:
    get:
      tags:
        - Sandbox
      summary: Simular devolução
      description: >-
        Força o evento refund para uma transação cujo processador é elegível
        para simulação em modo de teste.
      operationId: reference_sandbox_refund
      parameters:
        - name: id
          in: path
          required: true
          description: processor_transaction_id devolvido no evento da transação.
          schema:
            type: string
      responses:
        '200':
          description: >-
            Resultado textual da simulação. O Laravel serializa a string como
            text/html; charset=UTF-8. Para um processador elegível, o sucesso
            devolve REFUNDED. Quando o processador não é elegível, a rota
            devolve o UUID do evento sem executar a simulação.
          content:
            text/html:
              schema:
                type: string
              examples:
                changed:
                  value: REFUNDED
                not_eligible:
                  value: 60000000-0000-4000-8000-000000000001
        '404':
          description: Evento do processador não encontrado.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GatewayError'
              example:
                error:
                  message: TransactionEvent not found.
                  status: 404
        '500':
          description: Falha interna ou falha não traduzida do processador.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GatewayError'
              example:
                error:
                  message:
                    fatal: >-
                      Something went wrong. Please refer to support with the
                      following code: 0000000000
                  status: 500
      security: []
components:
  schemas:
    GatewayError:
      type: object
      additionalProperties: false
      properties:
        error:
          type: object
          additionalProperties: false
          properties:
            message:
              oneOf:
                - type: string
                - type: object
                  additionalProperties:
                    oneOf:
                      - type: string
                      - type: array
                        items:
                          type: string
              description: Mensagem simples ou mapa de campos para listas de mensagens.
            status:
              type: integer
              description: Código HTTP devolvido.
          required:
            - message
            - status
      required:
        - error

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.