Simulate Round-Up Sweep

Use /v1/roundup/:id/simulateSweep to queue an early execution of the enrollment's current cadence period in a non-production environment. The normal asynchronous sweep process performs aggregation, cadence caps, minimum checks, sufficient-funds validation, funding, receiving deposits, and lifecycle updates. For ACH-funded enrollments the sweep also simulates settlement of the ACH pull so the receiving transfer can run; poll /v1/roundup/:id/listSweepTransfers and correlate by the sweepKey returned in the response. An ACH sweep parked at funding_submitted is settled rather than returned as a no-op, including one left parked by an earlier cadence period; in that case the response returns that sweep's sweepId and sweepKey rather than the current period's, so always poll the key you were given. Otherwise repeated requests in a successfully completed cadence period return the existing sweep, and safe skipped or pre-transfer failed outcomes can be queued for reevaluation.

Path Params
string
required

Unique identifier of the round-up enrollment.

Body Params

POST /v1/roundup/:id/simulateSweep Request body

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json