Skip to content
Pipevest Developers

Overview

Pipevest Client API 1.0.0

Section titled “Pipevest Client API 1.0.0”

The Pipevest Client API. This reference documents the endpoints that are live today: OAuth client-credentials authentication, customer management and mobile-money payment status.

Broader product resources (accounts, assets, instruments, investment types, portfolios, requests, transactions, market data, reports and outbound webhooks) are on the roadmap and are documented under Roadmap in the guides — they are not part of this live reference yet.

All resource identifiers are CUID strings (e.g. clx0a1b2c3d4e5f6g7h8i9j0k).

Information

  • OpenAPI version: 3.0.3

Operations

Section titled “Operations”
POST
/oauth/token
GET
/oauth/me
POST
/oauth/revoke
GET
/customers
POST
/customers
GET
/customers/{id}
PATCH
/customers/{id}
GET
/payment/status/{orderId}

Authentication

Section titled “Authentication”

bearerAuth

Section titled “bearerAuth”

Short-lived access token from POST /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