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 |
Integrating as a bank
Banks integrate through the direct API as the SDKs 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.
Updated 14 days ago
