Send settlement webhook

POST

/api/v1/webhooks/marketplace/settlement

Send a settlement event (created, transferred) from your marketplace to OpenSylo. Uses the same HMAC-SHA256 signature authentication as the repayment endpoint.

Request

Authorization

API Key

Add parameter in header

X-Marketplace-Signature

Example:

X-Marketplace-Signature: ********************

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Webhook received

Body

🟠401

🟠409

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.opensylo.com/api/v1/webhooks/marketplace/settlement' \
--header 'X-Marketplace-Timestamp: 1706529000' \
--header 'X-Marketplace-Id: marketplace_uuid' \
--header 'X-Marketplace-Event-Id: evt_stl_001' \
--header 'X-Marketplace-Signature: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "event": "settlement.created",
    "event_id": "evt_stl_001",
    "timestamp": "2026-01-29T11:00:00.000Z",
    "marketplace": {
        "id": "marketplace_uuid",
        "name": "Your Marketplace"
    },
    "merchant": {
        "marketplace_id": "your_internal_merchant_id",
        "opensylo_id": "opensylo_merchant_uuid"
    },
    "settlement": {
        "reference": "settle_ref_001",
        "gross_amount": 250000,
        "total_deductions": 25000,
        "net_amount": 225000,
        "currency": "NGN",
        "period_start": "2026-01-22T00:00:00.000Z",
        "period_end": "2026-01-29T00:00:00.000Z"
    }
}'

Response Example

200 - Success

{
    "status": "received",
    "event_id": "evt_stl_001",
    "opensylo_reference": "txn_uuid",
    "received_at": "2026-01-29T11:00:01.000Z"
}

Modified at 2026-01-29 23:19:05

Send repayment webhook

Sandbox environment info