1. Loan API
marketplace-doc
  • Data Ingestion
  • Errors
  • Introduction
  • Loan API & Deduction Lifecycle
  • Getting Started
  • OAuth
  • Webhooks
  • Embedded Journey
  • OpenSylo Marketplace Integration API
    • OAuth 2.0
      • Start OAuth authorization
      • Exchange authorization code or refresh token
      • Revoke a token
      • Discover OAuth capabilities
    • Data Ingestion
      • Submit single merchant data
      • Submit bulk merchant data
      • Poll batch processing status
      • Get merchant credit score
      • Data ingestion health check
    • Sales & Events
      • Submit a sales event
      • Submit a repayment event
      • Submit an account flag
    • Loan API
      • Get active loans for a merchant
      • Get loan status
      • Validate deduction amounts
      • Bulk loan status
    • Inbound Webhooks
      • Repayment events
      • Settlement events
    • Outbound Webhooks
      • loan.approved
      • loan.disbursed
      • loan.repayment_updated
      • loan.nearly_complete
      • loan.completed
      • loan.defaulted
      • merchant.created
      • kyc.submitted
      • kyc.approved
      • kyc.rejected
      • funding_request.created
      • funding_request.fulfilled
      • funding_request.rejected
    • Embedded Journey (Marketplace API)
      • Create (or fetch) a merchant
      • Get merchant status (KYC, credit score, funding requests)
      • Update business KYC information
      • Add directors (bulk)
      • Attach a KYC document
      • Submit KYC for review
      • Submit sales data for credit scoring
      • Create a funding request
      • Mint an embed token for the hosted journey
  • OpenSylo Marketplace API
    • 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
      • Get loan status
        GET
      • Validate deduction amounts
        POST
      • Bulk loan status check
        POST
    • Inbound Webhooks
      • Send repayment webhook
      • Send settlement webhook
  1. Loan API

Get active loans for a merchant

GET
/api/v1/marketplace/loans/active
Retrieve all active (disbursed) loans for a merchant, including repayment terms and outstanding balances.
Required scope: repayment.report

Request

Authorization
Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
or
Query Params

Responses

🟢200OK
application/json
Active loans retrieved
Bodyapplication/json

🟠401Unauthorized
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/api/v1/marketplace/loans/active?merchant_id=your_merchant_id&merchant_id_type=undefined' \
--header 'Authorization: Bearer <token>'
Response Response Example
200 - Success Example
{
    "merchant": {
        "opensylo_id": "merchant_uuid",
        "marketplace_id": "your_merchant_id",
        "name": "Yakoyo Foods Ltd"
    },
    "active_loans": [
        {
            "loan_id": "loan_uuid",
            "reference": "LOAN-2026-001",
            "lender": {
                "id": "lender_uuid",
                "name": "FinCo Lending"
            },
            "status": "DISBURSED",
            "disbursed_at": "2026-01-15T10:00:00.000Z",
            "due_date": "2026-04-15T00:00:00.000Z",
            "terms": {
                "principal_amount": 500000,
                "total_repayment": 525000,
                "currency": "NGN"
            },
            "repayment": {
                "deduction_percentage": 10,
                "minimum_deduction": 500,
                "total_repaid": 200000,
                "outstanding": 325000,
                "is_overdue": false,
                "days_overdue": 0
            },
            "deduction_active": true
        }
    ],
    "summary": {
        "total_active_loans": 1,
        "total_outstanding": 325000,
        "combined_deduction_percentage": 10
    },
    "timestamp": "2026-01-29T12:00:00.000Z"
}
Modified at 2026-04-08 17:24:40
Previous
Integration health check
Next
Get loan status
Built with