---
title: "(Deprecated) Simulate a bank transfer event in Sandbox"
method: POST
path: "/sandbox/bank_transfer/simulate"
tags: ["plaid"]
deprecated: true
---

# (Deprecated) Simulate a bank transfer event in Sandbox

`POST /sandbox/bank_transfer/simulate`

> **Deprecated.**

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

## Request body

- SandboxBankTransferSimulateRequest — Defines the request schema for `/sandbox/bank_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.
  - `bank_transfer_id` string, required — Plaid's unique identifier for a bank transfer.
  - `event_type` string, required — The asynchronous event to be simulated. May be: `posted`, `failed`, or `reversed`. 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` --> `reversed`
  - `failure_reason` BankTransferFailure, nullable — The failure reason if the type of this transfer is `"failed"` or `"reversed"`. 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 `reversed`. For a full listing of ACH return codes, see [Bank Transfers errors](https://plaid.com/docs/errors/bank-transfers/#ach-return-codes).
    - `description` string — A human-readable description of the reason for the failure or reversal.

## Response `200`

OK

- SandboxBankTransferSimulateResponse — Defines the response schema for `/sandbox/bank_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

---

[API](https://skmtc.net/plaid/apis/the-plaid-api.md) · [All operations](https://skmtc.net/plaid/apis/the-plaid-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/plaid/the-plaid-api/versions/64c4514ea59b/schema)