Create carbon quote

post

https://api.ekko.earth/v3/quotes/carbon

Generate an impact quote for a transaction.

This endpoint calculates the carbon footprint of a transaction and locks in pricing and tax rates for any related carbon credits and sustainability contributions.

The returned quote must be used during funds allocation. One quote can be allocated funds once.

Sending sessionReference is optional but recommended. It ties the quotes for one order, cart or checkout together, so quotes sharing a reference are grouped as one session and can be matched back to your own records.

Each quote includes a carbon footprint calculation with localised equivalents, a carbon credit quote and sustainability contribution data.

Body Params

organisationId

uuid

required

sessionReference

string

length between 1 and 255

Optional but recommended. Ties the quotes for one order, cart or checkout together: quotes sent with the same reference belong to one session. Use a value unique to the session.

Do not include personal data.

consumer

object

required

The consumer making the transaction.

merchant

object | null

Required if an MCC was not provided during organisation onboarding.

If the organisation has an MCC set, you can omit the merchant object.

transaction

object

required

orderItems

array of objects | null

orderItems

projectFilters

object | null

locale

string

required

Defaults to en-GB

Locale is used to localise the footprint equivalents returned in the response. If the requested locale is not supported, it defaults to en-GB.

responseOptions

object | null

Headers

Ekko-Version

string

required

^\d{4}-\d{2}-\d{2}\.[a-z]+$

Defaults to 2026-10-06.pangolin

The API version the request was built against, as YYYY-MM-DD.animal. Required on every request. See Versioning.

Idempotency-Key

string

length between 1 and 255

Optional but recommended on every POST. A retry that carries the same key returns the first attempt's outcome instead of performing the operation twice.

Reuse the key on every retry. A different request needs a different key. See Idempotency.

Responses

201Created

400Bad request, including IDEMPOTENCY_KEY_INVALID

401Unauthorised

403Forbidden. The organisation is not within your organisation hierarchy.

404Not found

409Conflict: NO_ACTIVE_IMPACT_PARTNERS, IDEMPOTENCY_KEY_IN_FLIGHT or IDEMPOTENCY_RESOURCE_GONE

422Unprocessable entity: no exchange rate for the currency, no merchant category code, or IDEMPOTENCY_KEY_REUSED

500Server error

503Service unavailable: idempotency store unreachable, SERVICE_UNAVAILABLE