plaid

Simulate a ledger withdraw event in Sandbox

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

post/sandbox/transfer/ledger/withdraw/simulate

Request body

client_idstring

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.

secretstring

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_idstring 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

Response

request_idstring required

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

Changes

Changed in 11 of the 52 revisions of this API.2918

Jul 22, 2026a1bbca01816013See the full diff
- ●
  added the new ASSETS_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ●
  added the new CRA_MONITORING_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ●
  added the new CREDIT_PROFILE_REPORT_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ●
  added the new ENCOMPASS_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ●
  added the new ENRICH_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ●
  added the new FRAUD_INSIGHTS_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ●
  added the new FREDDIE_MAC_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ●
  added the new LINK_DELIVERY_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ●
  added the new PROFILE_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ●
  added the new RECURRING_TRANSACTIONS_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ●
  added the new STATEMENTS_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ●
  added the new TRANSFER_RECURRING_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ●
  added the new TRANSFER_REFUND_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 25, 202680d23bfdc2e51See the full diff
- ●
  added the new IDEMPOTENCY_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
Jun 10, 2026fb8c3f188d8b1See the full diff
- ●
  added the new BASE_REPORT_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Dec 11, 2025465584b48c992See the full diff
- ○
  added the optional property provided_account_subtypes to the response with the default status
  response-optional-property-added
- ○
  added the optional property required_account_subtypes to the response with the default status
  response-optional-property-added
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Nov 19, 20254abee1c569291See the full diff
- ○
  removed the IDENTITY_ERROR enum value from the error_type response property for the response status default
  response-property-enum-value-removed
Nov 12, 2025f8b9f1a857672See the full diff
- ●
  added the new IDENTITY_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ●
  added the new USER_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Oct 22, 2025af4b6e71d87f1See the full diff
- ●
  added the new SIGNAL_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
Mar 26, 202509cbc84449132See the full diff
- ●
  added the new CHECK_REPORT_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ●
  added the new CONSUMER_REPORT_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jan 15, 20255dbeedb718312See the full diff
- ○
  added the new optional request property failure_reason/failure_code
  new-optional-request-property
- ○
  request property failure_reason/ach_return_code deprecated
  request-property-deprecated
This revision also has 15 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Sep 4, 2024a2c34406c31751See the full diff
- ●
  added the new PARTNER_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ●
  added the new SANDBOX_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ●
  added the new TRANSACTIONS_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ●
  added the new TRANSACTION_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ●
  added the new TRANSFER_ERROR enum value to the error_type response property for the response status default
  response-property-enum-value-added
- ○
  added the optional property error_code_reason to the response with the default status
  response-optional-property-added
This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history (11 revisions)