Developer Platform, Sandbox & Key Management
Registration, API credentials, webhooks, SSE, sandbox certification, deterministic test tools, and settings.
Product 8 in the Partner API product catalog, covering 35 operations.
Registration, API credentials, webhooks, SSE, sandbox certification, deterministic test tools, and settings.
Integration guides
auth · key management · paper demo trading · webhooks · sse events
Endpoint catalog
Paths are relative to https://mystocks.africa/api/v1/partner in production and https://mystocks.africa/api/sandbox/v1/partner in sandbox.
Open the API Reference and search the operation ID for request parameters, schemas, response codes, and examples. Use the API Tester to exercise an operation.
Sandbox availability is taken from each operation's OpenAPI metadata. Production-only operations and unsupported sandbox stubs are explicitly distinguished; account entitlements and instrument eligibility still apply.
| Method and path | Operation ID | Purpose | Sandbox |
|---|---|---|---|
GET /account | listAccount | Get partner account | Available |
DELETE /api-keys/data-key | deleteDataKey | Revoke data API key | Unsupported stub |
GET /api-keys/data-key | listDataKey | Get data API key | Available |
POST /api-keys/data-key | createDataKey | Issue data API key | Unsupported stub |
POST /api-keys/revoke | createRevoke | Revoke API key | Unsupported stub |
POST /api-keys/rotate | createRotate | Rotate API key | Available |
POST /apply | submitPartnerApplication | Submit partner application | Production only |
GET /certification | getCertification | Get certification checklist | Production only |
PATCH /certification | updateCertification | Update certification evidence | Production only |
POST /certification | requestGoLiveReview | Request go-live review | Production only |
GET /me | listMe | My status | Available |
GET /notification-rules | getNotificationRules | Get notification policy | Production only |
PUT /notification-rules | replaceNotificationRules | Replace notification policy | Production only |
GET /pricing | getPricing | Get partner markup pricing | Available |
PATCH /pricing | updatePricing | Update partner markup pricing | Available |
POST /register | createRegister | Register sandbox account | Available |
POST /reset | createReset | Reset sandbox account | Available |
POST /sandbox/deposit | createSandboxDeposit | Credit virtual funds (deprecated alias) Deprecated | Available |
GET /sandbox/orders | listSandboxOrders | List test orders (deprecated alias) Deprecated | Available |
POST /sandbox/trade | createSandboxTrade | Submit test trade (deprecated alias) Deprecated | Available |
POST /session | createPartnerSession | Mint a portal session token | Production only |
GET /settings | listSettings | Get settings | Available |
PATCH /settings | updateSettings | Update settings | Available |
POST /settings | createSettings | Test SMTP | Available |
POST /test-tools/deposit | createTestToolsDeposit | Credit virtual funds | Available |
GET /test-tools/orders | listTestToolsOrders | List test orders | Available |
PATCH /test-tools/orders/{orderId} | updateTestToolsOrder | Advance a sandbox test order | Available |
POST /test-tools/trade | createTestToolsTrade | Submit test trade | Available |
GET /upgrade-request | getUpgradeRequest | Check upgrade request status | Available |
POST /upgrade-request | createUpgradeRequest | Submit upgrade request | Available |
GET /webhooks | listWebhooks | List webhooks | Available |
POST /webhooks | createWebhooks | Register webhook | Available |
DELETE /webhooks/{id} | deleteWebhooks | Delete webhook | Available |
GET /webhooks/{id}/deliveries | listDeliveries | Webhook deliveries | Available |
POST /webhooks/{id}/test | createTest | Test webhook | Available |
Shared contracts
auth · errors · rate limits · contract guarantees
Download the September 2026 specification PDF. Read the online clarifications before using the PDF's general examples.
Was this page useful?
Your signal helps us tighten partner onboarding docs.
Last updated on