API product catalogSub-Accounts & White-Label Retail KYC

Sub-account dividends

Sub-Accounts & White-Label Retail KYC

GET

/users/{userId}/dividends

Sandbox availablelistDividends

Returns dividend payments received by a sub-account, including declared date, pay date, and USD amount credited.

Parameters

userIdstringpathRequired

Example: usr_abc123

fromstringquery

tostringquery

limitintegerquery

Example: 50

Headers

AuthorizationstringRequired

Bearer sk_sandbox_<your_key> for sandbox requests.

Response fields

dividendsobject[]

dividends[].symbolstring

dividends[].namestring

dividends[].amountUsdnumber

dividends[].sharesHeldinteger

dividends[].dividendPerSharenumber

dividends[].exDatestring

dividends[].payDatestring

dividends[].creditedAtstring

Response codes

200Dividend history.

Sandbox playground

Read-only sandbox request

userId Required · pathfrom Optional · queryto Optional · querylimit Optional · querySandbox API keyYour key stays in this page’s memory.

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

Open in API Tester API Reference

Response schema

{
  "type": "object",
  "properties": {
    "dividends": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "symbol": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "amountUsd": {
            "type": "number"
          },
          "sharesHeld": {
            "type": "integer"
          },
          "dividendPerShare": {
            "type": "number"
          },
          "exDate": {
            "type": "string",
            "format": "date"
          },
          "payDate": {
            "type": "string",
            "format": "date"
          },
          "creditedAt": {
            "type": "string",
            "format": "date-time"
          }
        }
      }
    }
  }
}

curl -X GET 'https://mystocks.africa/api/sandbox/v1/partner/users/%7BuserId%7D/dividends' \
  -H "Authorization: Bearer $MYSTOCKS_SANDBOX_API_KEY"

DELETE /users/{userId}/devices/{deviceId}

POST /users/{userId}/fx/convert