PAYMENT SETTLED

Technical reference for the PAYMENT_SETTLED webhook event, including payload schema, field specifications, and implementation details.

Event Overview

Event Type: PAYMENT_SETTLED
Category: Settlement
Description: Settlement to merchant has been completed

This webhook is triggered when funds are successfully transferred to the merchant’s account.

Payload Schema

Example Payload

{
    "event_type": "PAYMENT_SETTLED",
    "event_time": "2024-02-15 16:53:15",
    "version": "1.0",
    "sequence_number": "a3791670-7c5d-4a86-aa7a-fe35e58a9dbb",
    "data": {
        "settlements": [
            {
                "settlement_id": "ST8174378817",
                "settlement_utr": "ST8174378817",
                "settlement_done_at": "2025-06-20T19:22:54.734256Z",
                "forex_rate": 86,
                "settlement_amount": 1952.8
            }
        ]
    }
}

Field Specifications

Root Level Fields

event_type · string · required

Always "PAYMENT_SETTLED" for this webhook event

event_time · string · required

Timestamp when the event occurred in YYYY-MM-DD HH:MM:SS format

Example: "2024-02-15 16:53:15"

version · string · required

Webhook payload version (currently “1.0”)

sequence_number · string · required

Unique identifier for the event instance

Example: "a3791670-7c5d-4a86-aa7a-fe35e58a9dbb"

data · object · required

Event-specific data payload containing settlement details

Data Object Fields

data.settlements · array · required

Array of settlement objects containing the settlement information

data.settlements[].settlement_id · string · required

Unique settlement identifier

Example: "ST8174378817"

data.settlements[].settlement_utr · string · required

UTR (Unique Transaction Reference) for the settlement

Example: "ST8174378817"

data.settlements[].settlement_done_at · string · required

ISO 8601 timestamp when the settlement was completed

Example: "2025-06-20T19:22:54.734256Z"

data.settlements[].forex_rate · number · required

Foreign exchange rate applied to the settlement

Example: 86

data.settlements[].settlement_amount · number · required

Final settlement amount transferred to the merchant

Example: 1952.8