Skip to content
Partner API Docs

Fund Flow

Fund your master wallet via top-up requests to MyStocks operations and repatriate surplus via payout requests. Includes the aggregate partner account summary. Both money-movement endpoints are idempotent.

Request top-ups from MyStocks operations to fund your master wallet, and submit payout requests to repatriate surplus funds. Both endpoints are idempotent — always pass Idempotency-Key to prevent duplicate submissions.

Top-up
POST /topup
→
PENDING
remittance in flight
→
APPROVED
topup.confirmed

Top-up and payout state machines are in Order & Money Lifecycles.

Partner account

GET /account

Master wallet balance plus an aggregate portfolio summary across all sub-accounts. Useful as a dashboard home-screen data source.

curl "https://mystocks.africa/api/v1/partner/account" \
  -H "Authorization: Bearer pk_live_<key>"
{ "masterWalletBalance": 94500, "totalAum": 45230.5, "subAccountCount": 142, "currency": "USD" }

Top-up

POST /topup · GET /topup

Submit a master-wallet top-up request to MyStocks operations. When funds are credited a wallet.credited webhook fires. Use GET to list all previous top-up requests with their status.

FieldTypeRequiredDescription
amountnumberYesUSD amount requested.
referencestringNoYour internal transfer reference for reconciliation.
curl -X POST "https://mystocks.africa/api/v1/partner/topup" \
  -H "Authorization: Bearer pk_live_<key>" \
  -H "Idempotency-Key: topup_20260609_001" \
  -H "Content-Type: application/json" \
  -d '{"amount":10000,"reference":"wire_TXN987654"}'
{ "id": "tup_abc123", "amount": 10000, "currency": "USD", "status": "PENDING", "reference": "wire_TXN987654", "createdAt": "2026-06-09T10:00:00Z" }

Payout

POST /payout · GET /payout

Submit a payout request to repatriate funds from your master wallet to your settlement account. MyStocks operations processes and debits your master wallet on fulfilment. Use GET to list all previous payout requests.

FieldTypeRequiredDescription
amountnumberYesUSD amount to repatriate.
referencestringNoYour internal reference for reconciliation.
curl -X POST "https://mystocks.africa/api/v1/partner/payout" \
  -H "Authorization: Bearer pk_live_<key>" \
  -H "Idempotency-Key: payout_20260609_001" \
  -H "Content-Type: application/json" \
  -d '{"amount":5000,"reference":"payout_REF123"}'
{ "id": "pay_abc123", "amount": 5000, "currency": "USD", "status": "PENDING", "reference": "payout_REF123", "createdAt": "2026-06-09T10:00:00Z" }

Previous

Sub-Accounts

Next

Order & Money Lifecycles

On this page