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

# Simulate cashout

> Simulate cashout status changes in Sandbox

<Warning>
  This endpoint is only available in the **Sandbox** environment. It does not work with Production credentials.
</Warning>

Simulates a status change for a cashout, allowing you to test your integration without a real bank transfer.

<Note>
  Simulating a status change triggers webhooks normally. If the cashout has a `callbackUrl`, the corresponding webhook will be delivered.
</Note>


## OpenAPI

````yaml api-reference/openapi.json POST /v1/cashouts/{id}/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/cashouts/{id}/simulate:
    post:
      tags:
        - Saques
      summary: Simular saque (Sandbox)
      description: Simula o processamento de um saque no ambiente Sandbox.
      operationId: simulateCashout
      parameters:
        - name: id
          in: path
          required: true
          description: ID do saque
          schema:
            type: string
            format: uuid
            example: b2c3d4e5-f6a7-8901-bcde-f23456789012
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SimulateCashoutRequest'
            example:
              action: 1
      responses:
        '200':
          description: Simulacao realizada
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimulateCashoutResponse'
              example:
                data:
                  id: b2c3d4e5-f6a7-8901-bcde-f23456789012
                  externalId: saque_001
                  amount: 50000
                  fee: 200
                  netAmount: 49800
                  currency: BRL
                  status: Completed
                  environment: Sandbox
                  pix:
                    pixKeyType: CPF
                    pixKey: '***456789**'
                    endToEndId: E12345678202501151600xyz789abc012
                    acquirerTransactionId: SANDBOX_TXN_001
                  requestedAt: '2025-01-15T16:00:00Z'
                  processedAt: '2025-01-15T16:02:00Z'
                  completedAt: '2025-01-15T16:05:00Z'
                  failureReason: null
                  createdAt: '2025-01-15T16:00:00Z'
                message: Saque simulado com sucesso.
                error: null
        '400':
          description: Acao invalida
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimulateCashoutResponse'
              example:
                data: null
                message: null
                error:
                  message: >-
                    O saque precisa estar com status Pending para simular
                    Complete.
                  code: invalid_status
        '401':
          description: Nao autorizado
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimulateCashoutResponse'
              example:
                data: null
                message: null
                error:
                  message: Este endpoint esta disponivel apenas em ambiente Sandbox.
                  code: sandbox_only
        '404':
          description: Saque nao encontrado
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimulateCashoutResponse'
              example:
                data: null
                message: null
                error:
                  message: Saque nao encontrado.
                  code: not_found
components:
  schemas:
    SimulateCashoutRequest:
      type: object
      required:
        - action
      properties:
        action:
          type: integer
          enum:
            - 1
            - 2
            - 3
          description: 'Acao: 1=Complete, 2=Fail, 3=Reject'
          example: 1
    SimulateCashoutResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/SimulateCashoutData'
        message:
          type: string
          nullable: true
        error:
          $ref: '#/components/schemas/ApiErrorResponse'
    SimulateCashoutData:
      type: object
      nullable: true
      properties:
        id:
          type: string
          format: uuid
          example: b2c3d4e5-f6a7-8901-bcde-f23456789012
        externalId:
          type: string
          nullable: true
          example: saque_001
        amount:
          type: integer
          example: 50000
        fee:
          type: integer
          example: 200
        netAmount:
          type: integer
          example: 49800
        currency:
          type: string
          example: BRL
        status:
          type: string
          example: Completed
        environment:
          type: string
          example: Sandbox
        pix:
          $ref: '#/components/schemas/SimulateCashoutPixData'
        requestedAt:
          type: string
          format: date-time
          example: '2025-01-15T16:00:00Z'
        processedAt:
          type: string
          format: date-time
          nullable: true
          example: '2025-01-15T16:02:00Z'
        completedAt:
          type: string
          format: date-time
          nullable: true
          example: '2025-01-15T16:05:00Z'
        failureReason:
          type: string
          nullable: true
          example: null
        createdAt:
          type: string
          format: date-time
          example: '2025-01-15T16:00:00Z'
    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
    SimulateCashoutPixData:
      type: object
      properties:
        pixKeyType:
          type: string
          nullable: true
          example: CPF
        pixKey:
          type: string
          nullable: true
          example: '***456789**'
        endToEndId:
          type: string
          nullable: true
          example: E12345678202501151600xyz789abc012
        acquirerTransactionId:
          type: string
          nullable: true
          example: SANDBOX_TXN_001
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Token JWT obtido via /v1/auth/token

````