Skip to content
msMarketSDK

all endpoints

// api reference

Marketplace

GET /v1/marketplace

The marketplace this key belongs to, and its settings

Settings are changed in the dashboard, separately for test and live.

secret key only

GET /v1/marketplacerequest
curl https://api.marketsdk.com/v1/marketplace \
  -H "Authorization: Bearer $MARKETSDK_KEY"
200 example response, marketplace
{
  "object": "marketplace",
  "id": "mkt_034XtPDs7UJ0TXzTsdaHZa",
  "mode": "test",
  "description": null,
  "currency": "USD",
  "payments": false,
  "seller_verification": false,
  "hold_funds_until_completion": false,
  "fee": {
    "percent_bps": 0,
    "fixed_amount": 0
  },
  "timers": {
    "payment_window_minutes": 30,
    "commitment_window_days": 14,
    "agreement_window_hours": 48,
    "confirmation_window_days": 7,
    "review_window_days": 30,
    "dispute_window_days": 14
  },
  "reputation": {
    "window_months": 24,
    "backout_weight": 2,
    "dispute_weight": 3,
    "blend": 0.6,
    "prior_rating": 4,
    "prior_weight": 2,
    "minimum_events": 3
  },
  "disputes": {
    "evidence_days": 7,
    "decision_days": 14
  },
  "moderation": {
    "prohibited_keywords": [
      "string"
    ]
  },
  "allowed_origins": [
    "string"
  ],
  "read_only": {
    "reason": "payment_failed",
    "since": "2026-10-01T12:00:00.000Z"
  }
}

returns 200, marketplace

fields
Response fields
fieldtypeabout
objectrequiredone of: marketplace
idrequiredstring
moderequiredone of: test, live
descriptionrequiredstring or null
currencyrequiredstring
paymentsrequiredboolean
seller_verificationrequiredboolean
hold_funds_until_completionrequiredboolean
feerequiredfee settings
fee.percent_bpsintegerBasis points: 250 is 2.5 percent.min 0, max 10000
fee.fixed_amountintegerMinor units, in the marketplace currency.min 0
timersrequiredtimer settings
timers.payment_window_minutesintegermin 5, max 1440, default 30
timers.commitment_window_daysintegermin 1, max 90, default 14
timers.agreement_window_hoursintegermin 1, max 168, default 48
timers.confirmation_window_daysintegermin 1, max 30, default 7
timers.review_window_daysintegermin 7, max 90, default 30
timers.dispute_window_daysintegermin 0, max 60, default 14
reputationrequiredreputation settings
reputation.window_monthsintegermin 6, max 60, default 24
reputation.backout_weightintegermin 1, max 5, default 2
reputation.dispute_weightintegermin 1, max 5, default 3
reputation.blendintegermin 0, max 1, default 0.6
reputation.prior_ratingintegermin 3, max 5, default 4
reputation.prior_weightintegermin 0, max 10, default 2
reputation.minimum_eventsintegermin 1, max 10, default 3
disputesrequireddispute settings
disputes.evidence_daysintegerDays both parties have to give evidence once a dispute opens.min 1, max 30, default 7
disputes.decision_daysintegerDays the customer's team has to decide once evidence closes. After that the dispute is marked overdue.min 1, max 60, default 14
moderationrequiredmoderation settings
moderation.prohibited_keywordsarray of stringWords or phrases that block publication when found in a listing title or description, ignoring case.up to 200 items
allowed_originsrequiredarray of string
read_onlyrequiredread only or nullSet while the marketplace answers reads only, for example after a missed payment. Changes are refused with 403 marketplace_read_only. Null when open.
read_only.reasonrequiredone of: payment_failed, cancelled, plan_inactive, policy_not_accepted, stripe_connection, suspended
read_only.sincerequiredtimestamp

errors

  • 400The request is not valid.
  • 401No API key, or not a valid one.
  • 429Rate limited. See Retry-After.