1. Embedded Journey (Marketplace 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
        POST
      • Get merchant status (KYC, credit score, funding requests)
        GET
      • Update business KYC information
        PUT
      • Add directors (bulk)
        POST
      • Attach a KYC document
        POST
      • Submit KYC for review
        POST
      • Submit sales data for credit scoring
        POST
      • Create a funding request
        POST
      • Mint an embed token for the hosted journey
        POST
  • 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
  1. Embedded Journey (Marketplace API)

Create (or fetch) a merchant

POST
/api/v1/marketplace-api/merchants
Creates an OpenSylo merchant for one of your customers. Idempotent on
thirdPartyCustomerId
-- repeating the call with the same ID returns
the existing merchant (created: false) instead of creating a duplicate.
Emits the merchant.created outbound webhook on first creation.

Request

Authorization
API Key
Add parameter in header
X-OpenSylo-Secret-Key
Example:
X-OpenSylo-Secret-Key: ********************
or
Body Params application/jsonRequired

Examples

Responses

🟢200OK
application/json
Merchant created or already existing.
Bodyapplication/json

🟠401Unauthorized
🟠403Forbidden
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.opensylo.com/api/v1/marketplace-api/merchants' \
--header 'X-OpenSylo-Secret-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "thirdPartyCustomerId": "mkt_merchant_8421",
    "businessName": "Mama Cass Foods Ltd",
    "email": "owner@mamacass.example",
    "phoneNumber": "+2348012345678",
    "businessType": "LIMITED_LIABILITY_COMPANY",
    "industry": "FOOD"
}'
Response Response Example
200 - Success Example
{
    "merchantId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "connectionId": "c9d8e7f6-a5b4-3210-fedc-ba0987654321",
    "thirdPartyCustomerId": "mkt_merchant_8421",
    "created": true
}
Modified at 2026-06-10 14:59:36
Previous
funding_request.rejected
Next
Get merchant status (KYC, credit score, funding requests)
Built with