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

# Simular transação

> Simule mudanças de status no Sandbox

Simula ações em uma transação no ambiente Sandbox. Use para testar fluxos de pagamento sem dinheiro real.

<Warning>
  Disponível apenas no ambiente **Sandbox**.
</Warning>

<Note>
  A simulação dispara webhooks normalmente, permitindo testar seu endpoint de callback.
</Note>


## OpenAPI

````yaml api-reference/openapi.json POST /v1/transactions/{transactionId}/simulate
openapi: 3.1.1
info:
  title: Safefy - Pix Gateway
  description: >

    ## Introducao


    **Seu parceiro financeiro de confianca.**


    Nos somos a Safefy, uma plataforma especializada em solucoes de pagamento
    PIX. Com um servico personalizado e focado nas suas necessidades, estamos
    prontos para apoiar sua empresa em cada etapa do processo.


    - Conte com o **PIX** como metodo de pagamento rapido, seguro e alinhado com
    as melhores praticas de conformidade e prevencao a fraudes.

    - Gerencie suas financas de forma simples e acessivel por meio de uma
    interface completa e intuitiva.

    - Nosso time de suporte esta sempre disponivel para oferecer um atendimento
    exclusivo e eficiente.


    ## Precisa de Ajuda?


    A equipe da Safefy quer garantir que sua integracao seja um sucesso. Se
    tiver duvidas ou precisar de suporte, nao hesite em nos contatar:


    **suporte@safefypay.com.br**


    ---


    ## Valores Monetarios


    Todos os valores monetarios sao representados em **centavos** (menor unidade
    da moeda).


    | Valor Real | Valor na API |

    |------------|--------------|

    | R$ 1,00    | 100          |

    | R$ 10,50   | 1050         |

    | R$ 100,00  | 10000        |
  contact:
    name: Suporte Safefy
    email: suporte@safefypay.com.br
  version: v1
servers:
  - url: https://api-payment.safefypay.com.br
    description: API de Pagamentos Safefy
security:
  - bearerAuth: []
tags:
  - name: Autenticacao
    description: Endpoints de autenticacao OAuth2
  - name: Transacoes
    description: Gerenciamento de transacoes PIX
  - name: Clientes
    description: Gerenciamento de clientes
  - name: Saldo
    description: Consulta de saldo e volumes
  - name: Saques
    description: Solicitacao e gerenciamento de saques
  - name: Disputas
    description: Consulta de disputas e envio de defesa
paths:
  /v1/transactions/{transactionId}/simulate:
    post:
      tags:
        - Transacoes
      summary: Simular transacao (Sandbox)
      description: Simula acoes em uma transacao no ambiente Sandbox.
      operationId: simulateTransaction
      parameters:
        - name: transactionId
          in: path
          required: true
          description: ID da transacao
          schema:
            type: string
            format: uuid
            example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SimulateTransactionRequest'
            example:
              action: complete
      responses:
        '200':
          description: Simulacao realizada
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimulateTransactionResponse'
              example:
                data:
                  id: a1b2c3d4-e5f6-7890-abcd-ef1234567890
                  status: Completed
                  simulatedAction: complete
                  completedAt: '2025-01-15T15:10:00Z'
                  refundedAt: null
                  pix:
                    txId: SAFEFY2025011512345678901234
                    qrCode: null
                    copyAndPaste: null
                    expiresAt: null
                message: Transacao simulada com sucesso.
                error: null
        '400':
          description: Acao invalida
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimulateTransactionResponse'
              example:
                data: null
                message: null
                error:
                  message: >-
                    A transacao precisa estar com status Pending para simular
                    complete.
                  code: invalid_status
        '401':
          description: Nao autorizado
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimulateTransactionResponse'
              example:
                data: null
                message: null
                error:
                  message: Este endpoint esta disponivel apenas em ambiente Sandbox.
                  code: sandbox_only
        '404':
          description: Transacao nao encontrada
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimulateTransactionResponse'
              example:
                data: null
                message: null
                error:
                  message: Transacao nao encontrada.
                  code: not_found
components:
  schemas:
    SimulateTransactionRequest:
      type: object
      required:
        - action
      properties:
        action:
          type: string
          enum:
            - complete
            - expire
            - fail
            - refund
          description: Acao a simular
          example: complete
    SimulateTransactionResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/TransactionSimulation'
        message:
          type: string
          nullable: true
        error:
          $ref: '#/components/schemas/ApiErrorResponse'
    TransactionSimulation:
      type: object
      nullable: true
      properties:
        id:
          type: string
          format: uuid
          example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
        status:
          type: string
          example: Completed
        simulatedAction:
          type: string
          example: complete
        completedAt:
          type: string
          format: date-time
          nullable: true
          example: '2025-01-15T15:10:00Z'
        refundedAt:
          type: string
          format: date-time
          nullable: true
          example: null
        pix:
          $ref: '#/components/schemas/PixTransactionData'
    ApiErrorResponse:
      type: object
      nullable: true
      properties:
        message:
          type: string
          description: Mensagem de erro
          example: Token invalido ou expirado.
        code:
          type: string
          description: Codigo do erro
          example: unauthorized
    PixTransactionData:
      type: object
      nullable: true
      description: >-
        Dados do PIX. A imagem do QR Code não é retornada - use uma biblioteca
        de QR Code para gerar a imagem a partir do copyAndPaste.
      properties:
        txId:
          type: string
          description: ID da transacao PIX (TxId)
          example: SAFEFY2025011512345678901234
        copyAndPaste:
          type: string
          description: >-
            Codigo PIX Copia e Cola (BR Code). Use este codigo para gerar a
            imagem do QR Code no seu frontend.
          example: >-
            00020126580014br.gov.bcb.pix0136a1b2c3d4-e5f6-7890-abcd-ef1234567890...
        expiresAt:
          type: string
          format: date-time
          description: Data de expiracao do codigo PIX
          example: '2025-01-15T15:30:00Z'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Token JWT obtido via /v1/auth/token

````