OpenSylo Marketplace API
    OpenSylo Marketplace API
    • Introduction
    • Getting Started
    • OAuth 2.0 Flow
    • Webhook Integration
    • Sandbox Testing
    • Error Reference
    • Marketplace Dashboard
      • Login to the marketplace dashboard
      • View OAuth credentials
      • Regenerate client secret
    • OAuth 2.0
      • Start OAuth authorization
      • Exchange code or refresh token
      • Revoke a token
      • OAuth discovery / client metadata
    • Data Ingestion
      • Submit single merchant data
      • Submit bulk merchant data
      • Get merchant credit score
      • Integration health check
    • Loan API
      • Get active loans for a merchant
      • Get loan status
      • Validate deduction amounts
      • Bulk loan status check
    • Inbound Webhooks
      • Send repayment webhook
      • Send settlement webhook
    • Sandbox
      • Sandbox environment info
      • Get sandbox test credentials
      • Get sandbox test merchants
    • Schemas
      • DashboardLoginRequest
      • DashboardLoginResponse
      • CredentialsResponse
      • RegenerateSecretResponse
      • TokenRequest
      • TokenResponse
      • RevokeRequest
      • ClientMetadataResponse
      • MerchantIdentity
      • SalesPerformance
      • RevenueConsistency
      • FulfillmentMetrics
      • PayoutCashFlow
      • PlatformDependency
      • HistoricalCredit
      • BehavioralRisk
      • MerchantDataRequest
      • ScoreBreakdown
      • CreditScore
      • MerchantDataResponse
      • BulkMerchantDataRequest
      • BulkMerchantDataResponse
      • CreditScoreResponse
      • HealthResponse
      • ActiveLoansResponse
      • LoanStatusResponse
      • ValidateDeductionsRequest
      • ValidateDeductionsResponse
      • BulkLoanStatusRequest
      • BulkLoanStatusResponse
      • RepaymentWebhookRequest
      • SettlementWebhookRequest
      • WebhookAckResponse
      • SandboxInfoResponse
      • SandboxCredentialsResponse
      • SandboxMerchantsResponse
      • OAuthError
      • ApiError

    SettlementWebhookRequest

    {
        "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"
        }
    }
    Built with