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 worker performs aggregation, cadence caps, minimum checks, sufficient-funds validation, funding, receiving deposits, and lifecycle updates. Repeated requests in a successfully completed cadence period return the existing sweep; safe skipped or pre-transfer failed outcomes can be queued for reevaluation. Poll /v1/roundup/:id/listSweepTransfers and correlate by sweepKey.

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