The transctions menu view displays the list of transactions across all assets.

Accessing the Transactions View

Make a GET request to /transactions

  curl --request GET \
    --url https://api.staging.pipevest.com/v1/ussd/transactions?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": "Transaction History:\n Apple (AAPL Purchase 200 ZK 12/08/24\n… 1. View More Transactions\n 2.Back",
    "ussdOptions": [
      {
        "option": 1,
        "requestUrl": "https://api.staging.pipevest.com/v1/ussd/transactions?customerId=123456&page=2",
        "requestType": "GET"
      },
      {
        "option": 2,
        "requestUrl": "https://api.staging.pipevest.com/v1/ussd/home?customerId=123456",
        "requestType": "GET"
      }
    ]
  },
  "code": 200,
  "message": "Success"
}

Paging transactions view

  curl --request GET \
    --url https://api.staging.pipevest.com/v1/ussd/transactions?customerId=123456&page=2
    ...

Individual asset transactions view

Providing the assetId will filter for the transactions associated with taht specific assetId,

  curl --request GET \
    --url https://api.staging.pipevest.com/v1/ussd/transactions?customerId=123456&assetId=123456
    ...

The response for both paging transactions and individual asset transactions view will be similar to the initial transactions menu view

Query parameters

queryDefinitionRequired
customerIdThe unique customer identiferYes
pageThe current set of viewable requests. Default 1No
assetIdThe unique asset identiferNo

Transactions View Example

USSD Transactions View

Check out an example of the ussd transactions view