OpenSylo

    Marketplace API Documentation#

    Credit infrastructure that enables marketplaces to share merchant data for credit scoring and lending.

    How It Works#

    OpenSylo sits between your marketplace and lenders. You share merchant performance data, OpenSylo scores it, and lenders use the score to make loan decisions. Repayments are collected through your platform.

    Documentation#

    #GuideDescription
    1IntroductionPlatform overview, architecture, and key concepts
    2Getting StartedPrerequisites, credentials, and first steps
    3OAuth 2.0 FlowAuthorization code flow with PKCE, token management
    4Webhook GuideInbound and outbound webhook integration
    5Data IngestionCredit scoring, loan eligibility, and event-based scoring
    6Loan APILoan queries, deduction validation, and settlement
    7Error ReferenceHTTP codes, error formats, and troubleshooting

    Integration Journey#

    From invitation to live repayment collection in 9 steps:

    Key Concepts#

    ConceptDescription
    MarketplaceYour platform — e-commerce, food delivery, POS, payment gateway, or any platform with merchant data
    MerchantA seller or vendor on your marketplace who consents to share data for credit scoring
    OAuth ConsentThe merchant explicitly authorizes your marketplace to share their data with OpenSylo
    Credit ScoreA 0--100 score calculated from merchant data, mapped to risk tiers A (best) through E (worst)
    Lending CapMaximum loan amount for a merchant, derived from their credit score and sales history
    DeductionA percentage of each merchant sale withheld to repay an active loan

    Data Flow#

    Every piece of data your marketplace sends to OpenSylo feeds into the credit scoring and loan eligibility engine:

    Credit Scoring Model#

    The credit score is a composite of 6 weighted components (100 points max):

    Risk Tiers#

    TierScoreEligible % of Avg Monthly SalesLending Decision
    A80--10040%Highest cap, best pricing
    B65--7930%Standard cap
    C50--6420%Reduced cap, short tenor
    D35--4910%Pilot / small ticket only
    E0--340%Not eligible
    When 6-month sales history is available, loan eligibility is computed using a capacity-based formula that factors in repayment rate, tenor, and interest rate. See the Data Ingestion Guide for details.

    Authentication#

    OpenSylo uses OAuth 2.0 Authorization Code flow with PKCE for all API access.

    Available Scopes#

    ScopeDescription
    data.share.salesShare sales and GMV data
    data.share.fulfillmentShare fulfillment and delivery metrics
    data.share.payoutsShare payout and cash flow data
    data.share.riskShare account risk information
    data.share.profileShare merchant business profile
    credit.score.readRead credit scores
    repayment.reportReport loan repayment collections
    Full details in the OAuth Flow Guide.

    Webhook Lifecycle#

    OpenSylo sends outbound webhooks for loan lifecycle events and receives inbound webhooks for repayment reporting:
    All webhooks are signed with HMAC-SHA256. See the Webhook Guide for verification and retry details.

    Base URL#

    https://api.opensylo.com
    Sandbox mode is automatically detected by the sb_ prefix on your client_id. No separate URL is needed.
    EnvironmentClient ID FormatBehavior
    Productioncli_xxxxxxxxReal data, real loans
    Sandboxsb_cli_xxxxxxxxIsolated test environment, simulated responses

    Quick Start Checklist#

    Accept marketplace invitation email
    Complete registration and onboarding
    Store client_id and client_secret securely
    Register redirect URI(s) in the dashboard
    Implement OAuth 2.0 + PKCE flow (guide)
    Submit first merchant data payload (guide)
    Set up webhook endpoint for loan events (guide)
    Implement repayment deduction and reporting (guide)
    Test end-to-end in sandbox before going live
    Built with