API product catalogSub-Accounts & White-Label Retail KYC

Sub-account transactions

Sub-Accounts & White-Label Retail KYC

GET

/users/{userId}/transactions

Sandbox availablelistTransactions

Returns the full ledger transaction history for a sub-account — deposits, withdrawals, trade escrows (INVEST), trade settlements (SELL), dividend distributions, fund redemptions, and fee entries. Cursor-paginated; use nextCursor from the previous response as the cursor query param to fetch the next page.

Parameters

userIdstringpathRequired

Example: usr_abc123

Filter to a single transaction type. Empty filtered pages can have hasMore=true; continue with nextCursor.

fromstringquery

Inclusive lower bound: YYYY-MM-DD in UTC or a timezone-aware ISO timestamp.

Example: 2026-01-01

tostringquery

Inclusive upper bound: full UTC day including final milliseconds, or a timezone-aware ISO timestamp.

Example: 2026-06-30

cursorstringquery

Opaque cursor from nextCursor of the previous response. Omit for the first page.

limitintegerquery

Example: 50

Headers

AuthorizationstringRequired

Bearer sk_sandbox_<your_key> for sandbox requests.

Response fields

transactionsobject[]

transactions[].idstring

transactions[].statusPENDING | COMPLETED | FAILED

transactions[].directionCREDIT | DEBIT

transactions[].amountnumber

transactions[].currencystring

Example: "USD"

transactions[].descriptionstring | null

transactions[].referencestring | null

transactions[].createdAtstring

transactions[].settledAtstring | null

Settlement timestamp for completed rows. Legacy completed records return their immutable completion/creation timestamp when the original field was absent.

countinteger

hasMoreboolean

nextCursorstring | null

Response codes

200Transaction ledger.

Sandbox playground

Read-only sandbox request

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

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

Open in API Tester API Reference

Response schema

{
  "type": "object",
  "properties": {
    "transactions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "DEPOSIT",
              "WITHDRAWAL",
              "INVEST",
              "SELL",
              "DISTRIBUTION",
              "REDEEM",
              "FEE",
              "TRANSFER_IN",
              "TRANSFER_OUT",
              "SWAP",
              "ACCOUNT_CLOSURE"
            ]
          },
          "status": {
            "type": "string",
            "enum": [
              "PENDING",
              "COMPLETED",
              "FAILED"
            ]
          },
          "direction": {
            "type": "string",
            "enum": [
              "CREDIT",
              "DEBIT"
            ]
          },
          "amount": {
            "type": "number"
          },
          "currency": {
            "type": "string",
            "example": "USD"
          },
          "description": {
            "type": [
              "string",
              "null"
            ]
          },
          "reference": {
            "type": [
              "string",
              "null"
            ]
          },
          "createdAt": {
            "type": "string",
            "format": "date-time"
          },
          "settledAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Settlement timestamp for completed rows. Legacy completed records return their immutable completion/creation timestamp when the original field was absent."
          }
        }
      }
    },
    "count": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "nextCursor": {
      "type": [
        "string",
        "null"
      ]
    }
  }
}

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

POST /users/{userId}/trade

GET /users/{userId}/wallet