Repayment events

POST

/api/v1/webhooks/marketplace/repayment

Receives repayment events from the marketplace: deductions, failures, and reversals.
The request body is polymorphic, discriminated by the event field.

Supported events:

repayment.deducted -- A repayment was successfully deducted from a sale

repayment.failed -- A repayment deduction attempt failed

repayment.reversed -- A previously successful deduction was reversed

Idempotency: Events are deduplicated by event_id. Duplicate events
receive a duplicate status in the response.

Request

Authorization

API Key

Add parameter in header

X-Marketplace-Signature

Example:

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

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

Webhook processed.

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🟠409

🟠429

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.opensylo.com/api/v1/webhooks/marketplace/repayment' \
--header 'X-Marketplace-Timestamp: 1712495400' \
--header 'X-Marketplace-Id: mkt_live_abc123def456' \
--header 'X-Marketplace-Event-Id: evt_rp_20260407_001' \
--header 'X-Marketplace-Signature: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "event": "repayment.deducted",
    "event_id": "evt_rp_deducted_20260407_001",
    "timestamp": "2026-04-07T14:30:00.000Z",
    "marketplace": {
        "id": "mkt_live_abc123def456",
        "name": "Jumia Nigeria"
    },
    "merchant": {
        "marketplace_id": "PLT_MERCH_001",
        "opensylo_id": "mch_a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    },
    "loan": {
        "opensylo_id": "loan_f1e2d3c4-b5a6-7890-1234-567890abcdef",
        "opensylo_reference": "OSL-2026-00142"
    },
    "deduction": {
        "reference": "DED-20260407-001",
        "amount": 5000,
        "currency": "NGN",
        "deducted_at": "2026-04-07T14:30:00.000Z"
    },
    "source_transaction": {
        "id": "ORD-2026-00543",
        "type": "sale",
        "gross_amount": 50000,
        "timestamp": "2026-04-07T14:25:00.000Z"
    },
    "loan_balance": {
        "total_due": 1725000,
        "total_paid": 350000,
        "outstanding": 1375000
    }
}'

Response Example

200 - Success Example

{
    "status": "received",
    "event_id": "evt_rp_20260407_001",
    "opensylo_reference": "txn_a1b2c3d4",
    "received_at": "2026-04-07T14:30:00.000Z"
}

Modified at 2026-08-05 07:02:04

Bulk loan status

Settlement events