MarketSDK Marketplace API

openapi: 3.2.0
info:
  title: Marketsdk Marketplace API
  version: 1.0.0
  contact: {}
  description: 'Operations tagged Marketplace across 2 of this provider''s published API definitions: marketsdk-openapi.json, marketsdk-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.marketsdk.com
tags:
- name: Marketplace
paths:
  /v1/marketplace:
    get:
      description: Settings are changed in the dashboard, separately for test and live.
      operationId: getMarketplace
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MarketplaceObject'
        '400':
          description: The request is not valid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '401':
          description: No API key, or not a valid one.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '429':
          description: Rate limited. See `Retry-After`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      security:
      - bearer: []
      summary: The marketplace this key belongs to, and its settings
      tags:
      - Marketplace
    servers:
    - url: https://api.marketsdk.com
components:
  schemas:
    ReputationSettingsDto:
      type: object
      properties:
        window_months:
          type: number
          minimum: 6
          maximum: 60
          default: 24
        backout_weight:
          type: number
          minimum: 1
          maximum: 5
          default: 2
        dispute_weight:
          type: number
          minimum: 1
          maximum: 5
          default: 3
        blend:
          type: number
          minimum: 0
          maximum: 1
          default: 0.6
        prior_rating:
          type: number
          minimum: 3
          maximum: 5
          default: 4
        prior_weight:
          type: number
          minimum: 0
          maximum: 10
          default: 2
        minimum_events:
          type: number
          minimum: 1
          maximum: 10
          default: 3
    ErrorEnvelope:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/ErrorBody'
      required:
      - error
    ReadOnlyObject:
      type: object
      properties:
        reason:
          type: string
          enum:
          - payment_failed
          - cancelled
          - plan_inactive
          - policy_not_accepted
          - stripe_connection
          - suspended
        since:
          type: string
          format: date-time
      required:
      - reason
      - since
    ModerationSettingsDto:
      type: object
      properties:
        prohibited_keywords:
          maxItems: 200
          description: Words or phrases that block publication when found in a listing title or description, ignoring case.
          type: array
          items:
            type: string
    ErrorBody:
      type: object
      properties:
        code:
          type: string
          description: Machine-readable. Never changes once published.
          example: resource_missing
        message:
          type: string
          description: For people.
          example: No seller has that id.
        param:
          type: string
          description: The request field at fault.
          example: seller
        request_id:
          type: string
          example: req_7Gq0mR2s9xVbN4kT1pLc
      required:
      - code
      - message
      - request_id
    FeeSettingsDto:
      type: object
      properties:
        percent_bps:
          type: number
          minimum: 0
          maximum: 10000
          description: 'Basis points: 250 is 2.5 percent.'
        fixed_amount:
          type: number
          minimum: 0
          description: Minor units, in the marketplace currency.
    DisputeSettingsDto:
      type: object
      properties:
        evidence_days:
          type: number
          minimum: 1
          maximum: 30
          default: 7
          description: Days both parties have to give evidence once a dispute opens.
        decision_days:
          type: number
          minimum: 1
          maximum: 60
          default: 14
          description: Days the customer's team has to decide once evidence closes. After that the dispute is marked overdue.
    MarketplaceObject:
      type: object
      properties:
        object:
          type: string
          enum:
          - marketplace
        id:
          type: string
          example: mkt_034XtPDs7UJ0TXzTsdaHZa
        mode:
          type: string
          enum:
          - test
          - live
        description:
          type:
          - string
          - 'null'
        currency:
          type: string
          example: USD
        payments:
          type: boolean
        seller_verification:
          type: boolean
        hold_funds_until_completion:
          type: boolean
        fee:
          $ref: '#/components/schemas/FeeSettingsDto'
        timers:
          $ref: '#/components/schemas/TimerSettingsDto'
        reputation:
          $ref: '#/components/schemas/ReputationSettingsDto'
        disputes:
          $ref: '#/components/schemas/DisputeSettingsDto'
        moderation:
          $ref: '#/components/schemas/ModerationSettingsDto'
        allowed_origins:
          type: array
          items:
            type: string
        read_only:
          description: Set while the marketplace answers reads only, for example after a missed payment. Changes are refused with 403 `marketplace_read_only`. Null when open.
          anyOf:
          - $ref: '#/components/schemas/ReadOnlyObject'
          - type: 'null'
      required:
      - object
      - id
      - mode
      - description
      - currency
      - payments
      - seller_verification
      - hold_funds_until_completion
      - fee
      - timers
      - reputation
      - disputes
      - moderation
      - allowed_origins
      - read_only
    TimerSettingsDto:
      type: object
      properties:
        payment_window_minutes:
          type: number
          minimum: 5
          maximum: 1440
          default: 30
        commitment_window_days:
          type: number
          minimum: 1
          maximum: 90
          default: 14
        agreement_window_hours:
          type: number
          minimum: 1
          maximum: 168
          default: 48
        confirmation_window_days:
          type: number
          minimum: 1
          maximum: 30
          default: 7
        review_window_days:
          type: number
          minimum: 7
          maximum: 90
          default: 30
        dispute_window_days:
          type: number
          minimum: 0
          maximum: 60
          default: 14
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: API key
      type: http
      description: 'An API key: msk_test_sk_…, msk_live_sk_…, or a publishable msk_…_pk_… key where allowed.'
x-refined-from:
- marketsdk-openapi.json
- marketsdk-openapi.json
x-stripe-permissions:
- permission: accounts
  category: Core
  resource: Accounts
  level: Write
  used_for: Create sellers' connected accounts and read their status
- permission: account_links
  category: Connect
  resource: Account Links
  level: Write
  used_for: Onboarding links for sellers
- permission: transfers
  category: Connect
  resource: Transfers
  level: Write
  used_for: Release funds to a seller, and reverse them on a refund
- permission: payment_intents
  category: Core
  resource: Payment Intents
  level: Write
  used_for: Buyer payments, and cancelling unpaid ones
- permission: charges_and_refunds
  category: Core
  resource: Charges and Refunds
  level: Write
  used_for: Refunds, full and partial
- permission: checkout_sessions
  category: Checkout
  resource: Checkout Sessions
  level: Write
  used_for: Hosted checkout, and expiring unpaid sessions
- permission: identity_verification_sessions
  category: Identity
  resource: Verification Sessions and Reports
  level: Write
  used_for: Seller identity verification
- permission: disputes
  category: Core
  resource: Disputes
  level: Read
  used_for: Reading card disputes, to link them to orders
- permission: webhook_endpoints
  category: Webhook Endpoints
  resource: Webhook Endpoints
  level: Write
  used_for: Registering our endpoint on your account