{"info":{"_postman_id":"3dbac6c9-4194-42ce-ba00-320c0e0baecb","name":"Cinivest API Documentation","description":"

Comprehensive API for airtime, data bundle transactions, wallet management, and reseller operations.

Base URL

https://api.cinivestsys.com/v1\n\n

Authentication

All API requests require authentication using an API key in the header:

X-API-Key: sk_your_api_key_here\n\n

Getting Started

Get your API key from the dashboard at https://app.cinivestsys.com
\n
Set up authentication by adding your API key to the collection variables
\n
Test the API by running the \"API Health Check\" request
\n
Check your balance using the wallet endpoints
\n
Browse products and make your first purchase
\n

Support

Email: admin@cinivestsys.com
\n
Dashboard: https://app.cinivestsys.com
\n
Status: https://status.cinivestsys.com
\n

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"30332112","collectionId":"3dbac6c9-4194-42ce-ba00-320c0e0baecb","publishedId":"2sB3WqtKYD","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"facc15"},"publishDate":"2025-11-04T14:01:22.000Z"},"item":[{"name":"🏥 System","item":[{"name":"API Health Check","id":"3dc21a2d-d949-456f-85c9-22a9ea7c4713","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.cinivestsys.com/v1/","description":"

Check API health, version, and server status. This endpoint doesn't require authentication.

System health and status endpoints

\n","_postman_id":"66a288e0-ed71-4f5e-86e7-e4c2f008d5b4","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"sk_your_api_key_here"}]},"isInherited":true,"source":{"_postman_id":"3dbac6c9-4194-42ce-ba00-320c0e0baecb","id":"3dbac6c9-4194-42ce-ba00-320c0e0baecb","name":"Cinivest API Documentation","type":"collection"}}},{"name":"📦 Products","item":[{"name":"Affordable Data","item":[{"name":"Get Affordable Data Products","id":"bb78348f-b3e5-482c-8bce-46dd487882ee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-Key","value":"sk_your_api_key_here","type":"text"}],"url":"https://api.cinivestsys.com/v1/products/affordable-data?network=mtn","description":"

Retrieve internal affordable data products with discounted pricing.

Required Scope: products:read

Query Parameters:

network (optional): Filter by network - mtn, telecel, or airteltigo

Example Response:\nReturns an array of affordable data products with pricing, data amounts, and validity periods.

Filter by network (mtn, telecel, airteltigo)

\n","type":"text/plain"},"key":"network","value":"mtn"}],"variable":[]}},"response":[{"id":"7cdfc544-b7ca-45e9-954d-5dad538e711f","name":"Success Response","originalRequest":{"method":"GET","header":[{"key":"X-API-Key","value":"sk_example_key","type":"text"}],"url":"https://api.cinivestsys.com/v1/products/affordable-data"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Affordable data products retrieved successfully\",\n \"data\": {\n \"products\": [\n {\n \"id\": 1,\n \"name\": \"1GB MTN Data\",\n \"description\": \"1GB data bundle for MTN network\",\n \"category\": \"affordable_data\",\n \"network\": \"mtn\",\n \"price\": \"5.00\",\n \"data_amount\": \"1GB\",\n \"validity\": \"30 days\",\n \"product_type\": \"data\",\n \"status\": \"active\"\n },\n {\n \"id\": 2,\n \"name\": \"2GB MTN Data\",\n \"description\": \"2GB data bundle for MTN network\",\n \"category\": \"affordable_data\",\n \"network\": \"mtn\",\n \"price\": \"9.50\",\n \"data_amount\": \"2GB\",\n \"validity\": \"30 days\",\n \"product_type\": \"data\",\n \"status\": \"active\"\n }\n ],\n \"total_count\": 45,\n \"category\": \"affordable_data\",\n \"network_filter\": \"mtn\"\n }\n}"}],"_postman_id":"bb78348f-b3e5-482c-8bce-46dd487882ee"}],"id":"75152b31-7f4f-4d4c-bc5f-77793a87954b","description":"

Internal affordable data products with discounted pricing

\n","_postman_id":"75152b31-7f4f-4d4c-bc5f-77793a87954b","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"sk_your_api_key_here"}]},"isInherited":true,"source":{"_postman_id":"3dbac6c9-4194-42ce-ba00-320c0e0baecb","id":"3dbac6c9-4194-42ce-ba00-320c0e0baecb","name":"Cinivest API Documentation","type":"collection"}}},{"name":"Airtime & Data","item":[{"name":"Get Airtime & Data Products","id":"5465f065-0c4e-4a99-984c-4cad4156da8c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-Key","value":"sk_your_api_key_here","type":"text"}],"url":"https://api.cinivestsys.com/v1/products/airtime-data?network=mtn","description":"

Retrieve business airtime and data products.

Required Scope: products:read

Query Parameters:

network (optional): Filter by network

Note: These products have disguised IDs (e.g., prod_10_86c81d60) and support flexible pricing for airtime.

Filter by network (mtn, telecel, airteltigo)

\n","type":"text/plain"},"key":"network","value":"mtn"}],"variable":[]}},"response":[{"id":"4e0074ec-b5fa-4fd9-b186-ffaf633a1158","name":"Success Response","originalRequest":{"method":"GET","header":[],"url":"https://api.cinivestsys.com/v1/products/airtime-data"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Airtime & data products retrieved successfully\",\n \"data\": {\n \"products\": [\n {\n \"id\": \"prod_10_86c81d60\",\n \"name\": \"MTN AIRTIME\",\n \"description\": \"MTN AIRTIME\",\n \"category\": \"airtime_data\",\n \"network\": \"mtn\",\n \"price\": \"1\",\n \"data_amount\": null,\n \"validity\": null,\n \"product_type\": \"airtime\",\n \"status\": \"active\",\n \"external_id\": 10,\n \"external_code\": \"MTN_AIRTIME\",\n \"external_bundles\": [],\n \"min_value\": 0.5,\n \"max_value\": 1000,\n \"source\": \"external\"\n },\n {\n \"id\": \"prod_11_def45678\",\n \"name\": \"MTN Data Bundle\",\n \"description\": \"MTN Fixed Data Bundle\",\n \"category\": \"airtime_data\",\n \"network\": \"mtn\",\n \"price\": \"10.00\",\n \"data_amount\": \"1GB\",\n \"validity\": \"30 days\",\n \"product_type\": \"data\",\n \"status\": \"active\",\n \"external_id\": 11,\n \"external_code\": \"MTN_DATA_1GB\",\n \"external_bundles\": [\n {\n \"BundleCode\": \"RACT_Data_GHC_10_Others\",\n \"BundleType\": \"FIXED\",\n \"BundlePrice\": \"10.00\"\n }\n ],\n \"min_value\": null,\n \"max_value\": null,\n \"source\": \"external\"\n }\n ],\n \"total_count\": 7,\n \"category\": \"airtime_data\"\n }\n}"}],"_postman_id":"5465f065-0c4e-4a99-984c-4cad4156da8c"}],"id":"5d86c85e-6110-4696-ba18-0c61a058e767","description":"

Business airtime and data products from external providers

\n","_postman_id":"5d86c85e-6110-4696-ba18-0c61a058e767","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"sk_your_api_key_here"}]},"isInherited":true,"source":{"_postman_id":"3dbac6c9-4194-42ce-ba00-320c0e0baecb","id":"3dbac6c9-4194-42ce-ba00-320c0e0baecb","name":"Cinivest API Documentation","type":"collection"}}},{"name":"Purchase","item":[{"name":"Purchase Internal Product","id":"bc833e1a-f51e-4885-9496-b0ef6a1f6c8c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-Key","value":"sk_your_api_key_here","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"product_id\": 1,\n \"recipient_phone\": \"0547235323\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.cinivestsys.com/v1/products/purchase","description":"

Purchase an internal affordable data product.

Required Scope: products:purchase

Request Body:

product_id (integer, required): Internal product ID
recipient_phone (string, required): Phone number in format 0XXXXXXXXX

Notes:

Uses affordable_data wallet automatically
Price is fixed from product catalog

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"sk_your_api_key_here"}]},"isInherited":true,"source":{"_postman_id":"3dbac6c9-4194-42ce-ba00-320c0e0baecb","id":"3dbac6c9-4194-42ce-ba00-320c0e0baecb","name":"Cinivest API Documentation","type":"collection"}},"urlObject":{"path":["products","purchase"],"host":["https://api.cinivestsys.com/v1"],"query":[],"variable":[]}},"response":[{"id":"a7fdb7db-6225-450d-a5ec-399c29d7f22e","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"product_id\": 1,\n \"recipient_phone\": \"0547235323\"\n}"},"url":"https://api.cinivestsys.com/v1/products/purchase"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Purchase completed successfully\",\n \"data\": {\n \"transaction_ref\": \"purchase_1762255395_7088\",\n \"product\": {\n \"id\": 1,\n \"name\": \"1GB MTN Data\",\n \"price\": \"5.00\"\n },\n \"recipient_phone\": \"0547235323\",\n \"amount_charged\": \"5.00\",\n \"new_balance\": \"20.50\",\n \"status\": \"completed\"\n }\n}"}],"_postman_id":"bc833e1a-f51e-4885-9496-b0ef6a1f6c8c"},{"name":"Purchase External Airtime","id":"81b128d6-35ee-4052-90ae-c40e07dc45cb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-Key","value":"sk_your_api_key_here","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"product_id\": \"prod_10_86c81d60\",\n \"recipient_phone\": \"0547235323\",\n \"amount\": 5.00\n}","options":{"raw":{"language":"json"}}},"url":"https://api.cinivestsys.com/v1/products/purchase","description":"

