Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.pipevest.com/llms.txt

Use this file to discover all available pages before exploring further.

The individual stocks view contains the available operations/options for a given stock.

​
Accessing the individual stock view

This is the menu that is displayed once the customer has chosen to view an individual stock. From here the customer can choose to purchase the stock, view more details or go back to the stocks menu.
  curl --request POST \
    --url https://api.staging.pipevest.com/v1/ussd/process
    ...
    --data 'sessionId=<session-id>'
    --data 'choice=1'
Example Response 
{
    "message": "USSD request processed successfully",
    "data": {
        "sessionId": "ussd_5310deea137a9cd999b02ae68a7bbbec",
        "currentState": "SELECT_STOCK",
        "menu": {
            "state": "SELECT_STOCK",
            "text": "Apple Inc. (AAPL)\n\nPrice: ZK6058.00\nChange: $-0.53 (-0.20%)\n\nWhat would you like to do?",
            "options": [
                {
                    "key": "1",
                    "label": "Buy Stock",
                    "nextState": "BUY_STOCK"
                },
                {
                    "key": "2",
                    "label": "More Details",
                    "nextState": "MORE_STOCK_DETAIL"
                },
                {
                    "key": "0",
                    "label": "Back to Stocks",
                    "nextState": "STOCKS"
                }
            ],
            "isEndState": false
        },
        "ussdText": "Apple Inc. (AAPL)\n\nPrice: ZK6058.00\nChange: $-0.53 (-0.20%)\n\nWhat would you like to do?\n\n1. Buy Stock\n2. More Details\n0. Back to Stocks",
        "expiresAt": "2025-11-06T14:58:33.942Z"
    }
}

​
Stocks View Example

USSD Individual Stock View

Check out an example of the ussd individual stock view