v51

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-313352,3122.9 MB

plaid

Simulate a transfer event in Sandbox

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.

post/sandbox/transfer/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.

transfer_idstring required

Plaid's unique identifier for a transfer.

test_clock_idstring 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_typestring required

The asynchronous event to be simulated. May be: posted, settled, failed, funds_available, 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

settled --> funds_available (only applicable to ACH debits.)

webhookstring url

The webhook URL to which a TRANSFER_EVENTS_UPDATE webhook should be sent.

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.