Endpoints
Our API allows you to add sustainability features to your consumer-facing applications. It offers features for carbon calculation, reversals, ekko’s post-purchase solution ImpactPay as well as carbon compensation and contributions to reputable and vetted impact projects.
See our API reference for full details on payloads.
All records are immutable for audit integrity.
Impact Calculator
POST: /impact_calculator
What it does: Calculates the carbon impact of a transaction in real time and returns a footprint (grams/ ounces) plus a compensation amount.
When to use it: Show customers the carbon impact of their purchase and give them the option to compensate or contribute to sustainability projects.
Funds allocation
POST: /funds
What it does: Makes a contribution or compensation to a portfolio of impact projects, with allocations handled automatically in the backend.
When to use it: Contribute to multiple projects in one call without needing to specify each project individually.
Brand Onboarding
POST: /organisations/brand/onboarding
What it does: Onboards a new brand under an organisation.
When to use it: Set up one or more brands for your organisation to start processing impact transactions.
Reversal
POST: /reversal
What it does: Reverses a portfolio transaction in one go, including all individual contributions that were split and allocated in the backend.
When to use it: A customer requests a refund of a purchase that included a sustainability contribution — ensuring records remain accurate and ekko billing excludes the contribution.
Projects
GET: /products/:productId/projects
What it does: Returns a list of available impact projects, including details such as description, logo, and website.
When to use it: Give customers clear information about the projects their contributions support.
Impact Records
GET: /impact_records
What it does: Retrieves a list of impact transactions (contributions, compensations, and reversals) over a specified time range.
When to use it: Perform reconciliation, reporting, or auditing of impact activity.
Impact Records - Single transaction
GET: /impact_records/transaction
What it does: Retrieves details of a single impact transaction using its referenceId.
When to use it: Look up a specific transaction for reconciliation or audit purposes.
Impact Sessions
POST: /impactpay/sessions
What it does: Calculates carbon impact and a compensation amount for a transaction, and returns a clientSecret plus impactPaySessionId.
When to use it: Enable the ekko ImpactPay post-purchase experience via the SDK.
Checkout Sessions
POST: /checkout/sessions
What it does: Calculates carbon impact and a compensation amount for a transaction, and returns a clientSecret plus checkoutSessionId
When to use it: Power the ekko Checkout SDK for pre-purchase impact experiences directly in checkout.
Updated 7 months ago
