API reference
The Carden v1 HTTP API for preparation, payment outcome reporting, and QuickBooks integration operations.
On this page
Request conventions
Send server-to-server requests to your Carden deployment origin over HTTPS. All endpoint paths below are relative to that origin. Use a Carden API key from the integration's Keys tab in an Authorization: Bearer header. Dashboard sessions and Stripe credentials are not substitutes for this key.
Authorization: Bearer <CARDEN_API_KEY>
Content-Type: application/json
Accept: application/jsonJSON amount fields ending in Minor use integer minor units with an explicit currency. Canonical invoice quantities are decimal strings; individual adapters may impose narrower requirements. Preserve timezone-aware timestamps and stable identifiers across retries.
Endpoints
| Method | Path | Purpose / scope |
|---|---|---|
| POST | /api/v1/stripe/payment-intent-enrichment | Prepare Stripe fields · enrichment:write |
| POST | /api/v1/stripe/payment-reports | Record a payment observation · payments:write |
| POST | /api/v1/integrations/quickbooks/invitations | Invite QuickBooks company authorization · integrations:write |
| GET | /api/v1/integrations/quickbooks/{connectionId}/sync | Read the latest sync state · integrations:read |
| POST | /api/v1/integrations/quickbooks/{connectionId}/sync | Queue invoice import work · integrations:write |
Responses and request IDs
The Stripe endpoints return a resource object, api_version: v1, and data. QuickBooks operation envelopes are documented separately. Read x-carden-request-id from the response header and retain it for troubleshooting. A request ID identifies one HTTP request; it is not a payment idempotency key.
Check the HTTP status and expected response shape before acknowledging work. For report retries, preserve your eventId even though each HTTP attempt may have a different request ID.