API product catalogSub-Accounts & White-Label Retail KYC

Redeem fund units

Sub-Accounts & White-Label Retail KYC

POST

/users/{userId}/redeem

Redeem fund units

Sandbox availablecreateRedeem

Redeems fund units back to the sub-account wallet. Proceeds are credited at the current NAV once the redemption is processed by the fund manager (typically T+1 for MMFs).

Parameters

userIdstringpathRequired

Example: usr_abc123

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

holdingIdstringRequired

Sub-account fund holding doc ID (same as the fund Firestore doc ID).

Example: "FUND_ID_FROM_CATALOGUE"

unitsToRedeemnumberRequired

Units to redeem. Must not exceed available unlocked units.

Example: 200

Response fields

messagestring

redemptionIdstring

unitsRedeemednumber

Response codes

200Redemption queued.

Request reference

Sandbox available

userId Required · path

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

https://mystocks.africa/api/sandbox/v1/partner/users/%7BuserId%7D/redeem

Open in API Tester API Reference

Response schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "redemptionId": {
      "type": "string"
    },
    "unitsRedeemed": {
      "type": "number"
    }
  }
}

curl -X POST 'https://mystocks.africa/api/sandbox/v1/partner/users/%7BuserId%7D/redeem' \
  -H "Authorization: Bearer $MYSTOCKS_SANDBOX_API_KEY" \
  -H "Idempotency-Key: YOUR_UNIQUE_REQUEST_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "holdingId": "fund_mmf_africa",
  "unitsToRedeem": 200
}'

GET /users/{userId}/portfolio/performance

POST /users/{userId}/subscribe