API Documentation

The Collctiv API is organised around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes.

Getting started

To get started, create your API key in your developer settings, then read about how to make requests for the resources you need to access using our HTTP APIs.

Get your API key

Guides

Authentication

Learn how to authenticate your API requests.

Pagination

Understand how to work with paginated responses.

Errors

Read about the different types of errors returned by the API.

Webhooks

Learn how to programmatically configure webhooks for your app.

Taking payments

Learn how to receive a payment into a pot.

Resources

Customers

Learn about the customer model and how to create, retrieve, update, delete, and list customers.

Pots

Learn about the pot model and how to create, retrieve, update, delete, and list pots.

Payments

Learn about the payment model and how to create, retrieve, update, delete, and list payments.

Orders

Learn about the order model and how to create, retrieve and list orders.

Refunds

Learn about the refund model and how to create, retrieve, and list refunds.

Products

Learn about the product model and how to create, retrieve, and list products.