sandboxTransferSimulate
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.
Authorization
PLAID-CLIENT-ID PLAID-SECRET Plaid-Version In: header
In: header
In: header
Request Body
application/json
Defines the request schema for /sandbox/transfer/simulate
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.
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.
Plaid’s unique identifier for a transfer.
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
The failure reason if the type of this transfer is "failed" or "reversed". Null value otherwise.
Response Body
application/json
application/json
curl -X POST "https://example.com/sandbox/transfer/simulate" \ -H "Content-Type: application/json" \ -d '{ "transfer_id": "string", "event_type": "string" }'{ "request_id": "mdqfuVxeoza6mhu"}