Integration paths
The right integration approach depends on how much control you need over the experience, how quickly you want to launch and at which point in the payment journey you want to engage consumers. Most partners integrate around a checkout. If you're a bank or engage consumers outside a checkout, you integrate directly with the API, see Integrating as a bank below.
Integration options
| Integration type | Timing | Effort | Best for | Use when | Payment handling |
|---|---|---|---|---|---|
| Direct API integration | Any point in the journey | High | Full control, custom flows, deeper integrations | You want flexibility and can handle the logic server-side | You handle payment |
| Checkout SDK | Pre-purchase | Medium | Embedded experience in checkout | You want to show footprint data and contribution options directly in your checkout flow | You handle payment |
| Post-purchase SDK (page takeover) | Post-purchase | Medium | Full-page journey before redirect | You want to guide consumers through a dedicated post-purchase journey | ekko handles payment |
| Post-purchase SDK (embedded) | Post-purchase | Medium | Inline component on confirmation page | You want a modular component inside your confirmation page that feels native to your site | ekko handles payment |
| ImpactPay URL | Post-purchase | Low | Hosted journey via link | You want to link consumers to a hosted experience from emails, receipts or other channels | ekko handles payment |
Integrating as a bank
Banks integrate through the direct API as the SDKs and ImpactPay are built around a merchant checkout.
Common banking patterns:
- Show the footprint of each card transaction in your app
- Offer round-ups on transactions as contributions to verified environmental projects
See Direct API integration for the step-by-step and the banking patterns.
Choosing a path
Direct API integration
Use the API directly when you want full control over the consumer experience. You handle the footprint display, contribution flow and payment logic on your side. This is the most flexible option but requires the most development effort.
See Direct API integration for a step-by-step guide.
Checkout SDK
The Checkout SDK is a pre-built component you embed in your checkout flow. It supports round-ups and fixed-value contributions. Consumers see the footprint of their purchase and can choose to contribute before they pay. The contribution amount is added to the main payment, which you process. ekko does not handle the payment for this path.
See Checkout SDK for setup instructions.
Post-purchase SDKs
The post-purchase SDKs run after checkout. There are two variants:
- Page takeover: a full-page experience that appears before the consumer is redirected to your confirmation page
- Embedded: an inline component you place inside your existing confirmation page
ekko handles the contribution payment on the hosted page.
See Full page takeover SDK or Embedded SDK for setup instructions.
ImpactPay URL
ImpactPay URL is a hosted experience that you link to from emails, receipts or other channels. The consumer follows the link, sees their footprint and can choose to contribute. ekko handles the contribution payment on the hosted page.
See ImpactPay URL for details.