PAYMENT SETTLED

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.

Delivery Details

Attribute	Value
HTTP method	`POST`
URL	The webhook URL configured on your merchant account’s API credentials
Content-Type	`application/json`
Timeout	10 seconds
Retries	Up to 5 delivery attempts (backoff: 1 min, 5 min, 15 min, 60 min)

Headers

Header	Description
`Content-Type`	`application/json`
`User-Agent`	`Eximpe-Webhook/1.0`
`X-Webhook-Event`	`PAYMENT_SETTLED`
`X-Webhook-Timestamp`	Unix timestamp (string) at the time of the request
`X-Webhook-Signature`	HMAC-SHA256 signature of the request body (JSON string with keys sorted, no extra whitespace), using your API key as the secret. Hex-encoded.

Signature verification (recommended):
Compute HMAC-SHA256(encryption_key, raw_body) where raw_body is the exact UTF-8 request body as received. Compare the hex result with the X-Webhook-Signature header to ensure the webhook is from the platform and unchanged.

Payload Schema

{
    "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
Data Object Fields

string

required

Always "PAYMENT_SETTLED" for this webhook event

string

required

Timestamp when the event occurred in YYYY-MM-DD HH:MM:SS formatExample: "2024-02-15 16:53:15"

string

required

Webhook payload version (currently “1.0”)

string

required

Unique identifier for the event instanceExample: "a3791670-7c5d-4a86-aa7a-fe35e58a9dbb"

object

required

Event-specific data payload containing settlement details

array

required

Array of settlement objects containing the settlement information

string

required

Unique settlement identifierExample: "ST8174378817"

string

required

UTR (Unique Transaction Reference) for the settlementExample: "ST8174378817"

string

required

ISO 8601 timestamp when the settlement was completedExample: "2025-06-20T19:22:54.734256Z"

number

required

Foreign exchange rate applied to the settlementExample: 86

number

required

Final settlement amount transferred to the merchantExample: 1952.8

Order

Payment

Card Tokens

Merchant

Settlement

Refund

Subscriptions

Payment Links

Utilities

Webhooks

Event Overview

Delivery Details

Headers

Payload Schema

Field Specifications

​Event Overview

​Delivery Details

​Headers

​Payload Schema

​Field Specifications

Event Overview

Delivery Details

Headers

Payload Schema

Field Specifications