API Reference
Transactions
IMPORTANT: The transactions API is still in closed development phase. If you would like early access to enable logging of your transactions, please contact us here with details about your company and intended API usage.
The Transactions endpoints allow you to log and manage carbon offset project transactions. These endpoints enable recording purchases or sales of carbon offsets, which are used for manual billing at the end of each month.
Note: These endpoints record transactions only and do not process payments.
Available Endpoints
| Endpoint | Method | Description |
|---|---|---|
/transactions | POST | Create a new transaction record |
/transactions | GET | Retrieve a paginated list of transactions |
/transactions/{id} | GET | Get details of a specific transaction |
/transactions/{id} | DELETE | Remove a transaction record |
Transaction Object
| Field | Type | Description |
|---|---|---|
transaction_id | string | Unique identifier for the transaction |
project_id | string | ID of the carbon offset project |
transaction_type | string | Type of transaction (currently only purchase) |
quantity | integer | Number of carbon offsets (in tonnes) |
status | string | Read-only transaction status, managed by One Tribe admins: |
- ordered: Initial state when transaction is created | ||
- accepted: Transaction has been approved by One Tribe | ||
- retired: Carbon credits have been retired with registry | ||
- completed: Final state, all processes complete | ||
description | string | Additional context or notes about the transaction |
metadata | object | Optional unstructured JSON for custom data storage |
createdAt | string | ISO 8601 timestamp of when the transaction was created |
updatedAt | string | ISO 8601 timestamp of when the transaction was last updated |
Error Responses
| Status Code | Error Code | Description |
|---|---|---|
| 400 | BadRequest | Invalid request body or missing required fields |
| 401 | Unauthorized | Missing or invalid API key |
| 403 | Forbidden | Insufficient permissions to manage transactions |
| 404 | NotFound | Transaction or project not found |
| 429 | TooManyRequests | Rate limit exceeded - please wait before making more requests |
| 500 | ServerError | Internal server error - please contact support |