ImpactPay URL
The ImpactPay URL is a way to add a post-purchase impact journey in an offline context such as receipts, email, or SMS. Rather than embedding an SDK, you generate a hosted link that customers can follow.
While simple to implement, it does mean you’ll need to build and style the component or link in your own UI. Our team can support you with design guidance to make sure the experience feels seamless.
Step-by-step flow
-
Create a brand. Use
POST /organisations/brand/onboardingto create a brand and get aproductId. -
Calculate carbon impact. Call
POST /impactpay/calculatewith theproductIdand order details. The response includes acalcReference. -
Build the hosted URL. Construct the ImpactPay URL with the
calcReference:- Sandbox:
https://impactpay-sandbox.ekko.earth/carbon?referenceId=<CALCREFERENCE> - Production:
https://impactpay.ekko.earth/carbon?referenceId=<CALCREFERENCE>
- Sandbox:
-
Share the URL with customers. Add it to SMS, receipts, or post-purchase emails. Customers are taken to an ekko-hosted page where they can review their impact and make a contribution.
-
Records and reconciliation. Contributions and reversals appear in Impact Records. Since ekko processes the contribution, settlement shows
fundsFlow = receivablefor the client’s service-fee share.
Best practices
- Use this flow when you want to add an impact journey in an offline context
- Set up webhooks to be notified of consumer compensations
- Track click-through and compensation rates to measure engagement
Updated 7 months ago
