Savings

Savings plans automate customer contributions according to the schedule and rules you configure.

Engineering flowBuild, verify, then reconcile

Test this flow in sandbox →

1. 01Create planPersist plan ID, rules, and contribution schedule.
2. 02Process contributionTreat each scheduled outcome as asynchronous.
3. 03Verify outcomeHandle a signed event or status for the specific contribution.
4. 04Update plan stateReconcile balances before pause, withdrawal, or cancellation.

Use a dashboard-issued sandbox API key on your server. Do not enter credentials into this documentation site.

Plan lifecycle

Create plan → schedule contributions → process contribution outcome → update plan state → pause, resume, withdraw, or cancel when permitted

Treat scheduled contributions and withdrawals as asynchronous financial operations. Process verified events once, reconcile failed or uncertain attempts, and never display a contribution as complete from request acceptance alone.

Use Webhooks for delivery safety and the Savings API reference for plan fields and lifecycle operations.