{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"3c40d43e-aa57-4ca8-aa69-d5d3159c3c0f","name":"SheevaConnect API Specification 2.0","description":"This SheevaConnect™ API Specification 2.0 is © 2024 Parkofon Inc. (d/b/a [Sheeva.AI](https://sheeva.ai/)) and is proprietary information that may not be duplicated, redistributed, form the basis of derivative works, or publicly performed/displayed without the expressed written permission of [Sheeva.AI](https://sheeva.ai/). If you wish to use the SheevaConnect™ API Specification 2.0 and use the SheevaConnect™ cloud platform, please [contact Sheeva.AI](https://www.sheeva.ai/contact) for a license.\n\nSheevaConnect APIs enable connected vehicle payments & last-mile services for various use cases including Fueling, EV Charging, Parking and Retail. This solution allows automated & contactless payment in addition to proactive identification of user needs and last-mile navigation to the nearest Sheeva Pay enabled outlets.\n\nAll APIs follow HTTP status codes, return HTTP 200 OK when successful and following HTTP errors with a message. The message is self explaining to indicate the error in request. The example error codes include :\n\n| **Error Code** | **Message** |\n| --- | --- |\n| 400 | Bad Request : Check the parameter values |\n| 404 | Resource not found |\n| 500 | Internal Server Error |\n\nSheevaConnect creates a session when system detects that vehicle requires a service (FUEL, CHARGING, PARKING). Each session goes through various statuses.\n\n**Session Status Codes**\n\n| **Status** | **Description** |\n| --- | --- |\n| LOW_FUEL_DETECTED | If vehicle was low on fuel and system has sent the notification to driver for low fuel or if vehicle is not low on fuel but driver clicks on fuel icon to pay. |\n| LOW_CHARGE_DETECTED | If vehicle was low on charge and system has sent the notification to driver for low charged or if vehicle is not low on chrage but driver clicks on charge icon to pay. |\n| AT_SERVICE_HUB | The driver has reached the fuel station / EV charge station / etc. |\n| AT_SERVICE_POINT | The driver is at fuel pump / charging bay. |\n| SERVICE_POINT_CONFIRMED | Driver confirms the fuel pump / charging bay. |\n| SERVICE_IN_PROGRESS | When driver uses a parking service and vehicle is parked |\n| SERVICE_COMPLETE | When user marks the fuel, charging, parking complete |\n| SERVICE_CANCELLED_BY_DRIVER | When user cancel the service at the pump/ charging bay |\n| SERVICE_ABORTED_BY_SYSTEM | When user does opt for service and move away from fuel pump/ charging bay |\n\n**Payment Status Codes**\n\n| **Status** | **Description** |\n| --- | --- |\n| PAYMENT_AUTHORIZED | When a payment is authorized. Only applicable for Credit Card, Wallet and Rewards. |\n| PAYMENT_INITIATED | When a payment is in progress. Only applicable for UPI in India. |\n| PAYMENT_COMPLETE | Payment has been processed for a given service. Applicable with all cases. |\n| PAYMENT_FAILED | When a payment fails for a given service. Applicable with all cases. |\n| PAYMENT_VOIDED | When a payment authorization was voided. Applicable with all cases. |\n| PAYMENT_REFUNDED | When a completed payment is refunded. Applicalbe with all cases. |\n\n**Note:** Each API also requires **x-sheeva-program-code** in the header, the value for which is provided by Sheeva.\n\n| **Host URL in Environment** | **Description** |\n| --- | --- |\n| host | This is the Host URL where all API end points are hosted except Vehicle Events. Example URL for sandbox  <br>USA: [https://dev-us-apis.sheeva.ai](https://dev-us-apis.sheeva.ai)  <br>India: [https://dev-in-apis.sheeva.ai](https://dev-in-apis.sheeva.ai) |\n| sheeva_vehicles_events_host | [This](https://dev-us-apis.sheeva.aihttps://dev-us-vehicle-events-api.sheeva.aiThis) is the Host URL where vehicle events end point is hosted. Example URL for sandbox  <br>USA: [https://dev-us-vehicle-events-api.sheeva.ai](https://dev-us-vehicle-events-api.sheeva.ai)  <br>India : [https://dev-in-vehicle-events-api.sheeva.ai](https://dev-in-vehicle-events-api.sheeva.ai) |\n\n- **How to setup Mock Server with Postman**\n    \n\n1. Create an account with Postman or use existing one to setup a mock server.\n    \n2. From workspaces, choose “Team Workspace”\n    \n3. Choose “Mock Servers“ from left panel\n    \n4. Click on (+) to “Create a mock server“\n    \n5. Right-hand side panel, enter the resource (e.g. /webhook) and response ( e.g. \"success\")\n    \n6. Click “\\[ Next \\]“\n    \n7. Enter “Mock Server Name“\n    \n8. **\\[ ✓ \\]** Make mock server private ( this mock `x-api-key` in header )\n    \n9. Click on \\[ Create Mock Server \\] to create the mock server\n    \n10. You will notice Mock server URL on the screen ([https://.mock.pstmn.io](https://sheeva-ai.atlassian.net/wiki/spaces/TEC/pages/90013697/Sheeva.ai+Platform+Webhooks#))\n    \n11. On Postman web, click on the profile pic, click on the settings to get the API Key ([https://postman.co/settings/me/api-keys](https://postman.co/settings/me/api-keys))","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"25751178","collectionId":"3c40d43e-aa57-4ca8-aa69-d5d3159c3c0f","publishedId":"2s93RTRYXo","public":true,"publicUrl":"https://api-spec.sheeva.ai","privateUrl":"https://go.postman.co/documentation/25751178-3c40d43e-aa57-4ca8-aa69-d5d3159c3c0f","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/83a4a1d8-744c-41c9-ac54-472a10a6ed38/U2hlZXZhIExvZ28uanBn","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":"https://content.pstmn.io/83a4a1d8-744c-41c9-ac54-472a10a6ed38/U2hlZXZhIExvZ28uanBn","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"}}]}},"version":"8.10.1","publishDate":"2025-02-26T20:11:48.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/83a4a1d8-744c-41c9-ac54-472a10a6ed38/U2hlZXZhIExvZ28uanBn","logoDark":"https://content.pstmn.io/83a4a1d8-744c-41c9-ac54-472a10a6ed38/U2hlZXZhIExvZ28uanBn"}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/7df595dd905a1206123ac68dd5ee19c1e64ebe47b241110c0eb3b73e4d8d296c","favicon":"https://sheeva.ai/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://api-spec.sheeva.ai/view/metadata/2s93RTRYXo"}