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

# Simulate a ledger withdraw event in Sandbox

`POST /sandbox/transfer/ledger/withdraw/simulate`

Use the `/sandbox/transfer/ledger/withdraw/simulate` endpoint to simulate a ledger withdraw event in the Sandbox environment.

## Request body

- SandboxTransferLedgerWithdrawSimulateRequest — Defines the request schema for `/sandbox/transfer/ledger/withdraw/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.
  - `sweep_id` string, required — Plaid's unique identifier for a sweep.
  - `event_type` 'sweep.posted' | 'sweep.settled' | 'sweep.returned' | 'sweep.failed', 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 ledger sweep status. Compatible status --> event type transitions include: `sweep.pending` --> `sweep.posted` `sweep.pending` --> `sweep.failed` `sweep.posted` --> `sweep.settled` `sweep.posted` --> `sweep.returned` `sweep.settled` --> `sweep.returned`
  - `failure_reason` TransferFailure, nullable — The failure reason if the event type for a transfer is `"failed"` or `"returned"`. Null value otherwise.
    - `failure_code` string, nullable — The failure code, e.g. `R01`. A failure code will be provided if and only if the transfer status is `returned`. See [ACH return codes](https://plaid.com/docs/errors/transfer/#ach-return-codes) for a full listing of ACH return codes and [RTP/RfP error codes](https://plaid.com/docs/errors/transfer/#rtprfp-error-codes) for RTP error codes.
    - `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

- SandboxTransferLedgerWithdrawSimulateResponse — Defines the response schema for `/sandbox/transfer/ledger/withdraw/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)