CycleSave provides a REST API for developers building custom integrations or external tools.
Base URL: https://yoursite.com/wp-json/cyclesave/v1/
All endpoints that create or modify data require a valid WordPress nonce. You can enable or disable the REST API from Settings → Advanced.
Public Endpoints
| Method |
Endpoint |
Description |
| GET |
/groups |
List all open public groups |
Member Endpoints (Login Required)
| Method |
Endpoint |
Description |
| POST |
/groups/{id}/join |
Join a group (legacy) |
| POST |
/groups/{id}/join-and-pay |
Join and initiate payment in one request |
| GET |
/groups/{id}/payout-order |
Get payout schedule (must be a member) |
| GET |
/gateways/active |
List active payment gateways |
| POST |
/contributions/initiate |
Initiate a one-time contribution payment |
| GET |
/me/contributions |
Get current user’s contribution history |
| GET |
/me/groups |
Get current user’s group memberships |
Admin Endpoints (requires manage_options)
| Method |
Endpoint |
Description |
| PUT/PATCH |
/admin/groups/{id}/payout-order |
Update payout order |
| POST |
/admin/payouts/{id}/log |
Log a manual payout |
| POST |
/admin/members/{id}/remove |
Remove a member from a group |
Webhook Endpoints
| Method |
Endpoint |
Description |
| POST |
?cyclesave-webhook=stripe |
Stripe event receiver |
| POST |
?cyclesave-webhook=paypal |
PayPal event receiver (Pro) |
| POST |
?cyclesave-webhook=paystack |
Paystack event receiver (Pro) |
| POST |
?cyclesave-webhook=flutterwave |
Flutterwave event receiver (Pro) |
| POST |
?cyclesave-webhook=mollie |
Mollie event receiver (Pro) |
| POST |
?cyclesave-webhook=monnify |
Monnify event receiver (Pro) |
