Skip to main content
Use the environment-specific base URL provided to your integration team. Examples use {baseUrl}.

​
Integration checklist

  • Send X-API-Key on Contributions and Delivery Emissions requests (Authentication).
  • Send Idempotency-Key on contribution confirmation, estimate creation, and emissions association.
  • Use the request body for your Partner’s configured contribution method (Contributions).
  • After a timeout or unknown result, recover before reversing customer value (Errors & Recovery).
Full request and response schemas are on each endpoint page below.

​
Contributions

  • POST /v1/impact-transactions — confirmContribution (Loyalty Points or Direct, method from Partner configuration) — Contributions
  • GET /v1/impact-transactions?partner_event_id= — getContributionByPartnerEventId — Contributions
  • GET /v1/impact-transactions/{transaction_id} — getContributionById — Contributions

​
Delivery Emissions

  • POST /v1/emissions/estimates — createDeliveryEmissionsEstimate — Delivery Emissions
  • GET /v1/emissions/estimates/{calculation_id} — getDeliveryEmissionsEstimate — Delivery Emissions
  • POST /v1/impact-transactions/{transaction_id}/emissions-associations — associateEmissionsEstimate — Delivery Emissions

​
Outbound webhooks

Outbound webhooks are events, not REST paths:
  • impact.transaction.confirmed
  • impact.transaction.adjusted
  • settlement.created
  • settlement.closed
  • environmental.status.updated
See Webhooks for the consumer contract and partner actions. For settlement batch lifecycle (settlement.created, settlement.closed), see Settlement batch webhooks. For planting fulfilment batch lifecycle (environmental.status.updated event version 2), see Planting fulfilment batch webhooks. Event payloads for the other events are on each webhook page below.