Purchase external airtime with custom amount.

Required Scope: products:purchase

Request Body:

product_id (string, required): Disguised external product ID
recipient_phone (string, required): Phone number
amount (number, required): Amount to charge (0.50 - 1000.00)

Notes:

Uses airtime_data wallet automatically
Amount is flexible within min/max limits

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"sk_your_api_key_here"}]},"isInherited":true,"source":{"_postman_id":"3dbac6c9-4194-42ce-ba00-320c0e0baecb","id":"3dbac6c9-4194-42ce-ba00-320c0e0baecb","name":"Cinivest API Documentation","type":"collection"}},"urlObject":{"path":["products","purchase"],"host":["https://api.cinivestsys.com/v1"],"query":[],"variable":[]}},"response":[{"id":"bdd000ae-ad7c-4c1e-8edb-216f6c199832","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"product_id\": \"prod_10_86c81d60\",\n \"recipient_phone\": \"0547235323\",\n \"amount\": 5.00\n}"},"url":"https://api.cinivestsys.com/v1/products/purchase"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Purchase completed successfully\",\n \"data\": {\n \"transaction_ref\": \"purchase_1762255395_7089\",\n \"product_name\": \"MTN AIRTIME\",\n \"recipient_phone\": \"0547235323\",\n \"amount_charged\": \"5.00\",\n \"new_balance\": \"15.02\",\n \"status\": \"completed\"\n }\n}"}],"_postman_id":"81b128d6-35ee-4052-90ae-c40e07dc45cb"},{"name":"Purchase External Data Bundle","id":"7e4d9934-5995-4939-8597-059bcdfef519","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-Key","value":"sk_your_api_key_here","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"product_id\": \"prod_11_def45678\",\n \"recipient_phone\": \"0547235323\",\n \"amount\": 10.00,\n \"bundle_code\": \"RACT_Data_GHC_10_Others\",\n \"bundle_type\": \"FIXED\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.cinivestsys.com/v1/products/purchase","description":"

Purchase external data bundle with specific bundle details.

Required Scope: products:purchase

Request Body:

product_id (string, required): Disguised external product ID
recipient_phone (string, required): Phone number
amount (number, required): Amount to charge
bundle_code (string, optional): Specific bundle code
bundle_type (string, optional): Bundle type (FIXED/FLEXI)

Notes:

Bundle fields are auto-detected from product data if not provided

Unified purchase endpoint for all product types

\n","_postman_id":"24301210-2c86-44de-b237-3d2c8194db01","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"sk_your_api_key_here"}]},"isInherited":true,"source":{"_postman_id":"3dbac6c9-4194-42ce-ba00-320c0e0baecb","id":"3dbac6c9-4194-42ce-ba00-320c0e0baecb","name":"Cinivest API Documentation","type":"collection"}}},{"name":"Get Available Networks","id":"ed956e26-77e7-46a5-b7fd-110e4a41446a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.cinivestsys.com/v1/products/networks?category=affordable_data","description":"

Get list of networks that have available products.

Query Parameters:

category (optional): Filter by product category

No authentication required.

Filter networks by category

\n","type":"text/plain"},"key":"category","value":"affordable_data"}],"variable":[]}},"response":[],"_postman_id":"ed956e26-77e7-46a5-b7fd-110e4a41446a"}],"id":"e248107f-28d4-4a0f-87b2-e6dc85c19c34","description":"

Product catalog and purchase operations

\n","_postman_id":"e248107f-28d4-4a0f-87b2-e6dc85c19c34","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"sk_your_api_key_here"}]},"isInherited":true,"source":{"_postman_id":"3dbac6c9-4194-42ce-ba00-320c0e0baecb","id":"3dbac6c9-4194-42ce-ba00-320c0e0baecb","name":"Cinivest API Documentation","type":"collection"}}},{"name":"💰 Wallet","item":[{"name":"Get Wallet Balance","id":"3fdd75ff-5dc4-4bf2-ad63-9a7f1718cb50","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-Key","value":"sk_your_api_key_here","type":"text"}],"url":"https://api.cinivestsys.com/v1/wallet/balance","description":"

Retrieve current wallet balances for all wallet types.

Required Scope: wallet:read

Response includes:

Affordable data balance
Airtime data balance
Commission rate

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"sk_your_api_key_here"}]},"isInherited":true,"source":{"_postman_id":"3dbac6c9-4194-42ce-ba00-320c0e0baecb","id":"3dbac6c9-4194-42ce-ba00-320c0e0baecb","name":"Cinivest API Documentation","type":"collection"}},"urlObject":{"path":["wallet","balance"],"host":["https://api.cinivestsys.com/v1"],"query":[],"variable":[]}},"response":[{"id":"278ad22c-807f-409d-91e9-13a298b3e3c7","name":"Success Response","originalRequest":{"method":"GET","header":[{"key":"X-API-Key","value":"sk_example_key"}],"url":"https://api.cinivestsys.com/v1/wallet/balance"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Wallet balances retrieved successfully\",\n \"data\": {\n \"affordable_data_balance\": \"25.50\",\n \"airtime_data_balance\": \"150.75\",\n \"commission_rate\": \"5.00\"\n }\n}"}],"_postman_id":"3fdd75ff-5dc4-4bf2-ad63-9a7f1718cb50"},{"name":"Initiate Wallet Deposit","id":"026e0bb2-e846-4ac4-8328-210e3831594e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-Key","value":"sk_your_api_key_here","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\": 50.00,\n \"wallet_type\": \"airtime_data\",\n \"payment_phone\": \"0547235323\",\n \"network\": \"mtn\",\n \"reference\": \"Top up for purchases\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.cinivestsys.com/v1/wallet/deposit","description":"

Start a mobile money deposit to wallet.

Required Scope: wallet:write

Request Body:

amount (number, required): Amount to deposit (min: 0.50)
wallet_type (string, required): affordable_data or airtime_data
payment_phone (string, required): Mobile money phone number
network (string, required): Payment network (mtn, telecel, airteltigo)
reference (string, optional): Description for the deposit

Wallet balance and deposit operations

\n","_postman_id":"c7c8cbea-fea4-420d-bd89-1d1e24d5bbd4","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"sk_your_api_key_here"}]},"isInherited":true,"source":{"_postman_id":"3dbac6c9-4194-42ce-ba00-320c0e0baecb","id":"3dbac6c9-4194-42ce-ba00-320c0e0baecb","name":"Cinivest API Documentation","type":"collection"}}},{"name":"📊 Transactions","item":[{"name":"Get Transaction History","id":"86002217-c954-4139-a730-b4eb271581e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-Key","value":"sk_your_api_key_here","type":"text"}],"url":"https://api.cinivestsys.com/v1/transactions?limit=20&offset=0&status=completed","description":"

Retrieve paginated transaction history with filtering options.

Required Scope: transactions:read

Query Parameters:

limit (1-100): Number of transactions
offset (0+): Skip transactions for pagination
status: completed, failed, processing, pending
type: purchase, deposit
wallet_type: affordable_data, airtime_data
date_from/date_to: Date range filter (YYYY-MM-DD)

Number of transactions to return (1-100)

\n","type":"text/plain"},"key":"limit","value":"20"},{"description":{"content":"

Number of transactions to skip

\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"

Filter by status

\n","type":"text/plain"},"key":"status","value":"completed"},{"disabled":true,"description":{"content":"

Filter by type

\n","type":"text/plain"},"key":"type","value":"purchase"},{"disabled":true,"description":{"content":"

Filter by wallet

\n","type":"text/plain"},"key":"wallet_type","value":"airtime_data"},{"disabled":true,"description":{"content":"

Start date (YYYY-MM-DD)

\n","type":"text/plain"},"key":"date_from","value":"2025-01-01"},{"disabled":true,"description":{"content":"

End date (YYYY-MM-DD)

\n","type":"text/plain"},"key":"date_to","value":"2025-01-31"}],"variable":[]}},"response":[],"_postman_id":"86002217-c954-4139-a730-b4eb271581e6"},{"name":"Get Transaction Statistics","id":"81e9cb93-3263-4c53-9733-c3741e6b9199","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-Key","value":"sk_your_api_key_here","type":"text"}],"url":"https://api.cinivestsys.com/v1/transactions/stats","description":"

Retrieve transaction analytics and statistics for the last 30 days.

Required Scope: transactions:read

Returns:

Total transaction counts
Success rates
Amount summaries
Wallet breakdowns
Transaction type analysis

Retrieve specific transaction details by reference ID.

Required Scope: transactions:read

Path Parameters:

transaction_reference: The unique reference ID returned from purchase/deposit operations

Transaction reference ID

\n","type":"text/plain"},"type":"any","value":"purchase_1762255395_7088","key":"transaction_reference"}]}},"response":[],"_postman_id":"48c85d97-a501-4be2-a05b-5660bb84fed3"}],"id":"9f0e7492-9d98-4401-a353-47033e7feb36","description":"

Transaction history and analytics

\n","_postman_id":"9f0e7492-9d98-4401-a353-47033e7feb36","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"sk_your_api_key_here"}]},"isInherited":true,"source":{"_postman_id":"3dbac6c9-4194-42ce-ba00-320c0e0baecb","id":"3dbac6c9-4194-42ce-ba00-320c0e0baecb","name":"Cinivest API Documentation","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"sk_your_api_key_here"}]}},"variable":[{"key":"base_url","value":"https://api.cinivestsys.com/v1","type":"string"},{"key":"api_key","value":"sk_your_api_key_here","type":"string","description":"Your API key from https://app.cinivestsys.com"}]}