Schemas
Copy Page
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
Schemas
TokenRequest
TokenResponse
OAuthError
ClientMetadataResponse
MerchantIdentity
SalesPerformance
RevenueConsistency
FulfillmentMetrics
PayoutCashFlow
PlatformDependency
HistoricalCredit
BehavioralRisk
MonthlyHistoryEntry
MerchantDataRequest
CreditScore
LoanEligibilityResult
MerchantDataResponse
BulkMerchantDataRequest
AsyncBulkProcessingResponse
BatchStatusResponse
SalesEventRequest
RepaymentEventRequest
AccountFlagRequest
MerchantInfo
LenderInfo
RepaymentInfo
LoanTermsInfo
ActiveLoan
ActiveLoansSummary
ActiveLoansResponse
LoanStatusRepayment
LoanStatusResponse
ValidateDeductionsRequest
DeductionItem
DeductionSummary
ValidateDeductionsResponse
BulkLoanStatusRequest
BulkLoanStatusItem
BulkStatusSummary
BulkLoanStatusResponse
WebhookMarketplace
WebhookMerchant
WebhookLoan
DeductionDetails
SourceTransaction
LoanBalance
RepaymentDeductedWebhook
FailureDetails
RepaymentFailedWebhook
ReversalDetails
RepaymentReversedWebhook
SettlementDetails
SettlementSummaryByStatus
SettlementSummary
SettlementLoanIncluded
BankTransferDetails
SettlementCreatedWebhook
SettlementTransferredWebhook
TransferDetails
WebhookAckResponse
OutboundLoan
OutboundMerchant
OutboundLender
LoanTerms
RepaymentTerms
ScheduleInstallment
LoanApprovedPayload
DisbursementDetails
DisbursedRepayment
LoanDisbursedPayload
ChangeDetail
LoanRepaymentUpdatedPayload
RepaymentStatus
NearlyCompleteRecommendation
LoanNearlyCompletePayload
CompletionSummary
LoanCompletedPayload
DefaultDetails
CollectionInstructions
LoanDefaultedPayload
ApiError
RateLimitError
EmbedCreateMerchantRequest
EmbedCreateMerchantResponse
EmbedBusinessKyc
EmbedDirectorInfo
EmbedBulkDirectors
EmbedDirectorListItem
EmbedDocumentUpload
EmbedSalesDataAccepted
EmbedCreateFundingRequest
EmbedFundingRequestIntent
EmbedMerchantStatusResponse
EmbedTokenResponse
MarketplaceMerchantRef
MerchantCreatedPayload
KycStatusPayload
FundingRequestEventPayload
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 loan status
Validate deduction amounts
Bulk loan status check
Inbound Webhooks
Send repayment webhook
Send settlement webhook
Schemas
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
OAuthError
ApiError
Schemas
Copy Page
RevokeRequest
{
"token"
:
"opaque_access_or_refresh_token"
,
"token_type_hint"
:
"access_token"
}