---
title: "Simulate a transfer event in Sandbox"
method: POST
path: "/sandbox/transfer/simulate"
tags: ["plaid"]
---

# Simulate a transfer event in Sandbox

`POST /sandbox/transfer/simulate`

Use the `/sandbox/transfer/simulate` endpoint to simulate a transfer event in the Sandbox environment.  Note that while an event will be simulated and will appear when using endpoints such as `/transfer/event/sync` or `/transfer/event/list`, no transactions will actually take place and funds will not move between accounts, even within the Sandbox.

## Request body

- SandboxTransferSimulateRequest — Defines the request schema for `/sandbox/transfer/simulate`
  - `client_id` string — Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
  - `secret` string — Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
  - `transfer_id` string, required — Plaid’s unique identifier for a transfer.
  - `test_clock_id` string, nullable — Plaid’s unique identifier for a test clock. If provided, the event to be simulated is created at the `virtual_time` on the provided `test_clock`.
  - `event_type` string, required — The asynchronous event to be simulated. May be: `posted`, `settled`, `failed`, or `returned`. An error will be returned if the event type is incompatible with the current transfer status. Compatible status --> event type transitions include: `pending` --> `failed` `pending` --> `posted` `posted` --> `returned` `posted` --> `settled`
  - `failure_reason` TransferFailure, nullable — The failure reason if the event type for a transfer is `"failed"` or `"returned"`. Null value otherwise.
    - `ach_return_code` string, nullable — The ACH return code, e.g. `R01`. A return code will be provided if and only if the transfer status is `returned`. For a full listing of ACH return codes, see [Transfer errors](https://plaid.com/docs/errors/transfer/#ach-return-codes).
    - `description` string — A human-readable description of the reason for the failure or reversal.

## Response `200`

OK

- SandboxTransferSimulateResponse — Defines the response schema for `/sandbox/transfer/simulate`
  - `request_id` string, required — A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

## Other responses

- `default` — Error response

## Changes

- **2024-02-21** `5de70cc1e6ca` — 5 warning, 12 info
  - removed the request property `failure_reason/failure_code`
  - removed the request property `webhook`
  - removed the optional property `error_code_reason` from the response with the `default` status
  - removed the optional property `provided_account_subtypes` from the response with the `default` status
  - …13 more

[Change history](https://skmtc.dev/plaid/apis/the-plaid-api/changes/sandbox/transfer/simulate/post.md)

---

[API](https://skmtc.dev/plaid/apis/the-plaid-api.md) · [All operations](https://skmtc.dev/plaid/apis/the-plaid-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/plaid/the-plaid-api/revisions/a5b45bccb4e8/schema)