The portfolio view allows users to see their assets, review pending order requests and transactions.

Accessing the Portfolio View

Make a GET request to /portfolio

  curl --request GET \
    --url https://api.staging.pipevest.com/v1/ussd/portfolio?customerId=123456
    --header 'Authorization: Bearer 123456' \
    --header 'Signature: sig1=:OTEyMjY4...A5NTNDMEQ=:' \
    --header 'Signature-Input: sig1=("Authorization" "X-Client-Id" "@method" "@target-uri" "@path" "@query");keyid="staging-pipevest-ed25519";created=1732893484;expires=1732893584' \
    --header 'X-Client-Id: 123456' \

Example Response

{
  "data": {
    "ussdMessage": "My portfolio:\n 1.View my assets\n 2.Pending requests (TSLA)\n 3.Transaction history\n 4.Back",
    "ussdOptions": [
      {
        "option": 1,
        "requestUrl": "https://api.staging.pipevest.com/v1/ussd/assets?customerId=123456",
        "requestType": "GET"
      },
      {
        "option": 2,
        "requestUrl": "https://api.staging.pipevest.com/v1/ussd/requests?customerId=123456&status=PENDING",
        "requestType": "GET"
      },
      {
        "option": 3,
        "requestUrl": "https://api.staging.pipevest.com/v1/ussd/transactions?customerId=123456",
        "requestType": "GET"
      },
      {
        "option": 4,
        "requestUrl": "https://api.staging.pipevest.com/v1/ussd/home?customerId=123456",
        "requestType": "GET"
      }
    ]
  },
  "code": 200,
  "message": "Success"
}

Query parameters

queryDefinitionRequired
customerIdThe unique customer identiferYes

Portfolio View Example

USSD Portfolio View

Check out an example of the ussd portfolio view

The portfolio view allows users to see their assets, review pending order requests and transactions.

Accessing the Portfolio View

Make a GET request to /portfolio

  curl --request GET \
    --url https://api.staging.pipevest.com/v1/ussd/portfolio?customerId=123456
    --header 'Authorization: Bearer 123456' \
    --header 'Signature: sig1=:OTEyMjY4...A5NTNDMEQ=:' \
    --header 'Signature-Input: sig1=("Authorization" "X-Client-Id" "@method" "@target-uri" "@path" "@query");keyid="staging-pipevest-ed25519";created=1732893484;expires=1732893584' \
    --header 'X-Client-Id: 123456' \

Example Response

{
  "data": {
    "ussdMessage": "My portfolio:\n 1.View my assets\n 2.Pending requests (TSLA)\n 3.Transaction history\n 4.Back",
    "ussdOptions": [
      {
        "option": 1,
        "requestUrl": "https://api.staging.pipevest.com/v1/ussd/assets?customerId=123456",
        "requestType": "GET"
      },
      {
        "option": 2,
        "requestUrl": "https://api.staging.pipevest.com/v1/ussd/requests?customerId=123456&status=PENDING",
        "requestType": "GET"
      },
      {
        "option": 3,
        "requestUrl": "https://api.staging.pipevest.com/v1/ussd/transactions?customerId=123456",
        "requestType": "GET"
      },
      {
        "option": 4,
        "requestUrl": "https://api.staging.pipevest.com/v1/ussd/home?customerId=123456",
        "requestType": "GET"
      }
    ]
  },
  "code": 200,
  "message": "Success"
}

Query parameters

queryDefinitionRequired
customerIdThe unique customer identiferYes

Portfolio View Example

USSD Portfolio View

Check out an example of the ussd portfolio view