Subscribe to csr.batch.settled

When does csr.batch.settled fire?

The last pending item in a payment batch is matched to a UTR via reconciliation, and the batch has at least one paid item.

What developers build with it

• → Close the loop on bank-file disbursements in your finance system
• → Update payment-batch dashboards / audit logs
• → Trigger a settlement confirmation to programme owners

Sample payload

The full envelope (with HMAC-SHA256 signature, delivery UUID and headers) is documented on the webhooks hub page. Below is the per-event data block for csr.batch.settled:

{
    "batch_id": 4,
    "reference": "PAY-4",
    "total_amount": 550000,
    "item_count": 3,
    "settled_at": "2026-07-12T18:05:00+05:30"
}

Subscribe to this event

From your NGO dashboard, head to System · Webhooks · Add new. Paste your HTTPS endpoint, copy the signing secret, tick csr.batch.settled in the events list, save. The first matching event fires within seconds. Verify the X-Donateazy-Signature header on every request.

// PHP example - drop into your webhook receiver
$raw = file_get_contents('php://input');
$expected = 'sha256=' . hash_hmac('sha256', $raw, $WEBHOOK_SECRET);
if (! hash_equals($expected, $_SERVER['HTTP_X_DONATEAZY_SIGNATURE'] ?? '')) {
    http_response_code(401); exit;
}

$payload = json_decode($raw, true);
if ($payload['event'] !== 'csr.batch.settled') {
    http_response_code(202); exit; // not for this handler
}

// $payload['data'] is the block documented above.
handleCsrBatchSettled($payload['data'], $payload['id']);
http_response_code(200);

Often paired with

All 27 webhook events