ImpactPay calculator

POST: /impactpay/calculate

The ImpactPay Calculate endpoint can be used in an offline context, e.g. for receipts or emails. Use it when you want a no‑SDK, post‑purchase journey where customers complete their contribution on ekko‑hosted pages.

ℹ️

See the API reference for example payloads.

What it does

• calculates the carbon footprint and compensation amount for the input transaction
• returns a calcReference to add to the base ImpactPay URL, so that the correct values are shown to your customer

Key fields explained

• productId → associates the calculation with your configured product and projects
• amount → object with value and currencyCode used to calculate impact and contribution
• merchant → details including mcc and location to improve impact accuracy
• calcReference → identifier returned by the API to build the hosted URL
• compensation.compensationValue → compensation required to balance this specific transaction (includes ImpactPay service fee)

Best practices

• Use in offline post‑purchase flows, such as emails or receipts