OpenSylo Backend API
  1. Marketplace Data Ingestion
OpenSylo Backend API
  • API Info
    • API Information
      GET
  • Health
    • HealthController_checkHealth
      GET
    • HealthController_ping
      GET
  • Marketplace Connections
    • Get available marketplaces
      GET
    • Get marketplace catalog
      GET
    • Get marketplace details
      GET
    • Initiate marketplace connection
      POST
    • Disconnect from marketplace
      POST
    • Get connection status
      GET
    • Update marketplace credentials
      POST
    • Handle OAuth callback
      POST
  • Merchant Authentication
    • Register a new merchant account
      POST
    • Authenticate merchant
      POST
    • Verify email address
      POST
    • Resend verification email
      POST
    • Request password reset
      POST
    • Reset password
      POST
    • Change password
      POST
    • Refresh access token
      POST
    • Logout
      POST
    • Get current user profile
      GET
  • MerchantKyc
    • MerchantKycController_getOnboardingStatus
    • MerchantKycController_getKycProgress
    • MerchantKycController_sendOtp
    • MerchantKycController_verifyOtp
    • MerchantKycController_updateBusinessInfo
    • MerchantKycController_addDirector
    • MerchantKycController_addBulkDirectors
    • MerchantKycController_uploadDocument
    • MerchantKycController_submitKyc
    • MerchantKycController_searchBusinessTypes
    • MerchantKycController_getBusinessCategories
    • MerchantKycController_getDocumentTypes
  • Merchants
    • Create a new merchant
    • Get all merchants
    • Get a merchant by ID
    • Update a merchant
    • Delete a merchant
  • Marketplace Data Ingestion
    • Submit Merchant Data
      POST
    • Submit Bulk Merchant Data
      POST
    • Get Merchant Credit Score
      GET
    • Health Check
      GET
  • Marketplace Dashboard
    • Complete Marketplace Registration
    • Marketplace Dashboard Login
    • Get OAuth Credentials
    • Regenerate Client Secret
    • Get Current User
    • Invite Marketplace (Admin)
  • OAuth 2.0
    • OAuth Authorization Endpoint
    • Process Authorization Decision
    • Token Endpoint
    • Revoke Token
    • Client Metadata
  • OAuth Authentication
    • Login Page
    • Login Submit
    • Signup Page
    • Signup Submit
    • Logout
  • Lenders
    • Create a new lender
    • Get all lenders
    • Get a lender by ID
    • Update a lender
    • Delete a lender
  • Schemas
    • PlatformDto
    • PlatformConnectionMetadataDto
    • PlatformConnectionInfoDto
    • PlatformListResponseDto
    • ConnectionInitResponseDto
    • ConnectionMetricsDto
    • ConnectionStatusResponseDto
    • DisconnectResponseDto
    • PlatformCatalogResponseDto
    • ConnectPlatformDto
    • DisconnectPlatformDto
    • PlatformCredentialsDto
    • MerchantSignupDto
    • SignupResponseDto
    • MerchantLoginDto
    • LoginResponseDto
    • MerchantVerifyEmailDto
    • EmailVerificationResponseDto
    • MerchantResendVerificationDto
    • GenericSuccessResponseDto
    • MerchantForgotPasswordDto
    • MerchantResetPasswordDto
    • MerchantChangePasswordDto
    • RefreshTokenDto
    • UserProfileResponseDto
    • OtpVerificationDto
    • BusinessKycDto
    • DirectorInfoDto
    • BulkDirectorInfoDto
    • DocumentUploadDto
    • CreateMerchantDto
    • UpdateMerchantDto
    • MarketplaceDataCaptureDto
    • BulkMarketplaceDataCaptureDto
    • CompleteMarketplaceRegistrationDto
    • MarketplaceLoginResponseDto
    • MarketplaceLoginDto
    • MarketplaceCredentialsResponseDto
    • RegenerateSecretResponseDto
    • InviteMarketplaceDto
    • MarketplaceInvitationResponseDto
    • CreateLenderDto
    • UpdateLenderDto
  1. Marketplace Data Ingestion

Submit Merchant Data

POST
/api/marketplace/data/merchant
Submit merchant sales and performance data for credit scoring.
Requires OAuth access token with data.share.sales scope.

Security#

Token is bound to the merchant who consented
The merchantIdentity.merchantId in request body is the marketplace's
internal ID (stored for reference only)
OpenSylo uses the merchant ID from the OAuth token (cannot be overridden)

Example Request#

Data Field Reference#

Merchant Identity#

FieldTypeDescription
merchantIdstringMarketplace's internal merchant ID
businessNamestringBusiness name on platform
businessTypeenumINDIVIDUAL or REGISTERED_BUSINESS
marketplaceOnboardingDatedateWhen merchant joined platform
verificationStatusbooleanKYC completed
countrystringOperating country
categorystringBusiness category

Sales Performance#

FieldTypeDescription
gmv30DaysnumberGMV last 30 days
gmv90DaysnumberGMV last 90 days
gmv180DaysnumberGMV last 180 days
avgMonthlySalesnumberAverage monthly sales
orderCountnumberTotal completed orders
avgOrderValuenumberAverage order value
salesGrowthRatenumberMoM growth rate (%)

Fulfillment Metrics#

FieldTypeDescription
fulfillmentRatenumber% orders fulfilled
cancellationRatenumber% orders cancelled
refundRatenumber% orders refunded
disputeRatenumber% orders disputed
lateDeliveryRatenumber% late deliveries

Payout & Cash Flow#

FieldTypeDescription
payoutFrequencyenumDAILY, WEEKLY, BI_WEEKLY, MONTHLY
avgPayoutValuenumberAverage payout amount
failedPayoutsnumberCount of failed payouts

Behavioral Risk#

FieldTypeDescription
accountSuspensionsnumberCount of suspensions
hasFraudFlagsbooleanFraud indicators
hasSuddenGmvSpikesbooleanSuspicious GMV patterns
hasLinkedAccountsbooleanMultiple linked accounts

Request

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

Body Params application/jsonRequired

Examples

Responses

🟢200
application/json
Data processed successfully with credit score
Body

🟠400
🟠401
🟠403
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.dev.opensylo.com/api/marketplace/data/merchant' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{}'
Response Response Example
{
    "success": true,
    "message": "Merchant data processed successfully",
    "transactionId": "uuid-here",
    "creditScore": {
        "totalScore": 78,
        "riskTier": "B",
        "maxLendingCap": 930000,
        "eligiblePercentage": 30,
        "scoreBreakdown": {
            "salesPerformance": 28,
            "revenueConsistency": 12,
            "fulfillmentOps": 14,
            "payoutCashFlow": 15,
            "stabilityTenure": 7,
            "riskBehavior": 10
        },
        "lendingImplication": "Standard cap",
        "calculatedAt": "2019-08-24T14:15:22.123Z",
        "recommendations": "string"
    },
    "processedAt": "2019-08-24T14:15:22.123Z",
    "nextRefreshDate": "2019-08-24T14:15:22.123Z"
}
Modified at 2025-12-30 08:04:15
Previous
Delete a merchant
Next
Submit Bulk Merchant Data
Built with