Skip to content
Pipevest Developers

Individual Asset Menu View

The individual asset menu view allows users to view general asset performance, more detailed stock information and transaction history.

Accessing the Assets View

Section titled “Accessing the Assets View”
Terminal window
  curl --request POST \
    --url https://api.staging.pipevest.com/v1/ussd/process \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <access-token>' \
    --header 'x-client-id: <client-id>' \
    --data '{"sessionId": "<session-id>", "choice": "1"}'

Example Response

{
    "message": "USSD request processed successfully",
    "data": {
        "sessionId": "ussd_2231df057f1f8f5269f0a268249ac104",
        "currentState": "ASSET_DETAIL",
        "menu": {
            "state": "ASSET_DETAIL",
            "text": "Apple Inc. (AAPL)\n\nHoldings:\nShares: 0.0966\nAvg Price: ZK6024.84\n\nValue:\nTotal: ZK592.45\nInvested: ZK582.00\nChange: +ZK10.45 (+1.80%)\n\nWhat would you like to do?",
            "options": [
                {
                    "key": "1",
                    "label": "Purchase More",
                    "nextState": "BUY_STOCK"
                },
                {
                    "key": "2",
                    "label": "Sell Stock",
                    "nextState": "SELL_STOCK"
                },
                {
                    "key": "3",
                    "label": "More Details",
                    "nextState": "MORE_STOCK_DETAIL"
                },
                {
                    "key": "4",
                    "label": "Transactions",
                    "nextState": "STOCK_TRANSACTIONS"
                },
                {
                    "key": "0",
                    "label": "Back to Assets",
                    "nextState": "VIEW_ASSETS"
                }
            ],
            "isEndState": false
        },
        "ussdText": "Apple Inc. (AAPL)\n\nHoldings:\nShares: 0.0966\nAvg Price: ZK6024.84\n\nValue:\nTotal: ZK592.45\nInvested: ZK582.00\nChange: +ZK10.45 (+1.80%)\n\nWhat would you like to do?\n\n1. Purchase More\n2. Sell Stock\n3. More Details\n4. Transactions\n0. Back to Assets",
        "expiresAt": "2025-11-10T14:56:05.356Z"
    }
}
What the customer sees
Apple Inc. (AAPL)

Holdings:
Shares: 0.0966
Avg Price: ZK6024.84

Value:
Total: ZK592.45
Invested: ZK582.00
Change: +ZK10.45 (+1.80%)

What would you like to do?

1. Purchase More
2. Sell Stock
3. More Details
4. Transactions
0. Back to Assets

Viewing asset transactions

Section titled “Viewing asset transactions”

Creating a sell order request

Section titled “Creating a sell order request”
Terminal window
  curl --request POST \
    --url https://api.staging.pipevest.com/v1/ussd/process \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <access-token>' \
    --header 'x-client-id: <client-id>' \
    --data '{"sessionId": "<session-id>", "choice": "2"}'
{
    "message": "USSD request processed successfully",
    "data": {
        "sessionId": "ussd_2231df057f1f8f5269f0a268249ac104",
        "currentState": "SELL_STOCK",
        "menu": {
            "state": "SELL_STOCK",
            "text": "Sell Apple Inc. (AAPL)\n\nYou own: 0.0966 shares\nCurrent value: ZK592.45\n\nSelect amount to sell:",
            "options": [
                {
                    "key": "1",
                    "label": "10% (0.0097 shares) - ZK59.24",
                    "nextState": "SELL_CONFIRMATION",
                    "data": {
                        "sellQuantity": 0.009660000000000002,
                        "sellValue": 59.244780000000006
                    }
                },
                {
                    "key": "2",
                    "label": "25% (0.0242 shares) - ZK148.11",
                    "nextState": "SELL_CONFIRMATION",
                    "data": {
                        "sellQuantity": 0.02415,
                        "sellValue": 148.11195
                    }
                },
                {
                    "key": "3",
                    "label": "50% (0.0483 shares) - ZK296.22",
                    "nextState": "SELL_CONFIRMATION",
                    "data": {
                        "sellQuantity": 0.0483,
                        "sellValue": 296.2239
                    }
                },
                {
                    "key": "4",
                    "label": "100% (All shares) - ZK592.45",
                    "nextState": "SELL_CONFIRMATION",
                    "data": {
                        "sellQuantity": 0.0966,
                        "sellValue": 592.4478
                    }
                },
                {
                    "key": "5",
                    "label": "Enter custom amount",
                    "nextState": "ENTER_CUSTOM_SELL_AMOUNT"
                },
                {
                    "key": "0",
                    "label": "Back",
                    "nextState": "ASSET_DETAIL"
                }
            ],
            "isEndState": false
        },
        "ussdText": "Sell Apple Inc. (AAPL)\n\nYou own: 0.0966 shares\nCurrent value: ZK592.45\n\nSelect amount to sell:\n\n1. 10% (0.0097 shares) - ZK59.24\n2. 25% (0.0242 shares) - ZK148.11\n3. 50% (0.0483 shares) - ZK296.22\n4. 100% (All shares) - ZK592.45\n5. Enter custom amount\n0. Back",
        "expiresAt": "2025-11-10T14:56:05.356Z"
    }
}
What the customer sees
Sell Apple Inc. (AAPL)

You own: 0.0966 shares
Current value: ZK592.45

Select amount to sell:

1. 10% (0.0097 shares) - ZK59.24
2. 25% (0.0242 shares) - ZK148.11
3. 50% (0.0483 shares) - ZK296.22
4. 100% (All shares) - ZK592.45
5. Enter custom amount
0. Back

Assets View Example

Section titled “Assets View Example”
USSD Individual Assets View

Check out an example of the ussd individual asset view