Create ImpactPay session

post

https://api.ekko.earth/v3/impactpay/sessions

Create an ImpactPay session and return a hosted ImpactPay link.

Body Params

organisationId

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

impactType

string

enum

The impact calculation type. carbon returns a carbon footprint and carbon credit pricing. nature returns a biodiversity (Nature Footprint) calculation in Mean Species Abundance (MSA) and contribution pricing. Defaults to carbon when omitted.

Allowed:

locale

string

required

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

Responses

Language

Credentials

Bearer

Loading…

Response

Choose an example:

application/json

201Created

400Bad request

401Unauthorised

404Not found

500Server error