Canceling a request will immediately close the customer’s executable order request within our system.

It is highly recommended that you require the customer to input some sort of security key (i.e. pin, OTP, etc…) before making the PUT request to cancel an order request.

​
Canceling an order request

Make a PUT request to /requests

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

Example Response

{
  "data": {
    "ussdMessage": "Zamtel Message\n Your asset cancel request has been delivered. You will receive a confirmation shortly.",
    "ussdConfirm": {
      "requestUrl": "https://api.staging.pipevest.com/v1/ussd/requests?customerId=123456&symbol=AAPL",
      "requestType": "GET"
    }
  },
  "code": 200,
  "message": "Success"
}

​
Query parameters

queryDefinitionRequired
customerIdThe unique customer identiferYes
cancelModeSets request to cancel modeYes
requestIdThe unique request identiferYes

​
Confirm request view example

USSD Cancel Request View

Check out an example of the ussd cancel request view