OpenSylo Marketplace API
  1. Loan API
OpenSylo Marketplace API
  • Introduction
  • Getting Started
  • OAuth 2.0 Flow
  • Webhook Integration
  • Sandbox Testing
  • Error Reference
  • Marketplace Dashboard
    • Login to the marketplace dashboard
      POST
    • View OAuth credentials
      GET
    • Regenerate client secret
      POST
  • OAuth 2.0
    • Start OAuth authorization
      GET
    • Exchange code or refresh token
      POST
    • Revoke a token
      POST
    • OAuth discovery / client metadata
      GET
  • Data Ingestion
    • Submit single merchant data
      POST
    • Submit bulk merchant data
      POST
    • Get merchant credit score
      GET
    • Integration health check
      GET
  • 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
      POST
    • Send settlement webhook
      POST
  • Sandbox
    • Sandbox environment info
      GET
    • Get sandbox test credentials
      GET
    • Get sandbox test merchants
      GET
  • 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
  1. Loan API

Get loan status

GET
/api/v1/marketplace/loans/{loanId}/status
Retrieve the current status of a specific loan, including repayment progress and collection priority.
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
Path Params

Responses

🟢200
application/json
Loan status retrieved
Body

🟠401
🟠404
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.opensylo.com/api/v1/marketplace/loans/loan_uuid/status' \
--header 'Authorization: Bearer <token>'
Response Response Example
200 - Success
{
    "loan_id": "loan_uuid",
    "reference": "LOAN-2026-001",
    "status": "DISBURSED",
    "deduction_required": true,
    "merchant": {
        "opensylo_id": "merchant_uuid",
        "marketplace_id": "your_merchant_id"
    },
    "repayment": {
        "deduction_percentage": 10,
        "minimum_deduction": 500,
        "total_due": 525000,
        "total_repaid": 200000,
        "outstanding": 325000,
        "currency": "NGN"
    },
    "due_date": "2026-04-15T00:00:00.000Z",
    "is_overdue": false,
    "days_overdue": 0,
    "collection_priority": "normal",
    "timestamp": "2026-01-29T12:00:00.000Z"
}
Modified at 2026-01-29 23:19:05
Previous
Get active loans for a merchant
Next
Validate deduction amounts
Built with