Simulate creating a sweep

POST /sandbox/transfer/sweep/simulate

Use the /sandbox/transfer/sweep/simulate endpoint to create a sweep and associated events in the Sandbox environment. Upon calling this endpoint, all transfers with a sweep status of swept will become swept_settled, all posted or pending transfers with a sweep status of unswept will become swept, and all returned transfers with a sweep status of swept will become return_swept.

Request Body

Required

Defines the request schema for /sandbox/transfer/sweep/simulate

Parameters

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.
test_clock_id
string
Plaid’s unique identifier for a test clock. If provided, the sweep to be simulated is created on the day of the virtual_time on the test_clock. If the date of virtual_time is on weekend or a federal holiday, the next available banking day is used.
webhook
string
The webhook URL to which a TRANSFER_EVENTS_UPDATE webhook should be sent.

Response

Defines the response schema for /sandbox/transfer/sweep/simulate

Response Properties

sweep
object
A sweep returned from the /sandbox/transfer/sweep/simulate endpoint. Can be null if there are no transfers to include in a sweep.
request_id
required, string
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.