Skip to content
Pipevest Developers

Overview

Pipevest USSD API 1.0.0

Section titled “Pipevest USSD API 1.0.0”

The Pipevest USSD API. Exactly two endpoints drive the USSD menu state machine: POST /session creates a session and returns the HOME menu, and POST /process advances the session with the customer’s menu choice.

Both take a JSON body and are authenticated with an OAuth bearer token plus the x-client-id header. All identifiers are CUID strings.

Information

  • OpenAPI version: 3.0.3

Operations

Section titled “Operations”
POST
/session
POST
/process

Authentication

Section titled “Authentication”

BearerAuth

Section titled “BearerAuth”

Short-lived access token from POST /v1/oauth/token.

Security scheme type: http

Bearer format: JWT

ClientId

Section titled “ClientId”

Your organization clientId. Must match the clientId in the bearer token.

Security scheme type: apiKey

Header parameter name: x-client-id