canonical: https://jentic.com/apis/cheddarup.com/cheddarup # Cheddar Up API Jentic publishes the only available OpenAPI specification for Cheddar Up API, keeping it validated and agent-ready. Cheddar Up is a group payments platform used by schools, sports teams, non-profits, and community groups to collect money online without building a checkout. The API exposes five endpoints for listing and creating collections (payment pages) and for inspecting payments received against them. It is designed for organisers who need to read collection state and reconcile payments programmatically rather than through the Cheddar Up dashboard. ## For AI agents List and create payment collections, and read payments received against them on Cheddar Up across 5 endpoints. ## Scope Does not handle subscriptions, payouts, refunds, or general checkout - use for listing and creating Cheddar Up collections and reading payments only. ## Capabilities - List all collections owned by the authenticated Cheddar Up account - Create a new collection (online payment page) for a group, team, or fundraiser - Retrieve a single collection by id to inspect its configuration and totals - List payments received with filters for reconciliation and reporting - Retrieve a single payment by id to confirm payer details and amount ## Use cases ### School and Club Fundraiser Reconciliation A school treasurer or club administrator needs to reconcile online payments collected via Cheddar Up against an attendance or membership list. The integration calls GET /payments to pull payments and GET `/collections/{id}` to confirm which fundraiser each payment belongs to, producing a single ledger without manual CSV exports. Reduces month-end close from hours to minutes. Example prompt: List payments from the last 30 days, group them by collection id, and produce a CSV of payer name, amount, and collection title. ### Programmatic Collection Setup A non-profit running many small fundraisers can create new Cheddar Up collections programmatically instead of clicking through the dashboard for each event. POST /collections accepts the collection definition; GET /collections then lists everything for portfolio-level reporting. Useful for organisations with templated event types where naming, dates, and item lists follow a pattern. Example prompt: Create a collection titled 'Spring Bake Sale 2026' with closing date 2026-04-15 and return the new collection id. ### Treasurer Dashboard for Community Groups A community group's treasurer wants a live dashboard showing total raised across all active collections without logging into Cheddar Up. The dashboard polls GET /collections and GET /payments and renders running totals per fundraiser. Because the API exposes both collection metadata and individual payments, the dashboard can drill from totals to specific payers when an audit is needed. Example prompt: Fetch all collections, then for each one sum the amounts of payments listed under it and return a leaderboard. ### AI Agent-Driven Group Payment Workflows Through Jentic, an AI agent can answer treasurer-style questions in natural language: 'how much did the spring fundraiser raise?' or 'who has not paid their dues yet?'. The agent searches for 'list cheddar up payments', loads the schema, and executes against a stored API key without ever seeing the raw secret. Pair with email or messaging APIs to send reminders to outstanding payers. Example prompt: Search Jentic for 'list payments', load Cheddar Up's GET /payments schema, and return the total dollar amount received this month. ## Key endpoints | Method | Path | Description | | --- | --- | --- | | GET | `/collections` | List collections | | POST | `/collections` | Create a collection | | GET | `/collections/{id}` | Retrieve a single collection | | GET | `/payments` | List payments | | GET | `/payments/{id}` | Retrieve a single payment | ## Key resources - **collections** — Create, list, and retrieve Cheddar Up payment collections (online payment pages) - **payments** — List and retrieve individual payments received against collections ## Why Jentic - **Setup:** Wiring Cheddar Up by hand means handling its X-API-Key header and sequencing calls across collections and payments yourself. Through Jentic you install once, import the Cheddar Up API from the API Directory, store the key once, and your agent calls it. - **Permission scoping:** Cheddar Up puts the collection id in the URL path (`/collections/{id}`), so a rule can pin your agent to one collection: it can read that collection and its payments and nothing else. You choose the operations it may call, so creating collections is not included unless you add it. - **Credential handling:** Your Cheddar Up API key is stored once, encrypted, by your own Jentic One instance and injected into the X-API-Key header at execution time. It never enters the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'list payments' or 'create a collection', and Jentic returns the matching Cheddar Up operation with its input schema so the agent calls the right endpoint without browsing the reference docs. ## Related APIs - **Stripe API** — Stripe is a general-purpose payments platform used when full developer control over checkout is needed. - **Square API** — Square covers in-person and online payments for small businesses with hardware support. - **Twilio API** — Twilio sends SMS and email reminders for outstanding payments listed by the Cheddar Up API. ## FAQ ### Why is there no official OpenAPI spec for Cheddar Up API? Cheddar Up does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Cheddar Up API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer. ### What authentication does the Cheddar Up API use? The API uses an API key passed in the X-API-Key header. Keys are issued from the Cheddar Up account settings. Through Jentic, the key is stored encrypted in the credential vault and injected at execute time, so the agent never holds the raw key. ### Can I create a new collection with the Cheddar Up API? Yes. POST /collections creates a new collection (online payment page). GET /collections lists existing collections, and GET `/collections/{id}` retrieves a single one for inspection or reporting. ### What are the rate limits for the Cheddar Up API? The OpenAPI spec does not declare numeric rate limits. Cheddar Up's documentation is access-restricted, so production agents should handle 429 responses with exponential backoff and surface limits to the caller when they appear. ### How do I list payments and reconcile them through Jentic? Search Jentic for 'list cheddar up payments', load the schema for GET /payments, and execute. The response can be grouped by collection id and joined against your roster locally - Jentic handles credential injection, you handle the reconciliation logic. ### Can I retrieve a single payment to confirm payer details? Yes. GET `/payments/{id}` returns details for one payment, useful when chasing a specific payer or auditing a flagged transaction. Pair with GET `/collections/{id}` to display the parent collection's title and totals next to the payment record. ### Can I limit what my agent is allowed to do with the Cheddar Up API? Yes. Because Jentic One is self-hosted, you decide which Cheddar Up operations your agent may call: you can allow read-only access to GET /collections, GET `/collections/{id}`, GET /payments, and GET `/payments/{id}` while excluding POST /collections, so the agent cannot create new collections unless you add it. Since Cheddar Up puts the collection id in the URL path, a rule can pin the agent to a single collection, letting it read only that collection and its payments and nothing else. Your rules and stored credentials govern every call the agent makes.