Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developers.kulmipay.com/llms.txt

Use this file to discover all available pages before exploring further.

Enable reversal_event to receive notifications when a chargeback is created or its status changes. Chargeback events use the chargeback read shape from the KulmiPay backend, plus your configured challenge.

When it fires

  • A chargeback is created.
  • A chargeback status changes, for example to DISPUTED, OVERDUE, COMPLETED, or CANCELLED.

Payload

{
  "chargeback_id": "CB_12345",
  "session_id": "pay-session-123",
  "transaction": {
    "transaction_id": "txn_xyz789",
    "currency": "KES",
    "value": "1500.00",
    "running_balance": "51500.00",
    "narrative": "M-Pesa collection",
    "trans_type": "SALE",
    "status": "CHARGEBACK-PENDING",
    "created_at": "2026-05-28T08:23:11Z",
    "updated_at": "2026-05-28T08:24:05Z"
  },
  "amount": "1500.00",
  "reason": "Duplicate payment",
  "status": "DISPUTED",
  "resolution": null,
  "staff_created": false,
  "created_at": "2026-05-28T09:00:00Z",
  "updated_at": "2026-05-28T09:10:00Z",
  "challenge": "your-configured-secret"
}

Important fields

FieldDescription
chargeback_idChargeback alias ID.
transactionWallet transaction related to the reversal.
amountAmount under dispute or reversal.
reasonChargeback reason.
statusCurrent chargeback status.
challengeYour configured challenge value. Verify it before processing the event.