ImpactPay URL
ImpactPay URL is a way to add a post-purchase sustainability journey in contexts such as receipts, email or SMS. Rather than embedding an SDK, you create a session and receive a hosted link that consumers can follow.
You'll need to build and style the link or button in your own UI. The ekko team can support you with design guidance.
How it works
- Create an ImpactPay session using
POST /v3/impactpay/sessions(see Create an ImpactPay session for the full request and response) - The response includes an
impactPayLink: the hosted URL for the consumer - Share the link with the consumer via email, SMS, receipt or any other channel
- The consumer follows the link to an ekko-hosted page where they can view their footprint and choose to contribute or purchase credits
- Contributions and reversals appear in your funds allocation records
Sharing the link
How you share the impactPayLink is up to you. Common approaches include:
- A link or button in a confirmation email
- A text message with the URL
- A QR code on a printed or digital receipt
The footprint and credits data returned by the session endpoint can be displayed alongside the link, for example in an email showing the consumer their footprint before they click through.
Reconciliation
Since ekko processes the payment on the hosted page, contributions appear in your funds allocation records automatically. Set up webhooks to receive notifications when a consumer completes a contribution or when a reversal occurs.
Use GET /v3/funds-allocations to retrieve records for reconciliation. See Reconciliation for details.
