Sign in

v51

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-313352,3122.9 MB
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

OK

request_idstring required

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