Overview
The Settlement Webhook is triggered when a settlement is created or completed for debit transactions under one or more eNACH presentations. This webhook helps merchants reconcile final settlement data including reference numbers and status.
Webhooks are sent per settlement batch as created by the system, and include key details like the settlement ID, amount, date, and bank reference number.
Trigger Points
Webhook is triggered when:
| Event Stage | settlementStatus Value | Description |
|---|---|---|
| Settlement Created | scheduled | Settlement is initiated and queued for transfer |
| Settlement Completed | success | Settlement successfully credited to the merchant's bank account |
Webhook Payload Fields
| Field | Type | Description |
|---|---|---|
settlementId | string | Unique Castler settlement ID |
settlementDate | datetime | Date and time when the settlement was initiated/completed |
settlementAmount | number | Final amount settled to the merchant |
bankReferenceNumber | string | Bank reference number for NEFT/RTGS/IMPS transfer |
settlementStatus | string | scheduled or success |
🔹 Sample Payloads
🟡 1. Settlement Created
{
"settlementId": "C25081607404249884",
"settlementDate": "2025-08-16 10:32:21",
"settlementAmount": 4,
"bankReferenceNumber": "YESB52281256888",
"settlementStatus": "scheduled"
}✅ 2. Settlement Completed
{
"settlementId": "C25081607404249884",
"settlementDate": "2025-08-16 10:32:21",
"settlementAmount": 4,
"bankReferenceNumber": "YESB52281256888",
"settlementStatus": "success"
}