Contributions

Recover contribution status by partner_event_id

Recover contribution status by partner_event_id after a timeout or unknown result.

contribution_not_found is not a final failed outcome and does not authorize point restoration. Retry the original confirmation with the same Idempotency-Key, partner_event_id, partner_order_ref, and payload.
pending: continue recovery; do not restore points.
confirmed: terminal success; do not restore points.
failed: terminal failure; you may restore points.
Association failure does not change contribution status or authorize point restoration.

GET

impact-transactions

cURL

curl -X GET "{baseUrl}/v1/impact-transactions?partner_event_id=evt_contrib_01HZX5A1B2C3D4E5F6G7H8J9" \
  -H "X-API-Key: $AKHDAR_API_KEY"

import os
import requests

response = requests.get(
    f"{baseUrl}/v1/impact-transactions",
    headers={"X-API-Key": os.environ["AKHDAR_API_KEY"]},
    params={"partner_event_id": "evt_contrib_01HZX5A1B2C3D4E5F6G7H8J9"},
)

{
  "contribution": {
    "transaction_id": "txn_01HZX6M4N5P6Q7R8S9T0U1V2",
    "partner_event_id": "evt_contrib_01HZX5A1B2C3D4E5F6G7H8J9",
    "partner_order_ref": "ord_9f3c2a71",
    "status": "confirmed",
    "points": 500,
    "opaque_customer_ref": "cust_ref_8a1b2c3d",
    "contribution_rule_version": "CRV-v1.0.0",
    "point_conversion_version": "PCV-v1.0.0",
    "tree_cost_version": "TCV-v1.0.0",
    "expected_environmental_support": {
      "summary_en": "Support tree planting",
      "summary_ar": "ادعم زراعة الشجر"
    },
    "non_refundable": true,
    "environment": "sandbox",
    "created_at": "2026-08-03T12:05:00.000Z",
    "confirmed_at": "2026-08-03T12:05:00.000Z",
    "failed_at": null
  },
  "association": {
    "status": "associated",
    "link": {
      "association_id": "link_01HZX7A1B2C3D4E5F6G7H8J9",
      "transaction_id": "txn_01HZX6M4N5P6Q7R8S9T0U1V2",
      "calculation_id": "calc_01HZX4K9M2Q8R7N6P5T4V3W2X1",
      "partner_order_ref": "ord_9f3c2a71",
      "estimated_emissions_kgco2e": "1.059902",
      "estimated_emissions_unit": "kgco2e",
      "distance_km": "7.400",
      "distance_unit": "km",
      "vehicle_category": "motorcycle_gasoline",
      "methodology_version": "DEM-WTW-v1.0.0",
      "emission_factor_version": "EF-DESNZ-2026-MOTORCYCLE-GASOLINE-AVG-WTW-v1.0.0",
      "calculated_at": "2026-08-03T12:00:00.000Z",
      "associated_at": "2026-08-03T12:05:00.000Z",
      "environment": "sandbox",
      "immutable": true
    }
  },
  "request": {
    "correlation_id": "corr_7c2e9b1a4d6f8e0c"
  }
}

Authorizations

X-API-Key

string

header

required

Canonical server-to-server API key header name: X-API-Key. Partner customer applications must not use this credential. Examples must never include raw API secrets.

Headers

X-Correlation-ID

string

Optional request correlation header. If omitted, Akhdar generates one. Every success and error response includes X-Correlation-ID. Error payloads include correlation_id.

Non-PII request correlation identifier.

Required string length: 8 - 128

Pattern: ^[A-Za-z0-9._:-]+$

Example:

"corr_7c2e9b1a4d6f8e0c"

Query Parameters

partner_event_id

string

required

Contribution idempotency and recovery key. Stable contribution idempotency and recovery key supplied by the partner. Distinct from partner_order_ref.

Required string length: 8 - 128

Pattern: ^[A-Za-z0-9._:-]+$

Example:

"evt_contrib_01HZX5A1B2C3D4E5F6G7H8J9"

Response

Contribution found for the authenticated partner and environment.

contribution

object

required

Show child attributes

association

object

required

Recoverable association state. Independent from contribution terminal status.

Option 1
Option 2
Option 3

Show child attributes

request

object

required

Show child attributes

environmental_fulfilment

null | object

read-only

Actual fulfilment status. Null for pending or failed contributions, or when none exists. Confirmed contributions have a 1:1 fulfilment.

Show child attributes

linked_adjustment

null | object

Linked adjustment for this confirmed contribution, when one exists. Null when none. Read-only.

Show child attributes

⌘I

cURL

curl -X GET "{baseUrl}/v1/impact-transactions?partner_event_id=evt_contrib_01HZX5A1B2C3D4E5F6G7H8J9" \
  -H "X-API-Key: $AKHDAR_API_KEY"

import os
import requests

response = requests.get(
    f"{baseUrl}/v1/impact-transactions",
    headers={"X-API-Key": os.environ["AKHDAR_API_KEY"]},
    params={"partner_event_id": "evt_contrib_01HZX5A1B2C3D4E5F6G7H8J9"},
)

{
  "contribution": {
    "transaction_id": "txn_01HZX6M4N5P6Q7R8S9T0U1V2",
    "partner_event_id": "evt_contrib_01HZX5A1B2C3D4E5F6G7H8J9",
    "partner_order_ref": "ord_9f3c2a71",
    "status": "confirmed",
    "points": 500,
    "opaque_customer_ref": "cust_ref_8a1b2c3d",
    "contribution_rule_version": "CRV-v1.0.0",
    "point_conversion_version": "PCV-v1.0.0",
    "tree_cost_version": "TCV-v1.0.0",
    "expected_environmental_support": {
      "summary_en": "Support tree planting",
      "summary_ar": "ادعم زراعة الشجر"
    },
    "non_refundable": true,
    "environment": "sandbox",
    "created_at": "2026-08-03T12:05:00.000Z",
    "confirmed_at": "2026-08-03T12:05:00.000Z",
    "failed_at": null
  },
  "association": {
    "status": "associated",
    "link": {
      "association_id": "link_01HZX7A1B2C3D4E5F6G7H8J9",
      "transaction_id": "txn_01HZX6M4N5P6Q7R8S9T0U1V2",
      "calculation_id": "calc_01HZX4K9M2Q8R7N6P5T4V3W2X1",
      "partner_order_ref": "ord_9f3c2a71",
      "estimated_emissions_kgco2e": "1.059902",
      "estimated_emissions_unit": "kgco2e",
      "distance_km": "7.400",
      "distance_unit": "km",
      "vehicle_category": "motorcycle_gasoline",
      "methodology_version": "DEM-WTW-v1.0.0",
      "emission_factor_version": "EF-DESNZ-2026-MOTORCYCLE-GASOLINE-AVG-WTW-v1.0.0",
      "calculated_at": "2026-08-03T12:00:00.000Z",
      "associated_at": "2026-08-03T12:05:00.000Z",
      "environment": "sandbox",
      "immutable": true
    }
  },
  "request": {
    "correlation_id": "corr_7c2e9b1a4d6f8e0c"
  }
}

Overview

Contributions

Delivery Emissions

Webhooks

Recover contribution status by partner_event_id

Authorizations

Headers

Query Parameters

Response