Create carbon quote

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 reused during funds allocation.

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

Body Params
uuid
required
consumer
object
required
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
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
Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Choose an example:
application/json