Our webhook service enables clients to receive real-time notifications for specific events related to payments on the ImpactPay product. Currently, we support two key events: IMPACT_PAYMENT and IMPACT_PAYMENT_REVERSAL.

This webhook service is designed to inform clients when a compensation payment is processed or reversed, enabling tracking and management of these transactions.

Webhook events

IMPACT_PAYMENT: Fired when a compensation payment is successfully processed.
IMPACT_PAYMENT_REVERSAL: Fired when a previously processed payment is reversed, i.e. voided or refunded.

Webhook payload

Name	Description	Type
`footprintId`	Reference for the ImpactPay calculation - returned during Impact calculation.	String
`organisationId`	Identifier for the organisation associated with the payment.	String
`brandId`	Identifier for the brand associated with the payment.	String
`productId`	Identifier for the product associated with the payment.	String
`customerId`	Unique identifier for the customer making the payment (as provided during ImpactPay API call)	String
`eventType`	Specifies IMPACT_PAYMENT or IMPACT_PAYMENT_REVERSAL	String
`timestamp`	ISO 8601 timestamp indicating when the event occurred	String
`payment`	Details about the payment result.	Object
`payment.amount`	Payment amount in whole units of currency.	Number
`payment.currencyCode`	ISO currency code for the transaction (e.g., GBP).	String
`payment.serviceFee`	Service fee associated with the payment.	Number
`carbon`	Carbon compensation details.	Object
`carbon.unit`	Unit of carbon measurement, e.g., grams.	String
`carbon.quote`	Original carbon quote for the transaction.	Number
`carbon.compensated`	Amount of carbon the customer chose to compensate for.	Number

Example payload

`IMPACT_PAYMENT`

{
  "footprintId": "15372bb6-c7ce-41bf-bb81-e9553de19158",
  "brandId": "e06e3f32-d649-4e4b-a122-99af6f7ff272",
  "customerId": "ef10143b-2d5c-4b44-96e9-93497a5f6a55",
  "eventType": "IMPACT_PAYMENT",
  "timestamp": "2024-10-30T11:18:25.601Z",
  "payment": {
    "amount": 20,
    "currencyCode": "GBP",
    "serviceFee": 1.68
  },
  "carbon": {
    "unit": "grams",
    "quote": 100000,
    "compensated": 20000
  }
}