API product catalogDeveloper Platform, Sandbox & Key Management

Update partner markup pricing

Developer Platform, Sandbox & Key Management

PATCH

/pricing

Sandbox availableupdatePricing

Full replacement of the markup config. Requires a full API key. Each markupBps is 0–maxMarkupBps.

Parameters

This endpoint has no path or query parameters.

Headers

AuthorizationstringRequired

Bearer sk_sandbox_<your_key> for sandbox requests.

Idempotency-KeystringheaderRequired

Unique string that makes write calls safe to retry on network failure. Required for money movement, trading, KYC, subscriptions, and webhook creation. Deduplicated for 24 hours -- duplicate keys return the cached response. HTTP 409 if a concurrent request with the same key is still in progress.

Example: dep_user42_1743152580

Request body

defaultMarkupBpsnumberRequired

Example: 75

overridesobject[]

overrides[].scopesymbol | exchange | assetClassRequired

overrides[].keystringRequired

Example: "SCOM.KE"

overrides[].markupBpsnumberRequired

Example: 50

promoobject

promo.markupBpsnumber

Example: 0

promo.untilstring

Response fields

defaultMarkupBpsnumber

Default markup (bps) when no override matches.

overridesobject[]

overrides[].scopesymbol | exchange | assetClass

overrides[].keystring

overrides[].markupBpsnumber

promoobject | null

promo.markupBpsnumber

promo.untilstring

promoActiveboolean

Whether the promo window is currently in effect.

maxMarkupBpsnumber

Platform cap on any markupBps.

legacyMarkupBpsnumber

The flat markup used when no pricing config is set.

Response codes

200Updated pricing.

400Validation error.

Request reference

Sandbox available

Use the API Tester for write requests, including request bodies and idempotency keys.

https://mystocks.africa/api/sandbox/v1/partner/pricing

Open in API Tester API Reference

Response schema

{
  "type": "object",
  "description": "Self-serve markup configuration.",
  "properties": {
    "defaultMarkupBps": {
      "type": "number",
      "description": "Default markup (bps) when no override matches."
    },
    "overrides": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "scope": {
            "type": "string",
            "enum": [
              "symbol",
              "exchange",
              "assetClass"
            ]
          },
          "key": {
            "type": "string"
          },
          "markupBps": {
            "type": "number"
          }
        }
      }
    },
    "promo": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "markupBps": {
          "type": "number"
        },
        "until": {
          "type": "string",
          "format": "date-time"
        }
      }
    },
    "promoActive": {
      "type": "boolean",
      "description": "Whether the promo window is currently in effect."
    },
    "maxMarkupBps": {
      "type": "number",
      "description": "Platform cap on any markupBps."
    },
    "legacyMarkupBps": {
      "type": "number",
      "description": "The flat markup used when no pricing config is set."
    }
  }
}

curl -X PATCH 'https://mystocks.africa/api/sandbox/v1/partner/pricing' \
  -H "Authorization: Bearer $MYSTOCKS_SANDBOX_API_KEY" \
  -H "Idempotency-Key: YOUR_UNIQUE_REQUEST_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "defaultMarkupBps": 75,
  "overrides": [
    {
      "scope": "exchange",
      "key": "NSE",
      "markupBps": 50
    },
    {
      "scope": "symbol",
      "key": "SCOM.KE",
      "markupBps": 25
    }
  ],
  "promo": {
    "markupBps": 0,
    "until": "2026-08-01T00:00:00Z"
  }
}'

GET /pricing

GET /public-brand