This SheevaConnect™ API Specification 2.0 is © 2024 Parkofon Inc. (d/b/a 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. If you wish to use the SheevaConnect™ API Specification 2.0 and use the SheevaConnect™ cloud platform, please contact Sheeva.AI for a license.
\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.
\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 :
\nSheevaConnect creates a session when system detects that vehicle requires a service (FUEL, CHARGING, PARKING). Each session goes through various statuses.
\nSession Status Codes
\nPayment Status Codes
\nNote: Each API also requires x-sheeva-program-code in the header, the value for which is provided by Sheeva.
\nCreate an account with Postman or use existing one to setup a mock server.
\nFrom workspaces, choose “Team Workspace”
\nChoose “Mock Servers“ from left panel
\nClick on (+) to “Create a mock server“
\nRight-hand side panel, enter the resource (e.g. /webhook) and response ( e.g. \"success\")
\nClick “[ Next ]“
\nEnter “Mock Server Name“
\n[ ✓ ] Make mock server private ( this mock x-api-key in header )
Click on [ Create Mock Server ] to create the mock server
\nYou will notice Mock server URL on the screen (https://.mock.pstmn.io)
\nOn Postman web, click on the profile pic, click on the settings to get the API Key (https://postman.co/settings/me/api-keys)
\nAssigned by Sheeva.AI
\n","type":"text"},{"key":"client-secret","value":"{{client-secret}}","description":"Assigned by Sheeva.AI
\n","type":"text"}],"url":"{{host}}/v2/auth","description":"The authentication service endpoint is used to get an access token, which must be sent with each call as a Bearer Token.
\nIf successful, returns: HTTP 200 OK.
\n","urlObject":{"path":["v2","auth"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"352c57d2-046e-45f1-b90d-5fd29e280edf","name":"Authentication Example1","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"client-id","value":"6779ef20e75817b79602","description":"Assigned by Sheeva.AI","type":"text"},{"key":"client-secret","value":"68656c6c6f776f726c64202d207468697320697320612064756d6d7920636c69656e7420736563726574","description":"Assigned by Sheeva.AI","type":"text"}],"url":"{{auth-host}}/v2/auth"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"accessToken\": \"eyJraWQiOiJDTUpFa3VnQ3N5NkZDNW1ONGJzZThaK3FmaUE5TUhOTEZcL2FzbWMxYVNBTT0iLCJhbGciOiJSUzI1NiJ9.eyJvcmlnaW5fanRpIjoiYTQ5NTgwZTYtZjMwNS00Y2FiLTg5ZjgtZjBmZTVkODMwZjE0Iiwic3ViIjoiODJmYjk0NmItYTlkOC00ZDFkLThmZjAtNjg2OWZiOTkyMDExIiwiYXVkIjoiN3Zvb3Ixcmg1ZGdvOTR0cG8zOGlhbnAyZW0iLCJldmVudF9pZCI6IjRiMDE5OWE3LTA5MDMtNGQwNC05MmRiLWQ4ZmQ2NmNhODJkNyIsInRva2VuX3VzZSI6ImlkIiwiYXV0aF90aW1lIjoxNjY5Mzg5MDY2LCJpc3MiOiJodHRwczpcL1wvY29nbml0by1pZHAuYXAtc291dGgtMS5hbWF6b25hd3MuY29tXC9hcC1zb3V0aC0xX0ZNMVp6aVlZRCIsImNvZ25pdG86dXNlcm5hbWUiOiJ4YXZmazc2ampoemVteXVxZXNxbGFhZjgybnN2bXJkYSIsImV4cCI6MTY2OTM5MjY2NiwiaWF0IjoxNjY5Mzg5MDY2LCJqdGkiOiJlM2IwZmI5NC01MmNmLTQyMjUtYWJjOC1kZGUzZmU0NzRiNWEifQ.h0-3V-VXIspFaXPRLvxHOxM_-J5wba6gPvKB7djTLEkja6OVnAIr3O4RfW96AcII7-ybCziVtqXc-6hUXMw9eLrrHNwO_5MHK6S89XQaMCU75ySLCuQzF9M_hgq8m7pIuEEuvVr8g0LbYNZ3aIMlCwuVsWS16gMgbJUH9yHx1K1jNs3hAg0OmeZHl6NF39LcU7gsB_U4t1s__t-vhy534FiC-eCSHzRjpcsBEWHGSaizP_7BUb3jmtLKdOUbuTDebGtPB9ZCVQqVdZu4sLcdLMYZ3hBnfSdCjQtQMNfk4m7d24HbDV_T5aDuqN8s5r1_FPSbLWw354xEv1_vSo3luQ\",\n \"expiresIn\": 3600\n}"}],"_postman_id":"78c90827-a658-428a-99a8-57d119c4406a"}],"id":"8b5ddbf8-2c74-4d2d-8cce-c09c541c97b3","description":"Authentication related APIs
\n","_postman_id":"8b5ddbf8-2c74-4d2d-8cce-c09c541c97b3"},{"name":"Vehicle Events","item":[{"name":"Vehicle Events","event":[{"listen":"prerequest","script":{"id":"0c2068fd-3923-4246-837c-ce2b519d960d","exec":["pm.variables.set(\"requestTimeStamp\", (new Date().getTime())/1000);",""],"type":"text/javascript"}}],"id":"0028cbb0-4514-439c-98f2-ae516bf9e72a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"},{"key":"clientId","value":"{{clientId}}","type":"text"}],"body":{"mode":"raw","raw":"[{\n \"vin\": \"TSTLRGBL663PR2127\", // Mandatory.\n \"statuses\": [{ // Mandatory - speed is required. Either fuelLevel or chargingLevel is required depending on the usecase. Rest of the statuses are optional\n \"key\": \"speed\", // [speed, fuelLevel, chargingLevel, ignition, transmission]\n \"value\": \"30.5\", // Decimal value (within a string) for speed\n \"timestamp\": 1685619240 // Epoch UTC time\n },{\n \"key\": \"fuelLevel\", // [speed, fuelLevel, chargingLevel, ignition, transmission]\n \"value\": \"6\", // Integer percentage value from 1 to 100 (within a string) for fuelLevel\n \"timestamp\": 1685619240 // Epoch UTC time\n },{\n \"key\": \"chargingLevel\", // [speed, fuelLevel, chargingLevel, ignition, transmission]\n \"value\": \"6\", // Integer percentage value from 1 to 100 (within a string) for chargeLevel\n \"timestamp\": 1685619240 // Epoch UTC time\n },{\n \"key\": \"ignition\", // [speed, fuelLevel, chargingLevel, ignition, transmission]\n \"value\": \"on\", // [on, off] for ignition\n \"timestamp\": 1685619240 // Epoch UTC time\n }],\n \"location\": { // Mandatory.\n \"latitude\": 38.9263669701, // Mandatory.\n \"longitude\": -77.2406171718, // Mandatory.\n \"timestamp\": 1685619240 // Mandatory.\n }\n}]","options":{"raw":{"language":"json"}}},"url":"{{sheeva_vehicles_events_host}}/vehicle-events","description":"This request accepts vehicle status for multiple vehicles, which includes current vehicle location, fuel / charge level, speed, parking brake and ignition status.
\nIf successful, returns: HTTP 201 CREATED.
\nNote: This replaces the older \"Vehicle Events\" endpoint. Use this instead.
\n","urlObject":{"path":["vehicle-events"],"host":["{{sheeva_vehicles_events_host}}"],"query":[],"variable":[]}},"response":[{"id":"c22befc5-8189-4ea9-a0cd-b9a1121a1d38","name":"Vehicle Events for Low Fuel","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"},{"key":"clientId","value":"{{clientId}}","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"vin\": \"{{vin}}\",\n \"statuses\": [\n {\n \"key\": \"fuelLevel\",\n \"value\": \"6\",\n \"timestamp\": 1685619240\n },\n {\n \"key\": \"speed\",\n \"value\": \"5\",\n \"timestamp\": 1685619240\n },\n {\n \"key\": \"ignition\",\n \"value\": \"on\",\n \"timestamp\": 1685619240\n }\n ],\n \"location\": {\n \"latitude\": 19.100085300209695,\n \"longitude\": 72.87892408115249,\n \"timestamp\": 1685619240\n }\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{sheeva_vehicles_events_host}}/vehicle-events"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"fa665f33-5ce4-4494-9293-df4cf1bf796b","name":"Vehicle Events for Left Station","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"},{"key":"clientId","value":"{{clientId}}","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"vin\": \"TSTLRGBL663PR2127\",\n \"statuses\": [\n {\n \"key\": \"speed\",\n \"value\": \"10\",\n \"timestamp\": 1685619240\n },\n {\n \"key\": \"fuelLevel\",\n \"value\": \"50\",\n \"timestamp\": 1685619240\n },\n {\n \"key\": \"ignition\",\n \"value\": \"on\",\n \"timestamp\": 1685619240\n }\n ],\n \"location\": {\n \"latitude\": 38.9263669701,\n \"longitude\": -77.2406171718,\n \"timestamp\": 1685619240\n }\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{sheeva_vehicles_events_host}}/vehicle-events"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"4f846ede-0f51-4b28-b7be-fe61482c2875","name":"Vehicle Events for At Service Hub (At Fuel Station)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"},{"key":"clientId","value":"{{clientId}}","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"vin\": \"TSTLRGBL663PR2127\",\n \"statuses\": [\n {\n \"key\": \"fuelLevel\",\n \"value\": \"6\",\n \"timestamp\": 1685619240\n },\n {\n \"key\": \"speed\",\n \"value\": \"5\",\n \"timestamp\": 1685619240\n },\n {\n \"key\": \"ignition\",\n \"value\": \"on\",\n \"timestamp\": 1685619240\n }\n ],\n \"location\": {\n \"latitude\": 38.9263669701,\n \"longitude\": -77.2406171718,\n \"timestamp\": 1685619240\n }\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{sheeva_vehicles_events_host}}/vehicle-events"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"17b83bd7-ab41-4252-bf3c-0cf1938e6a85","name":"Vehicle Events At Service Point (At Pump)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"},{"key":"clientId","value":"{{clientId}}","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"vin\": \"TSTLRGBL663PR2127\",\n \"statuses\": [\n {\n \"key\": \"speed\",\n \"value\": \"0\",\n \"timestamp\": 1685619240\n },\n {\n \"key\": \"fuelLevel\",\n \"value\": \"6\",\n \"timestamp\": 1685619240\n },\n {\n \"key\": \"ignition\",\n \"value\": \"off\",\n \"timestamp\": 1685619240\n }\n ],\n \"location\": {\n \"latitude\": 38.9263669701,\n \"longitude\": -77.2406171718,\n \"timestamp\": 1685619240\n }\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{sheeva_vehicles_events_host}}/vehicle-events"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"0028cbb0-4514-439c-98f2-ae516bf9e72a"}],"id":"951af009-73d7-4ff3-89c9-0702188878f6","_postman_id":"951af009-73d7-4ff3-89c9-0702188878f6","description":""},{"name":"Account Management","item":[{"name":"Driver","item":[{"name":"Register Driver","id":"d1bd0618-57f0-450a-9096-aca4ca677f28","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"countryCode\": \"1\", // Mandatory. Example Values - 1, 91, +1, +91 \n \"phoneNumber\": \"81342424242\", // Mandatory - Must be a mobile number\n \"email\": \"jdoe@email.com\", // Can be configured mandatory/optional, as required by program\n \"firstName\": \"John\", // Mandatory\n \"lastName\": \"Doe\", // Mandatory\n \"birthDate\": \"21-05-1981\", // Can be configured mandatory/optional, as required by program, Format - dd-mm-yyyy\n \"gender\": \"Male\", // Mandatory - Male/Female/Other \n \"postalCode\": \"249408\", // Mandatory\n \"driverId\": \"dri_partner_B8vR4R4vFsDoX3sg3W7z\", // Mandatory, Partner assigned unique driver identifier \n \"salutation\": \"Mr.\", // Mandatory as required by program - Mr./Mrs.\n \"city\": \"New Delhi\", // Can be configured mandatory/optional, as required by program\n \"district\":\"Okhla\", // Can be configured mandatory/optional, as required by program\n \"state\":\"Delhi\", // Can be configured mandatory/optional, as required by program\n \"address1\":\"1234 S 32 Birla Towers\", // Can be configured mandatory/optional, as required by program\n \"address2\":\"Jagat Nagar\" // Can be configured mandatory/optional, as required by program\n }","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/partner-apis/drivers","description":"This request allows to add a driver profile.
\nIf successful, returns: HTTP 201 CREATED.
\n","urlObject":{"path":["v2","partner-apis","drivers"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"1777fb09-8c89-4790-a462-822f4a3f90b9","name":"Register Driver Example - USA","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","description":"Received from authentication endpoint","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"countryCode\": \"1\", // Mandatory, Example Values - 1, 91, +1, +91 \n \"phoneNumber\": \"5556789999\", // Mandatory - Must be a 10 digit mobile number\n \"email\": \"jsmith@email.com\", // Can be configured mandatory/optional, as required by program\n \"firstName\": \"John\", // Mandatory\n \"lastName\": \"Smith\", // Mandatory\n \"birthDate\": \"21-05-1982\", // Can be configured mandatory/optional, as required by program, Format - dd-mm-yyyy\n \"gender\": \"Male\", // Mandatory - Male/Female/Other \n \"postalCode\": \"249408\", // Mandatory\n \"driverId\": \"dri_partner_B8vR4R4vFsDoX3sg3W7z\", // Partner assigned unique driver identifier\n \"active\": true, // Mandatory. Always pass `true` while onboarding.\n \"salutation\": \"Mr.\", // Mandatory as required by program - Mr./Mrs.\n \"referralPhoneNumber\":\"8290808122\", // Optional\n \"referralCode\": \"POIQWE123\", // Can be configured mandatory/optional, as required by a program\n \"city\": \"New Delhi\", // Can be configured mandatory/optional, as required by a program\n \"district\":\"Okhla\", // Can be configured mandatory/optional, as required by a program\n \"state\":\"Delhi\", // Can be configured mandatory/optional, as required by a program\n \"address1\":\"1234 S 32 Birla Towers\", // Can be configured mandatory/optional, as required by a program\n \"address2\":\"Jagat Nagar\" // Can be configured mandatory/optional, as required by a program\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/v2/partner-apis/drivers","host":["{{host}}"],"path":["v2","partner-apis","drivers"],"query":[{"key":"","value":null,"type":"text","disabled":true}]}},"status":"OK","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 02 May 2023 13:56:33 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"148"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"b34960d9-fe78-4ad1-9fdb-e9e810d5b5b4"},{"key":"x-amzn-Remapped-Connection","value":"keep-alive"},{"key":"x-amz-apigw-id","value":"ETB2sHc6oAMF27w="},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"x-amzn-Remapped-Date","value":"Tue, 02 May 2023 13:56:33 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"countryCode\": \"1\", // E.164 code - Required\n \"phoneNumber\": \"5556789999\", // Driver phone number - Required\n \"firstName\": \"John\", // First name - Required\n \"lastName\": \"Smith\", // Last name - Required\n \"email\": \"jsmith@email.com\", // Email address - Optional\n \"driverId\": \"dri_partner_B8vR4R4vFsDoX3sg3W7z\", // Partner assigned unique driver identifier\n \"addressDetails\":{\n \"address1\":\"8521 Leesburg VA\", \n \"address2\":\"#250\",\n \"city\": \"Vienna\",\n \"state\":\"VA\",\n \"postalCode\":\"22182\" //Required\n }\n}"},{"id":"ae1199d3-46c4-4892-a77e-e138448e900d","name":"Register Driver Example - Japan","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","description":"Received from authentication endpoint","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"countryCode\": \"1\", // Mandatory, Example Values - 1, 91, +1, +91 \n \"phoneNumber\": \"5556789999\", // Mandatory - Must be a 10 digit mobile number\n \"email\": \"jsmith@email.com\", // Can be configured mandatory/optional, as required by program\n \"firstName\": \"John\", // Mandatory\n \"lastName\": \"Smith\", // Mandatory\n \"birthDate\": \"21-05-1982\", // Can be configured mandatory/optional, as required by program, Format - dd-mm-yyyy\n \"gender\": \"Male\", // Mandatory - Male/Female/Other \n \"postalCode\": \"249408\", // Mandatory\n \"driverId\": \"dri_partner_B8vR4R4vFsDoX3sg3W7z\", // Partner assigned unique driver identifier\n \"active\": true, // Mandatory. Always pass `true` while onboarding.\n \"salutation\": \"Mr.\", // Mandatory as required by program - Mr./Mrs.\n \"referralPhoneNumber\":\"8290808122\", // Optional\n \"referralCode\": \"POIQWE123\", // Can be configured mandatory/optional, as required by a program\n \"city\": \"New Delhi\", // Can be configured mandatory/optional, as required by a program\n \"district\":\"Okhla\", // Can be configured mandatory/optional, as required by a program\n \"state\":\"Delhi\", // Can be configured mandatory/optional, as required by a program\n \"address1\":\"1234 S 32 Birla Towers\", // Can be configured mandatory/optional, as required by a program\n \"address2\":\"Jagat Nagar\" // Can be configured mandatory/optional, as required by a program\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/v2/partner-apis/drivers","host":["{{host}}"],"path":["v2","partner-apis","drivers"],"query":[{"key":"","value":null,"type":"text","disabled":true}]}},"status":"OK","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 02 May 2023 13:56:33 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"148"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"b34960d9-fe78-4ad1-9fdb-e9e810d5b5b4"},{"key":"x-amzn-Remapped-Connection","value":"keep-alive"},{"key":"x-amz-apigw-id","value":"ETB2sHc6oAMF27w="},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"x-amzn-Remapped-Date","value":"Tue, 02 May 2023 13:56:33 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"countryCode\": \"81\", // E.164 code\n \"phoneNumber\": \"5556789999\", // Driver phone number\n \"firstName\": \"John\", // First name\n \"lastName\": \"Smith\", // Last name\n \"email\": \"jsmith@email.com\", // Email address\n \"driverId\": \"dri_partner_B8vR4R4vFsDoX3sg3W7z\", // Partner assigned unique driver identifier\n \"addressDetails\":{\n \"address1\":\"1234 S 32 Birla Towers\", \n \"address2\":\"Jagat Nagar\",\n \"city\": \"New Delhi\",\n \"district\":\"Okhla\", \n \"state\":\"Delhi\",\n \"postalCode\":\"249408\"\n }\n}"},{"id":"8a212454-5c0b-46f9-b95e-dfaf5b0c7685","name":"Register Driver Example1 - India","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","description":"Received from authentication endpoint","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"countryCode\": \"1\", // Mandatory, Example Values - 1, 91, +1, +91 \n \"phoneNumber\": \"5556789999\", // Mandatory - Must be a 10 digit mobile number\n \"email\": \"jsmith@email.com\", // Can be configured mandatory/optional, as required by program\n \"firstName\": \"John\", // Mandatory\n \"lastName\": \"Smith\", // Mandatory\n \"birthDate\": \"21-05-1982\", // Can be configured mandatory/optional, as required by program, Format - dd-mm-yyyy\n \"gender\": \"Male\", // Mandatory - Male/Female/Other \n \"postalCode\": \"249408\", // Mandatory\n \"driverId\": \"dri_partner_B8vR4R4vFsDoX3sg3W7z\", // Partner assigned unique driver identifier\n \"active\": true, // Mandatory. Always pass `true` while onboarding.\n \"salutation\": \"Mr.\", // Mandatory as required by program - Mr./Mrs.\n \"referralPhoneNumber\":\"8290808122\", // Optional\n \"referralCode\": \"POIQWE123\", // Can be configured mandatory/optional, as required by a program\n \"city\": \"New Delhi\", // Can be configured mandatory/optional, as required by a program\n \"district\":\"Okhla\", // Can be configured mandatory/optional, as required by a program\n \"state\":\"Delhi\", // Can be configured mandatory/optional, as required by a program\n \"address1\":\"1234 S 32 Birla Towers\", // Can be configured mandatory/optional, as required by a program\n \"address2\":\"Jagat Nagar\", // Can be configured mandatory/optional, as required by a program\n \"referredByMerchant\":\"123454321\", // Merchant Id Can be configured mandatory/optional, as required by a program\n \"referredByFSM\":\"9908083242\" // MobileNumber, Can be configured mandatory/optional, as required by a program\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/v2/partner-apis/drivers","host":["{{host}}"],"path":["v2","partner-apis","drivers"],"query":[{"key":"","value":null,"type":"text","disabled":true}]}},"status":"OK","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 02 May 2023 13:56:33 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"148"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"b34960d9-fe78-4ad1-9fdb-e9e810d5b5b4"},{"key":"x-amzn-Remapped-Connection","value":"keep-alive"},{"key":"x-amz-apigw-id","value":"ETB2sHc6oAMF27w="},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"x-amzn-Remapped-Date","value":"Tue, 02 May 2023 13:56:33 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"countryCode\": \"91\", // E.164 code\n \"phoneNumber\": \"5556789999\", // Driver phone number\n \"firstName\": \"John\", // First name\n \"lastName\": \"Smith\", // Last name\n \"email\": \"jsmith@email.com\", // Email address\n \"driverId\": \"dri_partner_B8vR4R4vFsDoX3sg3W7z\", // Partner assigned unique driver identifier\n \"salutation\": \"Mr.\", \n \"addressDetails\":{\n \"address1\":\"1234 S 32 Birla Towers\", \n \"address2\":\"Jagat Nagar\",\n \"city\": \"New Delhi\",\n \"district\":\"Okhla\", \n \"state\":\"Delhi\",\n \"postalCode\":\"249408\"\n }\n}"}],"_postman_id":"d1bd0618-57f0-450a-9096-aca4ca677f28"},{"name":"Get Driver","id":"e61b2cba-4b81-462e-a4a3-1112f9d019ea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/partner-apis/drivers/{{driverId}}","description":"This request returns a driver profile.
\nIf successful, returns: HTTP 200 OK.
\n","urlObject":{"path":["v2","partner-apis","drivers","{{driverId}}"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"06f254fc-31ae-45eb-bf65-617bd0da4c5d","name":"Get Driver Example - Found","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text","description":"Received from authentication endpoint"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"url":"{{host}}/v2/partner-apis/drivers/dri_dc92d48cc952f38cb87b"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"countryCode\": \"1\", // E.164 code\n \"phoneNumber\": \"8134242424\", // Driver phone number\n \"firstName\": \"John\", // First name\n \"lastName\": \"Doe\", // Last name\n \"email\": \"john.doe@gmail.com\", // Email address \n \"driverId\": \"dri_partner_B8vR4R4vFsDoX3sg3W7z\", // Partner assigned unique driver identifier\n \"active\": true, // Is driver active?\n \"salutation\": \"Mr.\", \n \"referralPhoneNumber\":\"8290808122\", \n \"referralCode\": \"POIQWE123\", \n \"addressDetails\":{\n \"address1\":\"1234 S 32 Birla Towers\", \n \"address2\":\"Jagat Nagar\",\n \"city\": \"New Delhi\",\n \"district\":\"Okhla\", \n \"state\":\"Delhi\",\n \"postalCode\":\"249408\"\n },\n \"referredByMerchant\":\"123454321\", \n \"referredByFSM\":\"9908083242\"\n}"},{"id":"f68ec0a3-2438-41d8-83b2-7f4235d8878a","name":"Get Driver Example - Not Found","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text","description":"Received from authentication endpoint"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"url":"{{host}}/v2/partner-apis/drivers/dri_dc92d48cc952f38cb87b"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Not Found\",\n \"path\": \"/drivers/dri_partner_B8vR4R4vFsDoX3sg3W7z\",\n \"status\": 404,\n \"timestamp\": 1683482804178\n}"}],"_postman_id":"e61b2cba-4b81-462e-a4a3-1112f9d019ea"},{"name":"Update Driver","id":"fbfd2795-47a9-4a84-8b30-d08fd36e0051","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"countryCode\": \"1\", // Optional (for PATCH operation).\n \"phoneNumber\": \"81342424242\", // Optional (for PATCH operation).\n \"email\": \"jdoe@gmail.com\", // Optional (for PATCH operation).\n \"firstName\": \"John\", // Optional (for PATCH operation).\n \"lastName\": \"Doe\", // Optional (for PATCH operation).\n \"active\": true, // Optional (for PATCH operation).\n \"salutation\": \"Mr.\", // Optional (for PATCH operation).\n \"referralPhoneNumber\":\"8290808122\", // Optional (for PATCH operation).\n \"referralCode\": \"POIQWE123\", // Optional (for PATCH operation).\n \"city\": \"New Delhi\", // Optional (for PATCH operation).\n \"district\":\"Okhla\", // Optional (for PATCH operation).\n \"state\":\"Delhi\", // Optional (for PATCH operation).\n \"address1\":\"1234 S 32 Birla Towers\", // Optional (for PATCH operation).\n \"address2\":\"Jagat Nagar\", // Optional (for PATCH operation).\n \"postalCode\": \"249408\", // Optional (for PATCH operation).\n \"referredByMerchant\":\"123454321\", // Optional (for PATCH operation).\n \"referredByFSM\":\"9908083242\" // Optional (for PATCH operation).\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/partner-apis/drivers/{{driverId}}","description":"This request allows you to update details of a driver profile.
\nIf successful, returns HTTP 200 OK.
\n","urlObject":{"path":["v2","partner-apis","drivers","{{driverId}}"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"df873dda-1112-4f7a-b750-2f8a138e3fe6","name":"Update Driver","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"countryCode\": \"1\", // Optional (for PATCH operation).\n \"phoneNumber\": \"81342424242\", // Optional (for PATCH operation).\n \"email\": \"jdoe@gmail.com\", // Optional (for PATCH operation).\n \"firstName\": \"John\", // Optional (for PATCH operation).\n \"lastName\": \"Doe\", // Optional (for PATCH operation).\n \"active\": true, // Optional (for PATCH operation).\n \"salutation\": \"Mr.\", // Optional (for PATCH operation).\n \"referralPhoneNumber\":\"8290808122\", // Optional (for PATCH operation).\n \"referralCode\": \"POIQWE123\", // Optional (for PATCH operation).\n \"city\": \"New Delhi\", // Optional (for PATCH operation).\n \"district\":\"Okhla\", // Optional (for PATCH operation).\n \"state\":\"Delhi\", // Optional (for PATCH operation).\n \"address1\":\"1234 S 32 Birla Towers\", // Optional (for PATCH operation).\n \"address2\":\"Jagat Nagar\", // Optional (for PATCH operation).\n \"postalCode\": \"249408\", // Optional (for PATCH operation).\n \"referredByMerchant\":\"123454321\", // Optional (for PATCH operation).\n \"referredByFSM\":\"9908083242\" // Optional (for PATCH operation).\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/partner-apis/drivers/{{driverId}}"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"countryCode\": \"1\", // E.164 code\n \"phoneNumber\": \"5556789999\", // Driver phone number\n \"firstName\": \"John\", // First name\n \"lastName\": \"Smith\", // Last name\n \"email\": \"jsmith@email.com\", // Email address\n \"driverId\": \"dri_partner_B8vR4R4vFsDoX3sg3W7z\", // Partner assigned unique driver identifier\n \"active\": true, // Is driver active?\n \"salutation\": \"Mr.\", \n \"addressDetails\":{\n \"address1\":\"1234 S 32 Birla Towers\", \n \"address2\":\"Jagat Nagar\",\n \"city\": \"New Delhi\",\n \"district\":\"Okhla\", \n \"state\":\"Delhi\",\n \"postalCode\":\"249408\"\n },\n \"referralPhoneNumber\":\"8290808122\", \n \"referralCode\": \"POIQWE123\", \n \"referredByMerchant\":\"123454321\", \n \"referredByFSM\":\"9908083242\"\n}"}],"_postman_id":"fbfd2795-47a9-4a84-8b30-d08fd36e0051"},{"name":"Get Driver Details","id":"4fc5fc7d-4252-4921-81cb-a12184523930","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/partner-apis/drivers/{{driverId}}/details","description":"This request returns driver details, associated vehicles and any active sessions. This is a convinience request that combines the resources: driver, vehicle, and a possible array of sessions.
\nIf successful, returns: HTTP 200 OK.
\n","urlObject":{"path":["v2","partner-apis","drivers","{{driverId}}","details"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"82d1cd02-25c8-4f48-ab97-879e04996813","name":"Get Driver Details Example1","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text","description":"Received from authentication endpoint"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"url":"{{host}}/v2/partner-apis/drivers/dri_dc92d48cc952f38cb87b"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"driver\": { // Same object as that in Get Driver request.\n \"countryCode\": \"1\",\n \"phoneNumber\": \"8134242424\",\n \"email\": \"john.doe@gmail.com\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"driverId\": \"dri_partner_B8vR4R4vFsDoX3sg3W7z\",\n \"active\": true,\n \"salutation\": \"Mr.\", \n \"referralPhoneNumber\":\"8290808122\", \n \"referralCode\": \"POIQWE123\", \n \"addressDetails\":{\n \"address1\":\"1234 S 32 Birla Towers\", \n \"address2\":\"Jagat Nagar\",\n \"city\": \"New Delhi\",\n \"district\":\"Okhla\", \n \"state\":\"Delhi\",\n \"postalCode\":\"249408\"\n },\n \"referredByMerchant\":\"123454321\", \n \"referredByFSM\":\"9908083242\"\n },\n \"pairedVehicles\": [{ // Same object as that in Get Vehicles request.\n \"vin\": \"WBA33AG07PCM25883\",\n \"licensePlate\": \"ABI712G\",\n \"make\": \"BMW\",\n \"model\": \"530e\",\n \"year\": \"2023\",\n \"color\": \"RED\",\n \"fuelTypes\": [\"PETROL\", \"ELECTRIC\"],\n \"connectorType\": \"J1772\",\n \"active\": true,\n \"registrationCertificateDueOn\": \"21-05-2024\",\n \"pucDueOn\": \"15-05-2024\",\n \"insuranceDueOn\": \"17-09-2024\", \n \"vehicleServiceDueOn\": \"21-12-2024\"\n }],\n \"activeSessions\": [{\n \"serviceType\": \"PARKING\", \n \"id\": \"AYABeImAH0a9_i6wb32thzMkTYQAHQABAAdTZXJ2aWNlABBDb2duaXRvVXNlclBvb2xzAAEAB2F3cy1rbXMATGFybjphd3M6a21zOmFwLXNvd...\"\n }, {\n \"serviceType\" : \"CHARGING\", \n \"id\": \"AYABeImAH0a9_i6wb32thzMkTYQAHQABAAdTZXJ2aWNlABBDb2duaXRvVXNlclBvb2xzAAEAB2F3cy1rbXMATGFybjphd3M6a21zOmFwLdsgsgsg...\"\n }]\n}"}],"_postman_id":"4fc5fc7d-4252-4921-81cb-a12184523930"},{"name":"Get List of Linked Vehicles to a Driver (Deprecated)","id":"39514d11-877f-4cc0-9095-a320203985a0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"url":"{{host}}/v2/partner-apis/drivers/{{driverId}}","urlObject":{"path":["v2","partner-apis","drivers","{{driverId}}"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"105d96ad-2687-4fcc-ba2c-92358fd1ded1","name":"Get List of Linked Vehicles to a Driver","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"url":"{{host}}/v2/partner-apis/drivers/{{driverId}}"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"phoneNumber\": \"8134242424\",\n \"countryCode\": \"1\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john.doe@gmail.com\",\n \"driverId\": \"dri_partner_B8vR4R4vFsDoX3sg3W7z\",\n \"active\": true\n}"}],"_postman_id":"39514d11-877f-4cc0-9095-a320203985a0"},{"name":"Link Driver to a Vehicle","id":"fcb11a53-5ba5-48dd-926f-4339c59c23b3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"url":"{{host}}/v2/partner-apis/drivers/{{driverId}}/link?vin={{vin}}&markAsDriver={{markAsDriver}}","description":"This API allows drivers to be paired with one of the vehicles. Once paired, this driver would be sent all notifications for this vehicle.
\nIf successful, returns: HTTP 201 CREATED.
\n","urlObject":{"path":["v2","partner-apis","drivers","{{driverId}}","link"],"host":["{{host}}"],"query":[{"description":{"content":"VIN of the vehicle
\n","type":"text/plain"},"key":"vin","value":"{{vin}}"},{"description":{"content":"Optional. Default value is false. \nUse this param to mark the driver as current driver.
\n","type":"text/plain"},"key":"markAsDriver","value":"{{markAsDriver}}"}],"variable":[]}},"response":[{"id":"c6833099-c15e-4fdd-9c81-50006c62ceab","name":"Link Driver to a Vehicle Example1","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text","description":"Received from authentication endpoint"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"url":{"raw":"{{host}}/v2/partner-apis/drivers/{{driverId}}/link?vin={{vin}}&markAsDriver={{markAsDriver}}","host":["{{host}}"],"path":["v2","partner-apis","drivers","{{driverId}}","link"],"query":[{"key":"vin","value":"{{vin}}"},{"key":"markAsDriver","value":"{{markAsDriver}}"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 02 May 2023 17:42:03 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"0304486f-d2db-4278-8441-e30f5a2a6594"},{"key":"x-amzn-Remapped-Content-Length","value":"0"},{"key":"x-amzn-Remapped-Connection","value":"keep-alive"},{"key":"x-amz-apigw-id","value":"ETi4tEuHIAMFfGw="},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"x-amzn-Remapped-Date","value":"Tue, 02 May 2023 17:42:03 GMT"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"fcb11a53-5ba5-48dd-926f-4339c59c23b3"},{"name":"Unlink Driver from a Vehicle","id":"177e38c8-c1ef-44a6-8e29-1da2a310521d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"url":"{{host}}/v2/partner-apis/drivers/{{driverId}}/link?vin={{vin}}","description":"This API allows drivers to unpair an already paired vehicle. Once unpaired, this driver would no longer be sent any notifications for this vehicle.
\nIf successful, returns: HTTP 200 OK.
\n","urlObject":{"path":["v2","partner-apis","drivers","{{driverId}}","link"],"host":["{{host}}"],"query":[{"key":"vin","value":"{{vin}}"}],"variable":[]}},"response":[],"_postman_id":"177e38c8-c1ef-44a6-8e29-1da2a310521d"},{"name":"Mark Driver as current Driver for a Vehicle","id":"148c4f06-9631-407a-a21f-170b8dda152a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"url":"{{host}}/v2/partner-apis/drivers/{{driverId}}/drive?vin={{vin}}","description":"This request allows to mark the driver as current driver for the Vehicle
\nIf successful, returns: HTTP 201 CREATED.
\n","urlObject":{"path":["v2","partner-apis","drivers","{{driverId}}","drive"],"host":["{{host}}"],"query":[{"key":"vin","value":"{{vin}}"}],"variable":[]}},"response":[{"id":"69903537-5777-4230-8039-0bc80627a430","name":"Mark Driver as current Driver for a Vehicle","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"url":{"raw":"{{host}}/v2/partner-apis/drivers/{{driverId}}/drive?vin={{vin}}","host":["{{host}}"],"path":["v2","partner-apis","drivers","{{driverId}}","drive"],"query":[{"key":"vin","value":"{{vin}}"}]}},"code":201,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"148c4f06-9631-407a-a21f-170b8dda152a"},{"name":"Remove Driver as Current driver for a vehicle","id":"064bf15e-106f-43bd-911d-2c2486aaf02b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"url":"{{host}}/v2/partner-apis/drivers/{{driverId}}/drive?vin={{vin}}","description":"This request allows to unmark the driver as current driver for the Vehicle
\nif successful it will return HTTP Status Code 200
\n","urlObject":{"path":["v2","partner-apis","drivers","{{driverId}}","drive"],"host":["{{host}}"],"query":[{"key":"vin","value":"{{vin}}"}],"variable":[]}},"response":[{"id":"97bb2d8b-fabf-4c75-bdea-3a2bdff0fba0","name":"Remove Driver as Current driver for a vehicle","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"url":{"raw":"{{host}}/v2/partner-apis/drivers/{{driverId}}/drive?vin={{vin}}","host":["{{host}}"],"path":["v2","partner-apis","drivers","{{driverId}}","drive"],"query":[{"key":"vin","value":"{{vin}}"}]}},"code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"064bf15e-106f-43bd-911d-2c2486aaf02b"}],"id":"c88fce54-9f51-4fbf-b33d-ed4c2d02fc85","description":"APIs to manage the driver resource.
\n","_postman_id":"c88fce54-9f51-4fbf-b33d-ed4c2d02fc85"},{"name":"Vehicle","item":[{"name":"Search Vehicles","id":"0ee6dbee-9728-4f28-8775-56a9bb98445b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/partner-apis/vehicles?vin={{vin}}&driverId={{driverId}}","description":"This request returns vehicles that match the criteria provided in the query parameters. Returns an array of vehicles matching any search criteria. If no matches were found, returns an empty array.
\nIf successful, returns: HTTP 200 OK.
\n","urlObject":{"path":["v2","partner-apis","vehicles"],"host":["{{host}}"],"query":[{"description":{"content":"Vehicle VIN to search by [Optional]
\n","type":"text/plain"},"key":"vin","value":"{{vin}}"},{"description":{"content":"Partner assigned unique Driver identifier [Optional]
\n","type":"text/plain"},"key":"driverId","value":"{{driverId}}"}],"variable":[]}},"response":[{"id":"960b6eab-a61c-4bd2-9582-3c38d42006ef","name":"Get Vehicles Example1","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text","description":"Received from authentication endpoint"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"url":{"raw":"{{host}}/v2/partner-apis/vehicles?vin&driverId","host":["{{host}}"],"path":["v2","partner-apis","vehicles"],"query":[{"key":"vin","value":null,"description":"Vehicle VIN to search by [Optional]"},{"key":"driverId","value":null,"description":"Partner assigned unique Driver identifier [Optional]"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"vin\": \"WBA33AG07PCM25883\",\n \"licensePlate\": \"ABI712G\",\n \"make\": \"BMW\",\n \"model\": \"530e\",\n \"year\": \"2023\",\n \"color\": \"RED\",\n \"fuelTypes\": [\"PETROL\", \"ELECTRIC\"],\n \"connectorType\": \"J1772\",\n \"active\": true\n }, {\n \"vin\": \"WP0CB298X4U661674\",\n \"licensePlate\": \"SDM606E\",\n \"make\": \"Porsche\",\n \"model\": \"Boxster\",\n \"year\": \"2004\",\n \"color\": \"YELLOW\",\n \"fuelTypes\": [\"PETROL\"], // No connectorType as it doesn't have an ELECTRIC fuelType.\n \"active\": true\n }, {\n \"vin\": \"WBY43AW04PFP67880\",\n \"licensePlate\": \"Y657567\",\n \"make\": \"BMW\",\n \"model\": \"i4 eDrive35\",\n \"year\": \"2023\",\n \"color\": \"WHITE\",\n \"fuelTypes\": [\"ELECTRIC\"], \n \"connectorType\": \"J1772\",\n \"active\": true\n }\n]"}],"_postman_id":"0ee6dbee-9728-4f28-8775-56a9bb98445b"},{"name":"Get a Vehicle","id":"f78a40a9-f345-43de-853a-ee59df32ee72","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/partner-apis/vehicles/{{vin}}","description":"This request allows you fetch a vehicle based on the vehicle identifier.
\nIf successful, returns HTTP 200 OK.
\nIf vehicle identifier is not found, returns HTTP 404 NOT FOUND.
\n","urlObject":{"path":["v2","partner-apis","vehicles","{{vin}}"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"7b976cc3-bd0a-4ae0-a883-07b5ddd5e66b","name":"Find a Vehicle","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/partner-apis/vehicles/{{vin}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"vin\": \"WBA33AG07PCM25883\",\n \"licensePlate\": \"ABC123\",\n \"make\": \"BMW\",\n \"model\": \"530e\",\n \"year\": \"2023\",\n \"color\": \"RED\",\n \"fuelTypes\": [\"PETROL\", \"ELECTRIC\"],\n \"connectorType\": \"J1772\",\n \"active\": true,\n \"registrationCertificateDueOn\": \"21-05-2024\",\n \"pucDueOn\": \"15-05-2024\",\n \"insuranceDueOn\": \"17-09-2024\", \n \"vehicleServiceDueOn\": \"21-12-2024\"\n}"}],"_postman_id":"f78a40a9-f345-43de-853a-ee59df32ee72"},{"name":"Register Vehicle","id":"719d6e0a-849a-4053-92c3-c6ed56d90214","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"vin\": \"WBA33AG07PCM25883\", // Mandatory\n \"licensePlate\": \"MH 01 AB 1234\", // Can be configured mandatory/optional, as required by program \n \"make\": \"BMW\", // Mandatory\n \"model\": \"530e\", // Mandatory\n \"year\": \"2023\", // Optional \n \"color\": \"RED\", // Can be configured mandatory/optional, as required by program \n \"fuelTypes\": [\"PETROL\", \"ELECTRIC\"], // Mandatory. Possible values: [PETROL, DIESEL, ELECTRIC]\n \"connectorType\": \"J1772\", // Optional for ELECTRIC fuel type. Example values: [J1772, CHADEMO, CCS, TESLA, COMBO]\n \"active\": true, // Mandatory. Always pass true while onboarding.\n \"registrationCertificateDueOn\": \"21-05-2024\", // Can be configured mandatory/optional, as required by program\n \"pucDueOn\": \"15-05-2024\", // Can be configured mandatory/optional, as required by program\n \"insuranceDueOn\": \"17-09-2024\", // Can be configured mandatory/optional, as required by program\n \"vehicleServiceDueOn\": \"21-12-2024\", // Can be configured mandatory/optional, as required by program\n \"demoMode\": 0 // Optional (for PATCH operation)\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/partner-apis/vehicles","description":"This request allows you to register a vehicle.
\nIf the vehicle was not previously added and successfully added, the endpoint returns: HTTP 201 CREATED.
\nIf the vehicle is already registered (i.e., same VIN and license plate), the endpoint returns: HTTP 409 CONFLICT along with the existing vehicle in the response. The existing vehicle's id is also present in the Location header.
\n","urlObject":{"path":["v2","partner-apis","vehicles"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"5305a225-64f9-4117-adb0-7f67af746e0c","name":"Add New Vehicle","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text","description":"Received from authentication endpoint"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"vin\": \"WBA33AG07PCM25883\", // Mandatory\n \"licensePlate\": \"MH 01 AB 1234\", // Can be configured mandatory/optional, as required by program \n \"make\": \"BMW\", // Mandatory\n \"model\": \"530e\", // Mandatory\n \"year\": \"2023\", // Optional \n \"color\": \"RED\", // Can be configured mandatory/optional, as required by program \n \"fuelTypes\": [\"PETROL\"], // Mandatory. Possible values: [PETROL, DIESEL, ELECTRIC]\n \"connectorType\": \"J1772\", // Optional for ELECTRIC fuel type. Example values: [J1772, CHADEMO, CCS, TESLA, COMBO]\n \"active\": true, // Mandatory. Always pass true while onboarding.\n \"registrationCertificateDueOn\": \"21-05-2024\", // Can be configured mandatory/optional, as required by program\n \"pucDueOn\": \"15-05-2024\", // Can be configured mandatory/optional, as required by program\n \"insuranceDueOn\": \"17-09-2024\", // Can be configured mandatory/optional, as required by program\n \"vehicleServiceDueOn\": \"21-12-2024\", // Can be configured mandatory/optional, as required by program\n \"demoMode\": 0 // Optional (for PATCH operation)\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/partner-apis/vehicles"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"vin\": \"WBA33AG07PCM25883\",\n \"licensePlate\": \"MH 01 AB 1234\",\n \"make\": \"BMW\",\n \"model\": \"530e\",\n \"year\": \"2023\",\n \"color\": \"RED\",\n \"fuelTypes\": [\n \"PETROL\",\n \"ELECTRIC\"\n ],\n \"connectorType\": \"J1772\",\n \"active\": true,\n \"registrationCertificateDueOn\": \"21-05-2024\",\n \"pucDueOn\": \"15-05-2024\",\n \"insuranceDueOn\": \"17-09-2024\", \n \"vehicleServiceDueOn\": \"21-12-2024\"\n}"},{"id":"ee455077-7ce7-45bb-9823-c7cf00e2fba4","name":"Vehicle already exists error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text","description":"Received from authentication endpoint"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"vin\": \"WBA33AG07PCM25883\", // Mandatory\n \"licensePlate\": \"MH 01 AB 1234\", // Can be configured mandatory/optional, as required by program \n \"make\": \"BMW\", // Mandatory\n \"model\": \"530e\", // Mandatory\n \"year\": \"2023\", // Optional \n \"color\": \"RED\", // Can be configured mandatory/optional, as required by program \n \"fuelTypes\": [\"PETROL\", \"ELECTRIC\"], // Mandatory. Possible values: [PETROL, DIESEL, ELECTRIC]\n \"connectorType\": \"J1772\", // Optional for ELECTRIC fuel type. Example values: [J1772, CHADEMO, CCS, TESLA, COMBO]\n \"programCode\": \"program.code\", // Mandatory. Provided by Sheeva.AI\n \"active\": true, // Mandatory. Always pass true while onboarding.\n \"registrationCertificateDueOn\": \"21-05-2024\", // Can be configured mandatory/optional, as required by program\n \"pucDueOn\": \"15-05-2024\", // Can be configured mandatory/optional, as required by program\n \"insuranceDueOn\": \"17-09-2024\", // Can be configured mandatory/optional, as required by program\n \"vehicleServiceDueOn\": \"21-12-2024\", // Can be configured mandatory/optional, as required by program\n \"demoMode\": 0 // Optional (for PATCH operation)\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/partner-apis/vehicles"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Location","value":"002d003e4e48501120393352","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"vin\": \"WBA33AG07PCM25883\", // vin and licensePlate must already exist for HTTP 409 error\n \"licensePlate\": \"MH 01 AB 1234\", // vin and licensePlate must already exist for HTTP 409 error\n \"make\": \"BMW\",\n \"model\": \"530e\",\n \"year\": \"2023\",\n \"color\": \"RED\",\n \"fuelTypes\": [\n \"PETROL\",\n \"ELECTRIC\"\n ],\n \"connectorType\": \"J1772\",\n \"programCode\": \"program.code\",\n \"active\": true\n}"}],"_postman_id":"719d6e0a-849a-4053-92c3-c6ed56d90214"},{"name":"Update Vehicle","id":"baf4ee98-1ec7-499f-bb7e-c59c56243107","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"licensePlate\": \"MH 01 AB 1234\", // Optional (for PATCH operation).\n \"make\": \"BMW\", // Optional (for PATCH operation).\n \"model\": \"530e\", // Optional (for PATCH operation).\n \"year\": \"2023\", // Optional (for PATCH operation).\n \"color\": \"RED\", // Optional (for PATCH operation).\n \"fuelTypes\": [\"PETROL\", \"ELECTRIC\"], // Optional (for PATCH operation).\n \"connectorType\": \"J1772\", // Optional (for PATCH operation)\n \"active\": true, // Optional (for PATCH operation).\n \"registrationCertificateDueOn\": \"21-05-2024\", // Optional (for PATCH operation).\n \"pucDueOn\": \"15-05-2024\", // Optional (for PATCH operation).\n \"insuranceDueOn\": \"17-09-2024\", // Optional (for PATCH operation).\n \"vehicleServiceDueOn\": \"21-12-2024\", // Optional (for PATCH operation).\n \"demoMode\": 0 // Optional (for PATCH operation)\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/partner-apis/vehicles/{{vin}}","description":"This request allows you to update details of a vehicle.
\nIf successful, returns HTTP 200 OK.
\n","urlObject":{"path":["v2","partner-apis","vehicles","{{vin}}"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"8a9d8d41-6c49-4bfd-8d14-85fb09ab23e0","name":"Update Vehicle","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"vin\": \"{{vin}}\", // Mandatory (for PATCH operation).\n \"licensePlate\": \"MH 01 AB 1234\", // Optional (for PATCH operation).\n \"make\": \"BMW\", // Optional (for PATCH operation).\n \"model\": \"530e\", // Optional (for PATCH operation).\n \"year\": \"2023\", // Optional (for PATCH operation).\n \"color\": \"RED\", // Optional (for PATCH operation).\n \"fuelTypes\": [\"PETROL\", \"ELECTRIC\"], // Optional (for PATCH operation).\n \"connectorType\": \"J1772\", // Optional (for PATCH operation).\n \"active\": true, // Optional (for PATCH operation).\n \"registrationCertificateDueOn\": \"21-05-2024\", // Optional (for PATCH operation).\n \"pucDueOn\": \"15-05-2024\", // Optional (for PATCH operation).\n \"insuranceDueOn\": \"17-09-2024\", // Optional (for PATCH operation).\n \"vehicleServiceDueOn\": \"21-12-2024\", // Optional (for PATCH operation).\n \"demoMode\": 0 // Optional (for PATCH operation)\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/partner-apis/vehicles/{{vin}}"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"vin\": \"WBA33AG07PCM25883\",\n \"licensePlate\": \"MH 01 AB 1234\",\n \"make\": \"BMW\",\n \"model\": \"530e\",\n \"year\": \"2023\",\n \"color\": \"RED\",\n \"fuelTypes\": [\n \"PETROL\",\n \"ELECTRIC\"\n ],\n \"connectorType\": \"J1772\",\n \"active\": true,\n \"registrationCertificateDueOn\": \"21-05-2024\",\n \"pucDueOn\": \"15-05-2024\",\n \"insuranceDueOn\": \"17-09-2024\",\n \"vehicleServiceDueOn\": \"21-12-2024\"\n}"}],"_postman_id":"baf4ee98-1ec7-499f-bb7e-c59c56243107"},{"name":"Get Drivers by VIN","id":"3eaa0736-89a3-4c84-b3ee-53dcfdff43fb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"url":"{{host}}/v2/partner-apis/vehicles/{{vin}}/drivers","urlObject":{"path":["v2","partner-apis","vehicles","{{vin}}","drivers"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"e12ee66b-b40b-47d3-99a7-4f4c20b7cba3","name":"Get Drivers by VIN","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"url":"{{host}}/v2/partner-apis/vehicles/{vin}/drivers"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"licensePlate\": \"MH 01 AA 0001\",\n \"make\": \"JEEP\",\n \"model\": \"Compass\",\n \"year\": \"2023\",\n \"color\": \"RED\",\n \"fuelTypes\": [\n \"PETROL\"\n ],\n \"connectorType\": \"OBD2\",\n \"active\": true,\n \"driving\": false,\n \"drivers\": [\n {\n \"phoneNumber\": \"9898989898\",\n \"countryCode\": \"91\",\n \"firstName\": \"John\",\n \"lastName\": \"Den\",\n \"email\": \"jden@gmail.com\",\n \"driverId\": \"dri_partner_ndga2jbavWtdJB6gT9Jl\", // partner assigned driver id\n \"active\": true\n }\n ],\n \"vin\": \"MCAAJPBH3JFA12345\"\n}"}],"_postman_id":"3eaa0736-89a3-4c84-b3ee-53dcfdff43fb"}],"id":"84ae758d-0346-4abf-90b2-95b4e062210d","description":"APIs to manage the vehicle resource.
\n","_postman_id":"84ae758d-0346-4abf-90b2-95b4e062210d"},{"name":"Driver Alerts","item":[{"name":"Update Alert Preference","id":"a6eef74f-8997-4524-8f80-0a3ea5c4d4e0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"lowFuelAlertThreshold\": 25, //In percentage - below which driver want to fo fuel, Optional\n \"lowChargeAlertThreshold\": 30, //In percentage - below which driver wants to go charge, Optional\n \"chargeCompleteThreshold\" : 80 //In percentage - when the driver wants to get alert to potentially stop charging, Optional\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/partner-apis/alerts?vin={{vin}}&driverId={{driverId}}","urlObject":{"path":["v2","partner-apis","alerts"],"host":["{{host}}"],"query":[{"description":{"content":"Vehicle Identifier [Mandatory]
\n","type":"text/plain"},"key":"vin","value":"{{vin}}"},{"description":{"content":"Partner assigned unique Driver identifier [Mandatory]
\n","type":"text/plain"},"key":"driverId","value":"{{driverId}}"}],"variable":[]}},"response":[],"_postman_id":"a6eef74f-8997-4524-8f80-0a3ea5c4d4e0"},{"name":"Get Alert Preference","id":"311d3be7-4e39-463f-b5de-377a9efc195d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"lowFuelAlertThreshold\": 25, //In percentage - below which driver want to fo fuel, Optional\n \"lowChargeAlertThreshold\": 30, //In percentage - below which driver wants to go charge, Optional\n \"chargeCompleteThreshold\" : 80 //In percentage - when the driver wants to get alert to potentially stop charging, Optional\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/partner-apis/alerts/?vin={{vin}}&driverId={{driverId}}","urlObject":{"path":["v2","partner-apis","alerts",""],"host":["{{host}}"],"query":[{"description":{"content":"Vehicle Identifier [Mandatory]
\n","type":"text/plain"},"key":"vin","value":"{{vin}}"},{"description":{"content":"Partner assigned unique Driver identifier [Mandatory]
\n","type":"text/plain"},"key":"driverId","value":"{{driverId}}"}],"variable":[]}},"response":[{"id":"2caddbc4-43f1-4a61-b253-75032dc71f4a","name":"Get Alert Preference","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text","description":"Received from authentication endpoint"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"url":{"raw":"{{host}}/v2/partner-apis/alerts/?vin=2CTALDEW5A6370888&driverId=drv_afawrqr3","host":["{{host}}"],"path":["v2","partner-apis","alerts",""],"query":[{"key":"vin","value":"2CTALDEW5A6370888","description":"Vehicle Identifier [Mandatory]"},{"key":"driverId","value":"drv_afawrqr3","description":"Partner assigned unique Driver identifier [Mandatory]"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"lowFuelAlertThreshold\": 25, //In percentage - below which driver want to fo fuel, Optional\n \"lowChargeAlertThreshold\": 30, //In percentage - below which driver wants to go charge, Optional\n \"chargeCompleteThreshold\" : 80 //In percentage - when the driver wants to get alert to potentially stop charging, Optional\n}"}],"_postman_id":"311d3be7-4e39-463f-b5de-377a9efc195d"}],"id":"2beec505-3ce5-4782-bc43-78e8ddc35161","_postman_id":"2beec505-3ce5-4782-bc43-78e8ddc35161","description":""}],"id":"324314c0-5332-48eb-b974-512e309bda80","description":"APIs to manage drivers and vehicles.
\n","_postman_id":"324314c0-5332-48eb-b974-512e309bda80"},{"name":"Session","item":[{"name":"Get Currently Active Sessions","id":"9f7e7536-d40b-41a4-b039-7a36f3d18009","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/partner-apis/sessions/current-session?serviceType=FUEL&vin={{vehicleId}}","description":"This request returns current fuel session state and details if there is any session with the specified type actively running in the system.
\nIf successful, returns: HTTP 200 OK.
\nService Type. E.g.: FUEL, PARKING, CHARGING, TOLL, etc.
\n","type":"text/plain"},"key":"serviceType","value":"FUEL"},{"description":{"content":"Mandatory
\n","type":"text/plain"},"key":"vin","value":"{{vehicleId}}"}],"variable":[]}},"response":[{"id":"5b2234d7-7bc5-4152-b3d5-46f37a0fe938","name":"Get Currently Active Fuel Sessions","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text","description":"Received from authentication endpoint"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"url":{"raw":"{{host}}/v2/partner-apis/sessions/current-session?serviceType=FUEL&vin={{vin}}","host":["{{host}}"],"path":["v2","partner-apis","sessions","current-session"],"query":[{"key":"serviceType","value":"FUEL","description":"Service Type. E.g.: FUEL, PARKING, CHARGING, TOLL, etc."},{"key":"vin","value":"{{vin}}","description":"Unique vehicle identifier : Mandatory"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"vehicleLocation\": {\n \"latitude\": 19.16323715308841,\n \"longitude\": 72.85860447032306,\n \"timestamp\": 1668531651000\n },\n \"activeSessions\": [\n {\n \"id\": \"sess_141414141\",\n \"currentState\": \"LOW_FUEL_DETECTED\",// Refer API Spec for all the valid session statuses\n \"paymentStatus\": \"PAYMENT_INITIATED\", // Refer API Spec for all the valid payment statuses\n \"serviceType\": \"FUEL\"\n },\n {\n \"id\": \"sess_141414142\",\n \"currentState\": \"SERVICE_IN_PROGRESS\", // Refer API Spec for all the valid session statuses\n \"paymentStatus\": \"PAYMENT_INITIATED\", // Refer API Spec for all the valid payment statuses\n \"serviceType\": \"CHARGING\"\n }\n ]\n}"},{"id":"380a5790-659d-452f-bf66-82008d4f23fc","name":"Get Currently Active Parking Sessions","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text","description":"Received from authentication endpoint"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"url":{"raw":"{{host}}/v2/partner-apis/sessions/current-session?serviceType=PARKING&vin={{vin}}","host":["{{host}}"],"path":["v2","partner-apis","sessions","current-session"],"query":[{"key":"serviceType","value":"PARKING","description":"Service Type. E.g.: FUEL, PARKING, CHARGING, TOLL, etc."},{"key":"vin","value":"{{vin}}","description":"Unique vehicle identifier : Mandatory"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"vehicleLocation\": {\n \"latitude\": 19.16323715308841,\n \"longitude\": 72.85860447032306,\n \"timestamp\": 1668531651000\n },\n \"activeSessions\": [\n {\n \"id\": \"parking_payments_14141asdqwe\",\n \"currentState\": \"CONFIRMED\", //INITIATED, CONFIRMED, FAILED, COMPLETED, CANCELED\n \"paymentStatus\": \"PAYMENT_COMPLETED\", // Refer API Spec for all the valid payment statuses\n \"serviceType\": \"PARKING\"\n }\n ]\n}"}],"_postman_id":"9f7e7536-d40b-41a4-b039-7a36f3d18009"},{"name":"Get Details of a Session","id":"206b541d-3180-4c86-9a22-a2d36bf0fafb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"url":"{{host}}/v2/partner-apis/sessions/{{sessionId}}","urlObject":{"path":["v2","partner-apis","sessions","{{sessionId}}"],"host":["{{host}}"],"query":[{"disabled":true,"key":"","value":null}],"variable":[]}},"response":[{"id":"ad542218-f42b-4944-82a2-2a1a681b921e","name":"Get Details of a Charging Session","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text","description":"Received from authentication endpoint"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"url":{"raw":"{{host}}/v2/partner-apis/sessions/{{sessionId}}","host":["{{host}}"],"path":["v2","partner-apis","sessions","{{sessionId}}"],"query":[{"key":"id","value":null,"disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"vehicleLocation\": {\n \"latitude\": 19.16323715308841,\n \"longitude\": 72.85860447032306,\n \"timestamp\": 1668531651000\n },\n \"session\" : {\n \"id\":\"sess_141414141\",\n \"currentState\": \"SERVICE_IN_PROGRESS\", // Refer API Spec for all the valid session statuses\n \"paymentStatus\": \"PAYMENT_INITIATED\", // Refer API Spec for all the valid payment statuses\n \"serviceType\" :\"CHARGING\"\n },\n \"serviceHub\" : {\n \"id\": \"fst_dbe5bcc470b1cb3e5375\",\n \"company\": \"chargePoint\",\n \"location\": \"19.160018,72.858512\",\n \"displayName\": \"Charge Point Of America\",\n \"addressDetails\": {\n \"streetAddress\": \"Aarey Colony, Goregaon\",\n \"city\": \"Mumbai\",\n \"state\": \"Maharashtra\",\n \"zipCode\": \"400065\",\n \"country\": \"India\"\n },\n \"connector\" :{\n \"id\": \"76685b93-b1c9-4612-b713-0d43146d65a3\",\n \"status\": \"active\",\n \"name\": \"ASHANTI Pike 7 Plaza- A1\",\n \"baseRate\": 0.3,\n \"type\": \"Chademo\",\n \"network\": \"EVgo\",\n \"speed\": 100,\n \"availability\": \"inUse\"\n },\n \"paymentInstrument\" : {\n \"type\": \"creditCard\",\n \"id\": \"card_1314141\",\n \"lastFour\": \"1212\",\n \"expiry\": \"0327\"\n },\n \"promotions\":[\n {\n \"name\": \"Happy Hour\",\n \"category\" : \"Fueling\",\n \"discount\": \"10 cents off per gallon\",\n \"mediaURL\": \"https://example.com/abc.jpg\"\n }\n ],\n \"rating\":{\n \"totalRatings\":245,\n \"average\": 4.5\n }\n }\n}\n"},{"id":"335220e7-0f76-4f2b-8375-c68266f6926a","name":"Get Details of a Charging Session 2","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text","description":"Received from authentication endpoint"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"url":"{{host}}/v2/partner-apis/sessions/{{sessionId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"vehicleLocation\": {\n \"latitude\": 19.16323715308841,\n \"longitude\": 72.85860447032306,\n \"timestamp\": 1668531651000\n },\n \"session\" : {\n \"id\":\"sess_141414141\",\n \"currentState\": \"AT_SERVICE_HUB\", // Refer API Spec for all the valid session statuses\n \"paymentStatus\": \"PAYMENT_INITIATED\", // // Refer API Spec for all the valid payment statuses\n \"serviceType\" :\"CHARGING\"\n },\n \"serviceHub\" : {\n \"id\": \"fst_dbe5bcc470b1cb3e5375\",\n \"company\": \"chargePoint\",\n \"location\": \"19.160018,72.858512\",\n \"displayName\": \"Charge Point Of America\",\n \"addressDetails\": {\n \"streetAddress\": \"Aarey Colony, Goregaon\",\n \"city\": \"Mumbai\",\n \"state\": \"Maharashtra\",\n \"zipCode\": \"400065\",\n \"country\": \"India\"\n },\n \"connectors\":[\n {\n \"id\": \"76685b93-b1c9-4612-b713-0d43146d65a3\",\n \"status\": \"active\",\n \"name\": \"ASHANTI Pike 7 Plaza- A1\",\n \"baseRate\": 0.3,\n \"type\": \"Chademo\",\n \"network\": \"EVgo\",\n \"speed\": 100,\n \"availability\": \"inUse\"\n },\n {\n \"id\": \"76685b93-b1c9-4612-b713-0d43146d65a4\",\n \"status\": \"active\",\n \"name\": \"ASHANTI Pike 7 Plaza- A2\",\n \"baseRate\": 0.3,\n \"type\": \"Chademo\",\n \"network\": \"EVgo\",\n \"speed\": 100,\n \"availability\": \"available\"\n }\n ],\n \"paymentInstrument\" : {\n \"type\": \"creditCard\",\n \"id\": \"card_1314141\",\n \"lastFour\": \"1212\",\n \"expiry\": \"0327\"\n },\n \"promotions\":[\n {\n \"name\": \"Happy Hour\",\n \"category\" : \"Fueling\",\n \"discount\": \"10 cents off per gallon\",\n \"mediaURL\": \"https://example.com/abc.jpg\"\n }\n ],\n \"rating\":{\n \"totalRatings\":245,\n \"average\": 4.5\n }\n }\n}\n"},{"id":"55387935-57d8-4f80-a89d-fe8dc01dd2d5","name":"Get Details of a Fueling Session","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text","description":"Received from authentication endpoint"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"url":"{{host}}/v2/partner-apis/sessions/{{sessionId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"vehicleLocation\": {\n \"latitude\": 38.8056207,\n \"longitude\": -77.1693468\n },\n \"session\": {\n \"id\": \"fuel_ubhTPR4UXCAmgx7LDPTl\",\n \"currentState\": \"AT_SERVICE_HUB\",// Refer API Spec for all the valid session statuses\n \"paymentStatus\": \"PAYMENT_INITIATED\", // Refer API Spec for all the valid payment statuses\n \"serviceType\": \"FUEL\"\n },\n \"serviceHub\": {\n \"addressDetails\": {\n \"streetAddress\": \"8234 Shady Grove Rd\",\n \"city\": \"Richmond\",\n \"state\": \"Virginia\",\n \"zipCode\": \"400065\",\n \"country\": \"US\"\n },\n \"address\":\"Blythe Road, Chamberlayne\", // This property is deprecated and will be removed soon\n \"city\":\"Greater Mumbai\", // This property is deprecated and will be removed soon\n \"stateCode\":\"Maharashtra\", // This property is deprecated and will be removed soon\n \"displayName\": \"EDSALL PARK EXXON\",\n \"company\": \"exxonmobil\",\n \"currency\": \"USD\",\n \"location\": \"38.80574,-77.169392\",\n \"id\": \"fst_046b4464ee31be36b9ff\",\n \"active\": true,\n \"paymentInstrument\": {\n \"type\": \"CREDIT_CARD\"\n },\n \"rating\": {\n \"totalRatings\": 1,\n \"average\": 5.0\n },\n \"amenities\": [\n \"Convenience Store\",\n \"Free Air\",\n \"Washrooms\"\n ],\n \"operatingHours\": [\n \"Open 24/7\"\n ],\n \"pumps\": [\n {\n \"number\": \"1\",\n \"fuelTypes\": [\"Petrol XP, Gas Regular, Gas Premium\"], // Product Names coming from Service Providers\n \"availability\": \"available\"\n },\n {\n \"number\": \"2\",\n \"fuelTypes\": [\"Petrol XP95\"], // Product Names coming from Service Providers\n \"availability\": \"available\"\n },\n {\n \"number\": \"3\",\n \"fuelTypes\": [\"Petrol XP\", \"Diesel\"],\n \"availability\": \"available\"\n }\n ],\n \"prices\": [\n {\n \"fuelType\": \"Gas Regular\", // Product Names coming from Service Providers\n \"price\": 97.0,\n \"unit\": \"LITRES\"\n },\n {\n \"fuelType\": \"Petrol XP\", // Product Names coming from Service Providers\n \"price\": 98.3,\n \"unit\": \"LITRES\"\n },\n {\n \"fuelType\": \"Gas Premium\",\n \"price\": 78.0,\n \"unit\": \"LITRES\"\n },\n {\n \"fuelType\": \"Petrol XP95\",\n \"price\": 100.3,\n \"unit\": \"LITRES\"\n }\n ],\n \"promotions\": [\n {\n \"name\": \"Reward Days\",\n \"category\": \"FUEL\",\n \"discount\": \"Get 10 Rs off per litre\",\n \"mediaURL\": \"https://example.com/abc.jpg\"\n }\n ]\n }\n}"},{"id":"9a6bd345-25df-44e0-9fc1-64a703a71261","name":"Get Details of a Parking Session","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"url":{"raw":"{{host}}/v2/partner-apis/sessions/{{sessionId}}","host":["{{host}}"],"path":["v2","partner-apis","sessions","{{sessionId}}"],"query":[{"key":"","value":null,"type":"text","disabled":true}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"vehicleLocation\": {\n \"latitude\": 33.02031165,\n \"longitude\": -96.83407293,\n \"timestamp\": 1719587666391\n },\n \"session\": {\n \"id\": \"parking_UbnAGCt2fQItXcZHsrE8\",\n \"currentState\": \"SERVICE_COMPLETE\", //Service State\n \"serviceType\": \"PARKING\",\n \"startTime\": \"2024-06-19 12:04:00\", // Parking Start Timestamp in yyyy-MM-dd HH:mm:ss\n \"endTime\": \"2024-06-19 13:04:00\", // Parking End Timestamp in yyyy-MM-dd HH:mm:ss\n \"paymentStatus\": \"COMPLETED\", // Payment status\n \"paymentInstrument\": { // Payment Instrument used to pay for the parking\n \"type\": \"CREDIT_CARD\",\n \"id\": \"pay_xzsN38mYF7zoMHqoO8iv\",\n \"amount\": 24.0\n }\n },\n \"serviceHub\": { // Details of the Parking Lot\n \"paymentInstrument\": { // Deprecated - This information is available in the session object above\n \"type\": \"CREDIT_CARD\",\n \"id\": \"pay_xzsN38mYF7zoMHqoO8iv\",\n \"amount\": 24.0\n },\n \"displayName\": \"Marina Lot 9\", // Name of the Parking Lot\n \"currency\": \"USD\",\n \"location\": \"33.982403360821465,-118.4560913004027\", // Location coordinates of the Parking Lot\n \"addressDetails\": { // Address details of the Parking Lot\n \"city\": \"N/A\",\n \"state\": \"N/A\",\n \"zipCode\": \"N/A\",\n \"country\": \"N/A\",\n \"streetAddress\": \"N/A\"\n },\n \"amenities\": [ // Amenities available at the parking lot, if available\n \"Convenience Store\",\n \"Free Air\",\n \"Washrooms\"\n ],\n \"promotions\": [ //Promotions, if available\n {\n \"name\": \"Reward Days\",\n \"category\": \"PARKING\",\n \"discount\": \"N/A\",\n \"mediaURL\": \"https://example.com/abc.jpg\"\n }\n ],\n \"polygon\": \"33.982144 -118.455279;33.982945 -118.456666;33.982662 -118.456904;33.981964 -118.455694;33.982008 -118.455657;33.981974 -118.455600;33.981971 -118.455538;33.981993 -118.455475;33.982082 -118.455331;33.982144 -118.455279\",\n \"timezone\": \"America/Los_Angeles\",\n \"openingHours\": [ // Operating hours of the the parking lot\n {\n \"day\": \"1\", // Monday\n \"hours\": [\n \"5:00 - 22:00\"\n ]\n },\n {\n \"day\": \"2\",\n \"hours\": [\n \"5:00 - 22:00\"\n ]\n },\n {\n \"day\": \"3\",\n \"hours\": [\n \"5:00 - 22:00\"\n ]\n },\n {\n \"day\": \"4\",\n \"hours\": [\n \"5:00 - 22:00\"\n ]\n },\n {\n \"day\": \"5\",\n \"hours\": [\n \"5:00 - 22:00\"\n ]\n },\n {\n \"day\": \"6\",\n \"hours\": [\n \"6:00 - 22:00\"\n ]\n },\n {\n \"day\": \"7\", // Sunday\n \"hours\": [\n \"8:00 - 22:00\"\n ]\n }\n ],\n \"id\": \"1100053\" // Service Hub Id\n }\n}"}],"_postman_id":"206b541d-3180-4c86-9a22-a2d36bf0fafb"},{"name":"Collect Rating for Completed Session","id":"12cc16fb-3c32-4d60-a713-50aa2b49e3a8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"comments\": \"Feedback of the customer about the service hub\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/partner-apis/sessions/{sessionId}/rating?rating=4","description":"This API takes in the star rating for a given session and stores it on session and also against service hub (for example fuel station).
\nAPI will return HTTP Status Code 201
\n","urlObject":{"path":["v2","partner-apis","sessions","{sessionId}","rating"],"host":["{{host}}"],"query":[{"key":"rating","value":"4"}],"variable":[]}},"response":[{"id":"f1cb902b-67fd-4270-95b0-0a6878ae78c9","name":"Collect Rating for Completed Session","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"comments\": \"Feedback of the customer about the service hub\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/v2/partner-apis/sessions/{sessionId}/rating?rating=4","host":["{{host}}"],"path":["v2","partner-apis","sessions","{sessionId}","rating"],"query":[{"key":"rating","value":"4"}]}},"status":"Created","code":201,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"12cc16fb-3c32-4d60-a713-50aa2b49e3a8"},{"name":"Confirm Service Point","id":"26dbbcce-da6e-4e29-8778-08a63349e0eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"servicePointId\" : \"1\",\n \"parking\": { // Required in case of sessionType = \"PARKING\" else it must not be supplied in request\n \"duration\" : 30 // in minutes\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/partner-apis/sessions/{{sessionId}}/confirm-service-point?demoMode=0","description":"API to confirm the service point associated with service.
\nSending demoMode=1 would run a transaction with fake payment and will not activate the pump, charger or the parking lot. This helps with simulated testing in the sandbox / development.
\n","urlObject":{"path":["v2","partner-apis","sessions","{{sessionId}}","confirm-service-point"],"host":["{{host}}"],"query":[{"key":"demoMode","value":"0"}],"variable":[]}},"response":[{"id":"2f6835e0-2478-4863-9d30-a7dd1f175b17","name":"Confirm Service Point - Fuel Pump Number","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"","type":"text"},{"key":"x-sheeva-program-code","value":"sheeva.obu","type":"text"}],"body":{"mode":"raw","raw":"{\n \"servicePointId\" : \"1\" //Pump number \n\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/v2/partner-apis/sessions/{{sessionId}}/confirm-service-point?demoMode=0","host":["{{host}}"],"path":["v2","partner-apis","sessions","{{sessionId}}","confirm-service-point"],"query":[{"key":"demoMode","value":"0","type":"text"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"8c3b9f9c-f807-4167-bf9f-fb22a8f3c728","name":"Confirm Service Point - Charing Bay Connector Id","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"","type":"text"},{"key":"x-sheeva-program-code","value":"sheeva.obu","type":"text"}],"body":{"mode":"raw","raw":"{\n \"servicePointId\" : \"0d6caa00-6280-48ee-b8c8-3e724c190999\" //chargingConnectorId\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/v2/partner-apis/sessions/{{sessionId}}/confirm-service-point?demoMode=0","host":["{{host}}"],"path":["v2","partner-apis","sessions","{{sessionId}}","confirm-service-point"],"query":[{"key":"demoMode","value":"0","type":"text"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"006a0916-d80e-4b26-a8c0-10c17bcc64b1","name":"Confirm Service Point - Parking","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"","type":"text"},{"key":"x-sheeva-program-code","value":"sheeva.obu","type":"text"}],"body":{"mode":"raw","raw":"{\n \"servicePointId\" : \"10012\", // parkingLot Id\n \"parking\" : {\n \"duration\" : 30 // in minutes\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/v2/partner-apis/sessions/{{sessionId}}/confirm-service-point?demoMode=0&extend=1","host":["{{host}}"],"path":["v2","partner-apis","sessions","{{sessionId}}","confirm-service-point"],"query":[{"key":"demoMode","value":"0"},{"key":"extend","value":"1","type":"text"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"26dbbcce-da6e-4e29-8778-08a63349e0eb"},{"name":"Mark Service Complete","id":"b8ba5991-acd6-4242-9b23-74036a762d04","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"serviceType\" : \"PARKING\" // Only supports serviceType \"PARKING\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/partner-apis/sessions/{{sessionId}}/mark-service-complete","description":"NOTE: This api is applicable for serviceType=\"PARKING\"
\n","urlObject":{"path":["v2","partner-apis","sessions","{{sessionId}}","mark-service-complete"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"1d52fc5e-24b7-4d49-9a44-9e29cdbb30c9","name":"Confirm Service Point - Fuel Pump Number","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"serviceType\" : \"PARKING\" // serviceType - For now this api is only available for PARKING\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/partner-apis/sessions/{{sessionId}}/mark-service-complete"},"code":201,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"success"}],"_postman_id":"b8ba5991-acd6-4242-9b23-74036a762d04"},{"name":"Cancel the FUEL session by Vin( DEV environment only )","id":"6d6d4b32-3339-41ab-bce2-2f6a04b09522","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/partner-apis/sessions/cancel?vin={{vin}}&serviceType=FUEL","description":"NOTE: This api is applicable for DEV environment and FUEL sessions only.
\nAPI is to help developer to cancel the session during integration for the given vin and serviceType(FUEL).
\n","urlObject":{"path":["v2","partner-apis","sessions","cancel"],"host":["{{host}}"],"query":[{"description":{"content":"Vehicle Id
\n","type":"text/plain"},"key":"vin","value":"{{vin}}"},{"description":{"content":"Service type (only FUEL is supported for now)
\n","type":"text/plain"},"key":"serviceType","value":"FUEL"}],"variable":[]}},"response":[{"id":"ed285a2e-4b2c-42a6-baed-6460565152ae","name":"Cancel the FUEL session by Vin( DEV environment only )","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/v2/partner-apis/sessions/cancel?vin={{vin}}&serviceType=FUEL","host":["{{host}}"],"path":["v2","partner-apis","sessions","cancel"],"query":[{"key":"vin","value":"{{vin}}","description":"Vehicle Id"},{"key":"serviceType","value":"FUEL","description":"Service type (only FUEL is supported for now)"}]}},"code":201,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"6d6d4b32-3339-41ab-bce2-2f6a04b09522"},{"name":"Cancel the FUEL session by sessionId ( DEV environment only )","id":"252fc5d6-17a3-4739-93fb-1858d7cac613","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/partner-apis/sessions/{{sessionId}}/cancel","description":"NOTE: This api is applicable for DEV environment and FUEL sessions only.
\nAPI is to help developer to cancel the session during integration for the given sessionId. Use \"Get Currently Active Sessions\" API to retrieve action sessionId.
\n","urlObject":{"path":["v2","partner-apis","sessions","{{sessionId}}","cancel"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"a6b4d22a-85b9-4731-91d9-01ff054b7076","name":"Cancel the FUEL session ( DEV environment only )","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/partner-apis/sessions/{{sessionId}}/cancel"},"code":201,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"252fc5d6-17a3-4739-93fb-1858d7cac613"}],"id":"de729dbd-0299-4bf9-a9ab-a472d519e972","description":"The session endpoints are used to get the current session state and manage the session state. All APIs in this endpoint require Authorization Header with Access Token received from the authentication endpoint.
\n","_postman_id":"de729dbd-0299-4bf9-a9ab-a472d519e972"},{"name":"Service Hubs (Points Of Interest)","item":[{"name":"Get Service Hubs","id":"77a56931-2f03-49df-a274-d9eb35f2339c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"url":"{{host}}/v2/partner-apis/serviceHubs?latitude=38.9262643&longitude=-77.2428208&radius=2&radiusUnits=MILES&serviceType=FUEL&offset=&limit=5","description":"This request returns POIs based on geolocation and service type.
\nIf successful, returns: HTTP 201 CREATED.
\n","urlObject":{"path":["v2","partner-apis","serviceHubs"],"host":["{{host}}"],"query":[{"description":{"content":"Optional if VIN not provided. Vehicle Latitude.
\n","type":"text/plain"},"key":"latitude","value":"38.9262643"},{"description":{"content":"Optional if VIN not provided. Vehicle Longitude.
\n","type":"text/plain"},"key":"longitude","value":"-77.2428208"},{"disabled":true,"description":{"content":"Optional if Latitude, Longitude not provided. Vehicle's VIN.
\n","type":"text/plain"},"key":"vin","value":""},{"description":{"content":"Optional. Radius to search within. Defaults to 2.0.
\n","type":"text/plain"},"key":"radius","value":"2"},{"description":{"content":"Mandatory. MILES or KILOMETERS.
\n","type":"text/plain"},"key":"radiusUnits","value":"MILES"},{"description":{"content":"Optional. Allows values: FUEL, CHARGING, PARKING, etc. Can repeat to search for more than one connector type.
\n","type":"text/plain"},"key":"serviceType","value":"FUEL"},{"disabled":true,"description":{"content":"Optional. Allows values: J1772, CCS, CHADEMO, TESLA, MENNEKS, etc. Can repeat to search for more than one connector type.
\n","type":"text/plain"},"key":"connectorType","value":""},{"description":{"content":"Optional. Pagination. Start after the 'nth' result. Default: 0
\n","type":"text/plain"},"key":"offset","value":""},{"description":{"content":"Optional. Pagination. Number of results. Default : 5, Max: 10.
\n","type":"text/plain"},"key":"limit","value":"5"}],"variable":[]}},"response":[{"id":"b9a89b10-6f13-4c8a-84f1-b5adf47448f2","name":"Get POIs by Fuel Service type","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","description":"Received from authentication endpoint","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"url":{"raw":"{{host}}/v2/partner-apis/serviceHubs?latitude=38.9262643&longitude=-77.2428208&limit=5&radius=5&serviceType=FUEL&radiusUnits=KILOMETERS","host":["{{host}}"],"path":["v2","partner-apis","serviceHubs"],"query":[{"key":"latitude","value":"38.9262643"},{"key":"longitude","value":"-77.2428208"},{"key":"limit","value":"5"},{"key":"radius","value":"5"},{"key":"serviceType","value":"FUEL"},{"key":"radiusUnits","value":"KILOMETERS"},{"key":"lat","value":"40.885481","disabled":true},{"key":"long","value":"-74.007430","disabled":true},{"key":"distanceUnit","value":"MILES","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"fst_380a228fd332746cadc3\",\n \"type\": \"FUEL\",\n \"displayName\": \"TEANECK TWSP\",\n \"currency\": \"USD\", //USD for US market, INR for India market\n \"location\": \"40.885482,-74.007431\",\n \"logoUrl\": \"https://dev-in-sheeva-tandc.s3.ap-south-1.amazonaws.com/iocl_logo.png\",\n \"addressDetails\": {\n \"streetAddress\": \"Blythe Road, Chamberlayne\",\n \"city\": \"Richmond\",\n \"state\": \"Virginia\",\n \"zipCode\": \"23116\",\n \"country\": \"US\"\n },\n \"fuelPrices\": [\n {\n \"fuelType\" : \"Gas Regular\",\n \"price\" : 3.5,\n \"unit\" : \"gallon\"\n },\n {\n \"fuelType\" : \"Gas Premium\",\n \"price\" : 4.5,\n \"unit\" : \"gallon\"\n },\n {\n \"fuelType\" : \"Diesel\",\n \"price\" : 3.5,\n \"unit\" : \"gallon\"\n }\n ],\n \"promotions\":[\n {\n \"name\": \"Reward Days\",\n \"category\" : \"FUEL\",\n \"discount\": \"Get 10 cents off per gallon\",\n \"mediaURL\": \"https://example.com/abc.jpg\"\n }\n ],\n \"amenities\" : [\"Washrooms\", \"Free Air\", \"Convenience Store\"],\n \"operatingHours\": [ // Deprecated - Use openingHours object\n \"06:00-23:30\"\n ],\n \"openingHours\": [\n {\n \"day\": \"1\", // SUNDAY\n \"hours\": [\n \"5:00 - 22:00\"\n ]\n },\n {\n \"day\": \"2\",\n \"hours\": [\n \"5:00 - 22:00\"\n ]\n },\n {\n \"day\": \"3\",\n \"hours\": [\n \"5:00 - 22:00\"\n ]\n },\n {\n \"day\": \"4\",\n \"hours\": [\n \"5:00 - 22:00\"\n ]\n },\n {\n \"day\": \"5\",\n \"hours\": [\n \"5:00 - 22:00\"\n ]\n },\n {\n \"day\": \"6\",\n \"hours\": [\n \"6:00 - 22:00\"\n ]\n },\n {\n \"day\": \"7\",\n \"hours\": [\n \"8:00 - 22:00\"\n ]\n }\n ],\n \"paymentEnabled\": true, // Does the service hub accept payment via Sheeva Pay?\n \"distance\": 8.710607771265286, // This is the crow distance in the distance unit of the region\n \"address\":\"Blythe Road, Chamberlayne\", // This property is deprecated and will be removed soon\n \"city\":\"Richmond\", // This property is deprecated and will be removed soon\n \"stateCode\":\"VA\" // This property is deprecated and will be removed soon\n }\n]"}],"_postman_id":"77a56931-2f03-49df-a274-d9eb35f2339c"},{"name":"Get Service Hub Details","id":"6a66eb4a-9814-4c21-8b15-03d9b27de085","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"url":"{{host}}/v2/partner-apis/serviceHubs/{{serviceHubId}}","urlObject":{"path":["v2","partner-apis","serviceHubs","{{serviceHubId}}"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"70fa6e2e-2263-45ea-a30b-750f4f871940","name":"Get Fuel Service Hub Details","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"url":"{{host}}/v2/partner-apis/serviceHubs/{{id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"fst_dbe5bcc470b1cb3e5375\",\n \"company\": \"Exxon\",\n \"location\": \"19.160018,72.858512\",\n \"displayName\": \"Schmidtts\",\n \"logoUrl\": \"https://dev-in-sheeva-tandc.s3.ap-south-1.amazonaws.com/iocl_logo.png\",\n \"currency\": \"USD\",\n \"type\": \"FUEL\",\n \"addressDetails\": {\n \"streetAddress\": \"Blythe Road, Chamberlayne\",\n \"city\": \"Richmond\",\n \"state\": \"Virginia\",\n \"zipCode\": \"23116\",\n \"country\": \"US\"\n },\n \"prices\": [\n {\n \"fuelType\": \"Gas Regular\",\n \"price\": 3.5,\n \"unit\": \"gallon\"\n },\n {\n \"fuelType\": \"Gas Premium\",\n \"price\": 4.5,\n \"unit\": \"gallon\"\n },\n {\n \"fuelType\": \"Diesel\",\n \"price\": 3.5,\n \"unit\": \"gallon\"\n }\n ],\n \"pumps\": [\n {\n \"number\": 1,\n \"fuelTypes\": [\n \"Gas Regular\",\n \"Gas Premium\"\n ],\n \"availability\": \"available\"\n },\n {\n \"number\": 2,\n \"fuelTypes\": [\n \"Gas Regular\",\n \"Gas Premium\",\n \"Diesel\"\n ],\n \"availability\": \"unavailable\"\n }\n ],\n \"promotions\": [\n {\n \"name\": \"Happy Hour\",\n \"category\": \"FUEL\",\n \"discount\": \"10 cents off per gallon\",\n \"mediaURL\": \"https://example.com/abc.jpg\"\n }\n ],\n \"active\": true,\n \"amenities\": [\n \"Washrooms\",\n \"Free Air\",\n \"Convenience Store\"\n ],\n \"operatingHours\": [\n \"06:00-23:30\"\n ],\n \"rating\": {\n \"totalRatings\": 245,\n \"average\": 4.5\n },\n \"address\":\"Blythe Road, Chamberlayne\", // This property is deprecated and will be removed soon\n \"city\":\"Richmond\", // This property is deprecated and will be removed soon\n \"stateCode\":\"VA\" // This property is deprecated and will be removed soon\n}"},{"id":"5757d00f-5d83-4415-ac69-dfd6010c945e","name":"Get Parking Service Hub Details","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"url":"{{host}}/v2/partner-apis/serviceHubs/{{parkingServiceHubId}}"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"displayName\": \"Marina Lot 9\",\n \"currency\": \"USD\",\n \"location\": \"33.982403360821465,-118.4560913004027\",\n \"addressDetails\": {\n \"city\": \"N/A\",\n \"state\": \"N/A\",\n \"zipCode\": \"N/A\",\n \"country\": \"N/A\",\n \"streetAddress\": \"N/A\"\n },\n \"amenities\": [\n \"Convenience Store\",\n \"Free Air\",\n \"Washrooms\"\n ],\n \"promotions\": [\n {\n \"name\": \"Reward Days\",\n \"category\": \"PARKING\",\n \"discount\": \"N/A\",\n \"mediaURL\": \"https://example.com/abc.jpg\"\n }\n ],\n \"polygon\": \"33.982144 -118.455279;33.982945 -118.456666;33.982662 -118.456904;33.981964 -118.455694;33.982008 -118.455657;33.981974 -118.455600;33.981971 -118.455538;33.981993 -118.455475;33.982082 -118.455331;33.982144 -118.455279\",\n \"timezone\": \"America/Los_Angeles\",\n \"openingHours\": [\n {\n \"day\": \"1\",\n \"hours\": [\n \"5:00 - 22:00\"\n ]\n },\n {\n \"day\": \"2\",\n \"hours\": [\n \"5:00 - 22:00\"\n ]\n },\n {\n \"day\": \"3\",\n \"hours\": [\n \"5:00 - 22:00\"\n ]\n },\n {\n \"day\": \"4\",\n \"hours\": [\n \"5:00 - 22:00\"\n ]\n },\n {\n \"day\": \"5\",\n \"hours\": [\n \"5:00 - 22:00\"\n ]\n },\n {\n \"day\": \"6\",\n \"hours\": [\n \"6:00 - 22:00\"\n ]\n },\n {\n \"day\": \"7\",\n \"hours\": [\n \"8:00 - 22:00\"\n ]\n }\n ],\n \"id\": \"1100053\"\n}"}],"_postman_id":"6a66eb4a-9814-4c21-8b15-03d9b27de085"},{"name":"Get Service Hubs (Deprecated)","id":"bcf7319c-4794-4083-916c-f4f4182fbb51","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"latitude\": 38.9262643,\n \"longitude\": -77.2428208,\n \"searchValue\" : 5,\n \"distance\": \"MILES\",\n \"type\": \"FUEL\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/partner-apis/serviceHubs","description":"This request returns POIs based on geolocation and service type.
\nIf successful, returns: HTTP 201 CREATED.
\n","urlObject":{"path":["v2","partner-apis","serviceHubs"],"host":["{{host}}"],"query":[{"disabled":true,"description":{"content":"Optional if Lat, Long not provided. Vehicle's VIN.
\n","type":"text/plain"},"key":"vin","value":null},{"disabled":true,"description":{"content":"Optional if VIN not provided. Vehicle Latitude.
\n","type":"text/plain"},"key":"latitude","value":"38.9262643"},{"disabled":true,"description":{"content":"Optional if VIN not provided. Vehicle Longitude.
\n","type":"text/plain"},"key":"longitude","value":"-77.2428208"},{"disabled":true,"description":{"content":"Optional. Radius to search within. Defaults to 2.0.
\n","type":"text/plain"},"key":"searchValue","value":"2"},{"disabled":true,"description":{"content":"Mandatory. MILES or KILOMETERS.
\n","type":"text/plain"},"key":"distance","value":"MILES"},{"disabled":true,"description":{"content":"Optional. Allows values: FUEL, CHARGING, PARKING, etc. Can repeat to search for more than one connector type.
\n","type":"text/plain"},"key":"type","value":"FUEL"},{"disabled":true,"description":{"content":"Optional. Allows values: J1772, CCS, CHADEMO, TESLA, MENNEKS, etc. Can repeat to search for more than one connector type.
\n","type":"text/plain"},"key":"connectorType","value":null},{"disabled":true,"description":{"content":"Optional. Pagination. Start after the 'nth' result. Default: 0
\n","type":"text/plain"},"key":"offset","value":null},{"disabled":true,"description":{"content":"Optional. Pagination. Number of results. Default: 10.
\n","type":"text/plain"},"key":"limit","value":null}],"variable":[]}},"response":[{"id":"90662494-5a99-40fe-aca1-71c022523803","name":"Get POIs by Fuel Service type","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text","description":"Received from authentication endpoint"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"vin\": \"HMTSS0000\", // Optional, if lat / long is not provided, then mandatory\n \"latitude\": 28.53729414706961, // double. Optional.\n \"longitude\": 77.28816661389338, // double. Optional.\n \"distance\": \"MILES\", // [MILES, KILOMETERS]. Mandatory.\n \"searchValue\": 1.0, // double. Defaults to 2.0. Optional.\n \"maxRecords\": 5, //integer. Defaults to 5. Optional.\n \"types\": [\n \"CHARGING\", // Include POIs of types. CHARGING, PARKING, FUEL, TOLL, etc.\n \"PARKING\"\n ],\n \"connectorTypes\": [\n \"J1772\", // Charging connectors: J1772, CCS, CHADEMO, TESLA, MENNEKS, etc.\n \"CCS1\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/v2/partner-apis/serviceHubs","host":["{{host}}"],"path":["v2","partner-apis","serviceHubs"],"query":[{"key":"lat","value":"40.885481","disabled":true},{"key":"long","value":"-74.007430","disabled":true},{"key":"distanceUnit","value":"MILES","disabled":true},{"key":"serviceType","value":"FUEL","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"poiId\": \"fst_22d7ef92f5ab6e37c148\",\n \"type\": \"FUEL\",\n \"displayName\": \"VIENNA MART\",\n \"currency\": \"USD\",\n \"location\": \"38.903869,-77.262898\",\n \"address\": \"us\",\n \"active\": true,\n \"chargers\": null\n },\n {\n \"poiId\": \"fst_a4a1bafb6cfce8906b32\",\n \"type\": \"FUEL\",\n \"displayName\": \"VIENNA TIGER MART\",\n \"currency\": \"USD\",\n \"location\": \"38.906692,-77.25836\",\n \"address\": \"us\",\n \"active\": true,\n \"chargers\": null\n }\n]"},{"id":"c0c8fb2c-b81c-460f-890b-7770cdc951d1","name":"Get POIs by multiple types","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text","description":"Received from authentication endpoint"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"vin\" : \"HMTSS0000\", // Optional, if lat / long is not provided, then mandatory\n \"latitude\": 28.53729414706961, // double. Optional.\n \"longitude\": 77.28816661389338, // double. Optional.\n \"distance\": \"MILES\", // [MILES, KILOMETERS]. Mandatory.\n \"searchValue\": 1.0, // double. Defaults to 2.0. Optional.\n \"maxRecords\":5, //integer. Defaults to 5. Optional.\n \"types\": [\n \"CHARGING\", // Include POIs of types. CHARGING, PARKING, FUEL, TOLL, etc.\n \"PARKING\"\n ],\n \"connectorTypes\": [\n \"J1772\", // Charging connectors: J1772, CCS, CHADEMO, TESLA, MENNEKS, etc.\n \"CCS1\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/v2/partner-apis/serviceHubs","host":["{{host}}"],"path":["v2","partner-apis","serviceHubs"],"query":[{"key":"lat","value":"40.885481","disabled":true},{"key":"long","value":"-74.007430","disabled":true},{"key":"distanceUnit","value":"MILES","disabled":true},{"key":"serviceType","value":"FUEL","disabled":true},{"key":"serviceType","value":"CHARGING","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"poiId\": \"cst_3f798db4b2fef377ab1b\",\n \"type\": \"CHARGING\",\n \"displayName\": \"PARKRDIGE IV\",\n \"currency\": \"USD\",\n \"location\": \"38.943907,-77.312812\",\n \"address\": \"10700 Parkridge Blvd, Reston, va, us\",\n \"active\": true,\n \"chargers\": [\n {\n \"latitude\": 38.943905,\n \"longitude\": -77.312798,\n \"unified_connector_id\": \"db5d95aa-f69a-443a-b8cd-3aac6627360f\",\n \"station_id\": \"84cc78fd-2c53-48a3-9c21-3aeeb08e0f97\",\n \"connector_name\": \"PARKRDIGE IV, STATION 1\",\n \"base_rate\": 0.19,\n \"connector_type\": \"J-1772\",\n \"network\": \"Charge_Point\",\n \"speed\": 6.6,\n \"availability\": \"available\",\n \"street_address\": \"10700 Parkridge Blvd\",\n \"city\": \"Reston\",\n \"state\": \"Virginia\"\n },\n {\n \"latitude\": 38.943905,\n \"longitude\": -77.312798,\n \"unified_connector_id\": \"90f29fbe-18fd-4c95-bb14-05a990af579f\",\n \"station_id\": \"84cc78fd-2c53-48a3-9c21-3aeeb08e0f97\",\n \"connector_name\": \"PARKRDIGE IV, STATION 1\",\n \"base_rate\": 0.19,\n \"connector_type\": \"J-1772\",\n \"network\": \"Charge_Point\",\n \"speed\": 6.6,\n \"availability\": \"available\",\n \"street_address\": \"10700 Parkridge Blvd\",\n \"city\": \"Reston\",\n \"state\": \"Virginia\"\n }\n ]\n },\n {\n \"poiId\": \"cst_6f216de55c646e5231d9\",\n \"type\": \"CHARGING\",\n \"displayName\": \"WOLF TRAP\",\n \"currency\": \"USD\",\n \"location\": \"38.933441,-77.265007\",\n \"address\": \"1645 Trap Rd, Vienna, va, us\",\n \"active\": true,\n \"chargers\": [\n {\n \"latitude\": 38.933426,\n \"longitude\": -77.264969,\n \"unified_connector_id\": \"8ad1da7f-fa0e-4152-aec2-f3c48c0c7f0b\",\n \"station_id\": \"81d0f7e9-f1a0-45e5-b959-1d3dfd3366e9\",\n \"connector_name\": \"WOLF TRAP, BARNS@WOLF TRAP\",\n \"base_rate\": 0.0,\n \"connector_type\": \"J-1772\",\n \"network\": \"Charge_Point\",\n \"speed\": 6.6,\n \"availability\": \"available\",\n \"street_address\": \"1645 Trap Rd\",\n \"city\": \"Vienna\",\n \"state\": \"Virginia\"\n },\n {\n \"latitude\": 38.933426,\n \"longitude\": -77.264969,\n \"unified_connector_id\": \"fcaea0c9-3841-40bb-94f4-1ae96e724e93\",\n \"station_id\": \"81d0f7e9-f1a0-45e5-b959-1d3dfd3366e9\",\n \"connector_name\": \"WOLF TRAP, BARNS@WOLF TRAP\",\n \"base_rate\": 0.0,\n \"connector_type\": \"J-1772\",\n \"network\": \"Charge_Point\",\n \"speed\": 6.6,\n \"availability\": \"in_use\",\n \"street_address\": \"1645 Trap Rd\",\n \"city\": \"Vienna\",\n \"state\": \"Virginia\"\n }\n ]\n }\n]"}],"_postman_id":"bcf7319c-4794-4083-916c-f4f4182fbb51"}],"id":"9a6537dc-e2fc-428e-969a-f2663809c15e","_postman_id":"9a6537dc-e2fc-428e-969a-f2663809c15e","description":""},{"name":"Services","item":[{"name":"Parking","item":[{"name":"Get Quote","event":[{"listen":"test","script":{"id":"1319074f-16f2-4a20-ace5-d3946d72a13e","exec":["const res = pm.response.json();","pm.environment.set('quoteId', res.quoteId);"],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"id":"d1c67ce8-a024-4c7e-aafc-adda53a26a93","exec":[""],"type":"text/javascript","packages":{}}}],"id":"f784524b-5f24-4d68-bb51-2a6f4071e340","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{accessToken}}"},{"key":"x-sheeva-program-code","value":"{{programCode}}"}],"url":"{{host}}/v2/partner-apis/parking/quote?vin={{vin}}&startTime=2024-06-19 13:12:10&duration=30&serviceHubId={{parkingServiceHubId}}&sessionId={{parkingSessionId}}","description":"Sending demoMode=1 would run a transaction with fake payment and will not activate the pump, charger or the parking lot. This helps with simulated testing in the sandbox / development.
\n","urlObject":{"path":["v2","partner-apis","parking","quote"],"host":["{{host}}"],"query":[{"key":"vin","value":"{{vin}}"},{"description":{"content":"Should be in the local timezone of the service hub
\n","type":"text/plain"},"key":"startTime","value":"2024-06-19 13:12:10"},{"description":{"content":"Duration of the parking in minutes
\n","type":"text/plain"},"key":"duration","value":"30"},{"disabled":true,"key":"","value":""},{"key":"serviceHubId","value":"{{parkingServiceHubId}}"},{"key":"sessionId","value":"{{parkingSessionId}}"}],"variable":[]}},"response":[{"id":"0cb06136-5cef-4d43-b9b5-a366284e7594","name":"Get Quote Example","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{accessToken}}"},{"key":"x-sheeva-program-code","value":"{{programCode}}"}],"url":{"raw":"{{host}}/v2/partner-apis/parking/quote?vin={{vin}}&startTime=2024-06-19 13:12:10&duration=30&serviceHubId={{parkingServiceHubId}}&sessionId={{parkingSessionId}}","host":["{{host}}"],"path":["v2","partner-apis","parking","quote"],"query":[{"key":"vin","value":"{{vin}}"},{"key":"startTime","value":"2024-06-19 13:12:10","description":"Should be in the local timezone of the service hub"},{"key":"duration","value":"30","description":"Duration of the parking in minutes"},{"key":"","value":"","disabled":true},{"key":"serviceHubId","value":"{{parkingServiceHubId}}"},{"key":"sessionId","value":"{{parkingSessionId}}"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"serviceHubId\": \"1100053\",\n \"sessionId\": \"parking_UbnAGCt2fQItXcZHsrE8\",\n \"quoteId\": \"d7156f56-3c6c-458a-8203-ee1d6c026f68\",\n \"startTime\": \"2024-06-19 13:12:00\",\n \"endTime\": \"2024-06-19 14:12:00\",\n \"price\": 2,\n \"currency\": \"USD\",\n \"createdAt\": 1719950406962,\n \"expiresIn\": 15\n}"}],"_postman_id":"f784524b-5f24-4d68-bb51-2a6f4071e340"},{"name":"Reserve Parking","id":"6bc01741-87aa-465d-9695-fd1d4b4b6275","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{accessToken}}"},{"key":"x-sheeva-program-code","value":"{{programCode}}"}],"body":{"mode":"raw","raw":"{\n \"vin\" : \"{{vin}}\",\n \"sessionId\": \"{{parkingSessionId}}\",\n \"quoteId\": \"{{quoteId}}\" // Sheeva Quote Id, received from the Get Quote API\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/partner-apis/parking/reserve","description":"Sending demoMode=1 would run a transaction with fake payment and will not activate the pump, charger or the parking lot. This helps with simulated testing in the sandbox / development.
\n","urlObject":{"path":["v2","partner-apis","parking","reserve"],"host":["{{host}}"],"query":[{"disabled":true,"key":"startTime","value":""},{"disabled":true,"key":"endTime","value":""}],"variable":[]}},"response":[{"id":"c6fc5d30-f5a8-4146-8ebc-733f2abadb25","name":"Reserve Parking Example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{accessToken}}"},{"key":"x-sheeva-program-code","value":"{{programCode}}"}],"body":{"mode":"raw","raw":"{\n \"vin\" : \"{{vin}}\",\n \"sessionId\": \"{{parkingSessionId}}\",\n \"quoteId\": \"{{quoteId}}\" // Sheeva Quote Id, received from the Get Quote API\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/v2/partner-apis/parking/reserve","host":["{{host}}"],"path":["v2","partner-apis","parking","reserve"],"query":[{"key":"startTime","value":"","disabled":true},{"key":"endTime","value":"","disabled":true}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"orderId\": \"3de93d80-5b67-4cbf-a1f9-2482171b4f08\", // Order Id of the Parking booking\n \"confirmationCode\": \"10001\" // Confirmation Code received from the service provider.\n}"}],"_postman_id":"6bc01741-87aa-465d-9695-fd1d4b4b6275"}],"id":"07b0c2ad-eeae-40b6-bf72-11a6461c42fc","_postman_id":"07b0c2ad-eeae-40b6-bf72-11a6461c42fc","description":""}],"id":"df90784e-e404-4bb8-b57d-f31285e6c767","_postman_id":"df90784e-e404-4bb8-b57d-f31285e6c767","description":""},{"name":"Payments","item":[{"name":"UPI","item":[{"name":"UPI Payment Complete","id":"aafa3acd-1dc6-4fa4-8ef3-8236289f6b6e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"url":"{{host}}/v2/partner-apis/payments/upi/payment-complete?sessionId={{sessionId}}","urlObject":{"path":["v2","partner-apis","payments","upi","payment-complete"],"host":["{{host}}"],"query":[{"key":"sessionId","value":"{{sessionId}}"}],"variable":[]}},"response":[],"_postman_id":"aafa3acd-1dc6-4fa4-8ef3-8236289f6b6e"},{"name":"Pay For Order","id":"57d24be1-d606-4562-bdc6-9049ea0b2da7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"purchaseAmount\" : 50,\n \"serviceType\" : \"PARKING\",\n \"vin\" : \"\", // vin\n \"driverId\" : \"\", // driverId\n \"quoteId\" : \"quote_12121212\", // Sheeva Quote Id, specific to serviceType\n \"paymentInstruments\" :[\n {\n \"amount\" : 50,\n \"type\": \"upi\"\n }\n ]\n}"},"url":"{{host}}/v2/partner-apis/payments/upi/initiate","description":"Sending demoMode=1 would run a transaction with fake payment and will not activate the pump, charger or the parking lot. This helps with simulated testing in the sandbox / development.
\n","urlObject":{"path":["v2","partner-apis","payments","upi","initiate"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"9e265469-f9fd-46ec-bb3f-f8216b3deed8","name":"UPI : Pay For Fastag Recharge Example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"purchaseAmount\" : 50,\n \"serviceType\" : \"FASTAG\",\n \"vin\" : \"\", // vin\n \"driverId\" : \"\", // driverId\n \"quoteId\" : \"quote_12121212\", // Sheeva Quote Id, specific to serviceType\n \"paymentInstruments\" :[\n {\n \"amount\" : 50,\n \"type\": \"upi\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/partner-apis/payments/upi/initiate"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"sessionId\" : \"fastag_payments_asd123\",\n \"orderId\" : \"fastag_payments_asd123\",\n \"purchaseAmount\" : 50,\n \"success\": true,\n \"paymentInstruments\" :[\n {\n \"type\": \"upi\",\n \"amount\": 50,\n \"transactionId\": \"pay_IsLdcLbTjTtp8ShiE1oq\",\n \"paymentUrl\": \"upi://url\" ,\n \"paymentStatus\": \"PAYMENT_INITIATED\" // Refer API Spec for all the valid payment statuses\n\n }\n ]\n}"},{"id":"0703e97a-4146-4092-b5cc-779096f543fc","name":"UPI : Pay For Parking Example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"purchaseAmount\" : 50,\n \"serviceType\" : \"PARKING\",\n \"vin\" : \"\", // vin\n \"driverId\" : \"\", // driverId\n \"quoteId\" : \"quote_12121212\", // Sheeva Quote Id, specific to serviceType\n \"paymentInstruments\" :[\n {\n \"amount\" : 50,\n \"type\": \"upi\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/partner-apis/payments/upi/initiate"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"sessionId\" : \"parking_payments_asd123\",\n \"orderId\" : \"parking_payments_asd123\",\n \"purchaseAmount\" : 50,\n \"success\": true,\n \"paymentInstruments\" :[\n {\n \"type\": \"upi\",\n \"amount\": 50,\n \"transactionId\": \"pay_IsLdcLbTjTtp8ShiE1oq\",\n \"paymentUrl\": \"upi://url\" ,\n \"paymentStatus\": \"PAYMENT_INITIATED\" // Refer API Spec for all the valid payment statuses\n\n }\n ]\n}"},{"id":"08fc9c78-b0f8-448a-8446-7efb0d1fe82d","name":"UPI : Pay For UBI Payments Example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"purchaseAmount\" : 50,\n \"serviceType\" : \"UBI_PAYMENTS\",\n \"vin\" : \"\", // vin\n \"driverId\" : \"\", // driverId\n \"paymentInstruments\" :[\n {\n \"amount\" : 50,\n \"type\": \"upi\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/partner-apis/payments/upi/initiate"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"sessionId\" : \"ubi_payments_asd123\",\n \"orderId\" : \"ubi_payments_asd123\",\n \"purchaseAmount\" : 50,\n \"serviceType\" : \"UBI_PAYMENTS\",\n \"success\": true,\n \"paymentInstruments\" :[\n {\n \"type\": \"upi\",\n \"amount\": 50,\n \"transactionId\": \"pay_IsLdcLbTjTtp8ShiE1oq\",\n \"paymentUrl\": \"upi://url\"\n }\n ]\n}"},{"id":"890b90f5-94be-42d6-abc6-87f0ea4d4ca7","name":"Credit Card : Pay For Parking Example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"serviceType\" : \"PARKING\",\n \"vin\" : \"\", // vin\n \"driverId\" : \"\", // driverId\n \"quoteId\" : \"quote_12121212\", // Sheeva Quote Id, specific to serviceType\n \"purchaseAmount\" : 20,\n \"currency\" : \"USD\",\n \"paymentInstruments\" :[\n {\n \"amount\" : 20,\n \"type\" : \"creditCard\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/partner-apis/payments/cc/initiate"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"sessionId\" : \"parking_payments_asd123\",\n \"orderId\" : \"parking_payments_asd123\",\n \"purchaseAmount\" : 20,\n \"success\": true,\n \"paymentInstruments\" :[\n {\n \"type\": \"creditCard\",\n \"amount\": 20,\n \"id\": \"card_41414141\",\n \"transactionId\": \"pay_IsLdcLbTjTtp8ShiE1oq\",\n \"paymentStatus\": \"PAYMENT_AUTHORIZED\" // Refer API Spec for all the valid payment statuses\n }\n ]\n}"},{"id":"f4413eee-b4b9-424d-b2d1-ac1413b65a14","name":"Failure : Authorize Payment Example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"purchaseAmount\" : 10,\n \"serviceType\" : \"Fastag\",\n \"vin\" : \"\", // vin\n \"vehicleServiceIdentifier\" : \"\", // Can be mandatory/optional, based on the service type \n \"paymentInstruments\" :[\n {\n \"amount\": 10,\n \"type\": \"upi\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/partner-apis/payments/authorize"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"reason\": \"Payment intent url is not available\"\n}"}],"_postman_id":"57d24be1-d606-4562-bdc6-9049ea0b2da7"}],"id":"0f0e54cb-93ca-4d4c-a2e6-5e584948a7cb","_postman_id":"0f0e54cb-93ca-4d4c-a2e6-5e584948a7cb","description":""},{"name":"Transactions","item":[{"name":"Get Payment Transactions","id":"5f6614e3-cd6a-474a-8908-531e9acfe4b6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/partner-apis/transactions?driverId={{driverId}}&vin={{vin}}&offset=0&limit=5&startDate=2023-05-01&endDate=2023-05-25","description":"This request returns payment transactions done by the driver or by the vin/vehicle. This API supports pagination.
\nMandatory. Partner assigned Driver ID
\n","type":"text/plain"},"key":"driverId","value":"{{driverId}}"},{"description":{"content":"Optional. Partner assigned vin
\n","type":"text/plain"},"key":"vin","value":"{{vin}}"},{"description":{"content":"Optional pagination. Show results from this offset. Default is 0. This represents the zero-based index of the page number. It can also be thought of as the number of \"pages\" to skip.
\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"Optional pagination. Number of items in the result set. Default is 10. This represents the number of records to be displayed on each page.
\n","type":"text/plain"},"key":"limit","value":"5"},{"description":{"content":"Optional. Default current date
\n","type":"text/plain"},"key":"startDate","value":"2023-05-01"},{"description":{"content":"Optional. 6 months older date
\n","type":"text/plain"},"key":"endDate","value":"2023-05-25"}],"variable":[]}},"response":[{"id":"dd7a2f42-d5ae-499b-ba77-d4e2a63f415c","name":"Get Payment Transactions Example1","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text","description":"Received from authentication endpoint"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"url":{"raw":"{{host}}/v2/partner-apis/transactions?driverId&vin&offset&limit","host":["{{host}}"],"path":["v2","partner-apis","transactions"],"query":[{"key":"driverId","value":null},{"key":"vin","value":null,"description":"Optional - Vehicle VIN"},{"key":"offset","value":null,"description":"Optional pagination. Show results from this offset. Default is 0."},{"key":"limit","value":null,"description":"Optional pagination. Number of items in the result set. Default is 20."}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactions\": [\n {\n \"paymentId\": \"pay_2y2aDe6BEqbLCYJlgLcd\", // Sheeva.AI unique paymentId\n \"transactionId\": \"10261296-166853171260\", // Order number for this transaction\n \"sessionId\": \"fuel_BOuBK76KoPMICbp14Ute\", // Service type session identifier\n \"serviceHub\": {\n \"name\": \"ICar Port\",\n \"streetAddress\": \"10B, Ram Nagar, Chennai\"\n },\n \"vehicle\": {\n \"licensePlate\": \"MH 01 AB 1234\",\n \"model\": \"Compass\",\n \"make\": \"Jeep\",\n \"year\": 2023,\n \"color\": \"RED\"\n },\n \"status\": \"SERVICE_COMPLETE\", // Refer API Spec for all the valid session statuses\n \"paymentStatus\": \"PAYMENT_COMPLETE\", // Refer API Spec for all the valid payment statuses\n \"serviceType\": \"FUEL\", // Service type for this transaction\n \"currency\": \"INR\", // Currency code\n \"amount\": 100.0, // Transaction amount\n \"paymentType\":\"upi\", // upi, wallet\n \"createdAt\": 1668531651000 // Transaction created at timestamp\n }\n ],\n \"metadata\": {\n \"result_set\": {\n \"count\": 25,\n \"offset\": 0,\n \"limit\": 25,\n \"total\": 77\n }\n }\n}"}],"_postman_id":"5f6614e3-cd6a-474a-8908-531e9acfe4b6"},{"name":"Get Payment Transactions Details","id":"aedf3e59-e8ef-49f2-a467-0f78888f1a86","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/partner-apis/transactions/details?sessionId={{sessionId}}","description":"This request returns the details of a single payment transaction.
\nIf successful, returns: HTTP 200 OK.
\nUnique sessionId
\n","type":"text/plain"},"key":"sessionId","value":"{{sessionId}}"},{"disabled":true,"description":{"content":"Unique Order Id
\n","type":"text/plain"},"key":"","value":""}],"variable":[]}},"response":[{"id":"0f89ae1b-b853-4b0d-b61b-7c597f30ed51","name":"Get Transactions Details Example1","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text","description":"Received from authentication endpoint"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"url":{"raw":"{{host}}/v2/partner-apis/transactions/details?sessionId={{sessionId}}","host":["{{host}}"],"path":["v2","partner-apis","transactions","details"],"query":[{"key":"sessionId","value":"{{sessionId}}","description":"Unique sessionId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"driver\": {\n \"driverId\": \"dri_dafa233\",\n \"firstName\": \"Lokesh\",\n \"lastName\": \"Kumar\"\n },\n \"transaction\": {\n \"vehicle\": {\n \"vin\": \"HUT242424242\",\n \"licensePlate\": \"MH 01 AB 1234\",\n \"model\": \"Compass\",\n \"make\": \"Jeep\",\n \"year\": 2023,\n \"color\": \"RED\",\n \"fuelTypes\": [\n \"diesel\"\n ], // Possible values: [petrol, diesel, charging]\n \"connectorType\": \"J1772\", // Possible values .... RIZ\n \"active\": true // Always pass true while onboarding.\n },\n \"serviceHub\": {\n \"id\": \"fst_dbe5bcc470b1cb3e5375\",\n \"name\": \"ICar Port\",\n \"pump\": \"3\",\n \"location\": \"19.102809,72.873848\",\n \"logoUrl\": \"https://dev-in-sheeva-tandc.s3.ap-south-1.amazonaws.com/iocl_logo.png\",\n \"addressDetails\": {\n \"streetAddress\": \"Aarey Colony, Goregaon\",\n \"city\": \"Mumbai\",\n \"state\": \"Maharashtra\",\n \"zipCode\": \"400065\",\n \"country\": \"India\"\n }\n },\n \"paymentId\": \"pay_2y2aDe6BEqbLCYJlgLcd\", //Deprecated - Will be removed in the next version\n \"transactionId\": \"10261296-166853171260\", //Deprecated - Will be removed in the next version\n \"sessionId\": \"fuel_BOuBK76KoPMICbp14Ute\",\n \"status\": \"SERVICE_COMPLETE\", // Possible Values - SERVICE_NOT_INITIATED, SERVICE_INITIATED, SERVICE_CONFIRMED, SERVICE_IN_PROGRESS, SERVICE_COMPLETE, SERVICE_CANCELED\n \"paymentStatus\": \"PAYMENT_COMPLETE\", // Refer API Spec for all the valid payment statuses \n \"serviceType\": \"FUEL\",\n \"currency\": \"INR\",\n \"amount\": 100.0,\n \"paymentInstruments\": [\n {\n \"type\": \"upi\",\n \"amount\": 50.0,\n \"transactionId\": \"AXI59bc02049a9447c0bf53e8367175ac42\" // UPI transaction unique identifier\n },\n {\n \"type\": \"rewards\",\n \"name\": \"Sheeva Rewards\",\n \"organization\": \"Sheeva\", // Deprecated\n \"serviceProviderCode\": \"Sheeva\",\n \"serviceProviderName\": \"Sheeva\",\n \"amount\": 20.0,\n \"transactionId\": \"rewards-sheeva-1213141\"\n },\n {\n \"type\": \"rewards\",\n \"name\": \"IOCL XtraRewards\",\n \"organization\": \"IOCL\", // Deprecated\n \"serviceProviderCode\": \"IOCL\",\n \"serviceProviderName\": \"Indian Oil Corporation\",\n \"amount\": 30.0,\n \"transactionId\": \"rewards-iocl-xtra-12412412\"\n }\n ],\n \"rewardsEarned\": [\n {\n \"type\": \"rewards\",\n \"name\": \"Sheeva Rewards\",\n \"organization\": \"Sheeva\", //Deprecated\n \"serviceProviderCode\": \"Sheeva\",\n \"serviceProviderName\": \"Sheeva\",\n \"points\": 100,\n \"amount\": 10,\n \"transactionId\": \"rewards-sheeva-1213142\"\n }\n ],\n \"createdAt\": 1668531651000\n }\n}"}],"_postman_id":"aedf3e59-e8ef-49f2-a467-0f78888f1a86"},{"name":"Get Payment Receipt","id":"1f533bc5-4ae0-43a5-8d1a-0586f503773e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/partner-apis/transactions/receipt?sessionId={{sessionId}}","description":"This request triggers sending the PDF receipt URL to a messaging channel, currently WhatsApp.
\nIf successful, returns: HTTP 200 OK.
\n","urlObject":{"path":["v2","partner-apis","transactions","receipt"],"host":["{{host}}"],"query":[{"description":{"content":"Service type session identifier
\n","type":"text/plain"},"key":"sessionId","value":"{{sessionId}}"},{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[{"id":"9561d9df-2a05-4030-8846-8166c6651b4c","name":"Get Payment Receipt Example","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/v2/partner-apis/transactions/receipt?sessionId={{sessionId}}","host":["{{host}}"],"path":["v2","partner-apis","transactions","receipt"],"query":[{"key":"sessionId","value":"{{sessionId}}","description":"Service type session identifier"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"receiptStatus\": \"AVAILABLE\", //AVAILABLE, NOT_AVAILABLE, FAILED\n \"filePathUrl\":\"https://file.location.url/xpref\"\n}"},{"id":"e352e290-d2c2-4505-8569-14dde41518ae","name":"Get Payment Receipt (NOT_AVAILABLE)","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/v2/partner-apis/transactions/receipt?sessionId={{sessionId}}","host":["{{host}}"],"path":["v2","partner-apis","transactions","receipt"],"query":[{"key":"sessionId","value":"{{sessionId}}","description":"Service type session identifier"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"receiptStatus\": \"NOT_AVAILABLE\" //AVAILABLE, NOT_AVAILABLE, FAILED\n}"}],"_postman_id":"1f533bc5-4ae0-43a5-8d1a-0586f503773e"}],"id":"53f59c55-695b-4508-85b7-e9a0161550a9","description":"The Payment Transactions end point supports transaction related APIs.
\n","_postman_id":"53f59c55-695b-4508-85b7-e9a0161550a9"},{"name":"Credit Cards","item":[{"name":"1 - Get Vehicle Wallet","event":[{"listen":"test","script":{"id":"991be22c-b9fb-4b65-ac30-10695586cc59","exec":["var jsonData = JSON.parse(responseBody);\r","postman.setEnvironmentVariable(\"walletId\", jsonData.walletId);"],"type":"text/javascript","packages":{}}}],"id":"67c1a83b-43b2-4c3d-95e6-535818139287","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/partner-apis/wallet?vin={{vin}}","urlObject":{"path":["v2","partner-apis","wallet"],"host":["{{host}}"],"query":[{"key":"vin","value":"{{vin}}"}],"variable":[]}},"response":[{"id":"ef2b1154-6718-4df9-ac6e-1f06415fbdbb","name":"Get Vehicle Wallet","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/v2.1/partner-apis/wallet?vin={{vin1}}","host":["{{host}}"],"path":["v2.1","partner-apis","wallet"],"query":[{"key":"vin","value":"{{vin1}}"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"walletId\": \"1bf4de4f-442f-42d6-abc6-86a952ef7895\",\n \"driverId\": \"dri_bP2lHCcPFzY6Yd19qvdM\",\n \"vin\": \"sheeva_vehicle_id_test\",\n \"type\": \"VEHICLE\",\n \"cards\": [\n {\n \"id\": \"4e17a735-9810-4236-8544-790886d53f5f\",\n \"lastFour\": \"0564\",\n \"status\": \"ACTIVE\",\n \"brand\": \"VISA\",\n \"default\":true\n }\n ]\n}"}],"_postman_id":"67c1a83b-43b2-4c3d-95e6-535818139287"},{"name":"2 - Generate Public Key To Add Credit Card","id":"ce93709e-e5d7-437a-8513-0084103a0ac3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"walletId\": \"{{walletId}}\",\n \"driverId\": \"{{driverId}}\", \n \"vin\": \"{{vin}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/partner-apis/wallet/public-key","urlObject":{"path":["v2","partner-apis","wallet","public-key"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"409e1b0a-3d36-46a1-b1cd-2c31d7d2b973","name":"Generate Public Key To Add Credit Card","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"walletId\": \"4bb1d4bb-69c6-4baa-8161-bb870f2eebb6\", \n \"driverId\": \"my_sheeva_driver_id_4\", \t// Optional, one of driver-id or vehicle-id is mandatory, based on the type of wallet\n \"vehicleId\": \"sheeva_vehicle_id_5\" // Optional, one of driver-id or vehicle-id is mandatory, based on the type of wallet\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2.1/partner-apis/wallet/public-key"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"key\": \"MIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIBigKCAYEAtVDy2c5oQxndUliND2sQCg0DOBnCdpdHS37UcR1SZYAmkPFNkz//N6+49OFgab+AtOC84aTICo3y6FnDXP0qF2fte1aIesDX2gDUDsfHoVMo7JRNzkRGIe4+t6hxa6Atjclpyb+sLo1tM0p5n1dStE2F44AgiDCbbdIsBfdDta2d4fhgUR8KfT7ZHrqH/ZOzp4BW53sde+FtmnstviVcSxShQNpI1KurfRKT+tgps6JNw/lJE58EnpqTHRIRraMTpWJThSsaiyWdlIhKjO0iq0bo5Gj/he4pHqM4W58mtT3dwhq3t21n28I2/H//2Xcyt2H/LLGeAzdcuAuoJlvKVCtNxO9aJ0lRu/TNvi75moMWXs3Eysbib3PtOCUVeJnj/fABEW4fkAX7c0ceM+dwkQpq8ccsDieywrpaZDgQ8g5toHyJb6Ye7rtsSnGnju6u+Dr1D1Xp7tM1Jilksj/p5s1bmEJMvQ4yxJgXnORhr6nB0rMib8UBT7mMwbyG2VdZAgMBAAE=\"\n}"}],"_postman_id":"ce93709e-e5d7-437a-8513-0084103a0ac3"},{"name":"3 - Add Credit Card To A Wallet","id":"5cc6d631-b6b9-4138-b8fe-a9a1d58b8321","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"driverId\": \"{{driverId}}\",\n \"vin\": \"{{vin}}\",\n \"walletId\": \"{{walletId}}\",\n \"encryptedCreditCard\": \"HrWagujXc4FctJdPBWiLGQjFjfGFwNfR8OpJRzzt9ROxfg6t5NeRPUJ/RwKiUFZdMR5+mKraKOS+u6wHofFeWJ6A0PO4LJZFOgL7Y+5EHIW1wrBrORsjl8hKnEcedx2Cd7aHopVacXgTaMpyEcjY8fZUbdbx3wGaNQfRdlgRwt0Ey58ko8S/HmPR1FYd7C7X0Or2yghg+5lIAz4dply9At9cGDy5LqAhbayUHpZUfTwGY9G+sDiS81KrKG87blSX37jchwSxDFCqz4gqy7avvQqEGLYNuJfXhFu6AvakUGNaQpbQ3wr07ZqYB9UBJFBRv0vrM/G5KMbyMcFPv5SJm6Fgt3MZ+T3VNzwh/+O+1+i+AZrhVTToTqlEEv06d/4vi52/A8DXt0KEeRWVgb8TN67a23zgHvYdW8/jZuPcp+gaPYUatUQMoyJHxn/cuzLFsF9f+Q3eYAL8IjGLC0RpglASHKyspmRUrCFXztx9kpiLb2hoSallC9UqD/U+LL0t\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/partner-apis/wallet/cards","urlObject":{"path":["v2","partner-apis","wallet","cards"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"ed9cd224-1051-49eb-8b8a-864fe480ddf1","name":"Add Credit Card To A Wallet","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"driverId\" : \"{{driverId}}\",\n \"vin\": \"{{vehicleId}}\",\n \"walletId\" : \"{{walletId}}\",\n \"encryptedCreditCard\" : \"dHVjgb46MSwvEldGP9h1539TfE39ChoC1SEuRoMTBeQu4Jrmq8GDDqimEJBEXe1vlGDkh/4TUnUBrMwtYgLBzDB2v3Pm0V9yv9ut5k/tJipwEzb/GrBoGmH5T2nI72bB2ToKCYpJk4KSia6CzK6umbdpuS+eHmMN5KuVWnbNdsWJPR22hKJYi58jSp3kikEA3A0Ze+iomCAKlatVLnp+c9hSVr+kUN09KZVxzvthcauuYGf62luqx7z+xs++ig8Jb1kWCpIVeDU+v7fb0P2u9C2p4AxF0cbNo+meOFdeaWhQUObf9jU4ejTaYHranFlATYNPEEE+UJLhPgjJhrrMrRgFcw/ZqaQDm6rjAlWa31R0cnVDy3czBxKNz5JEVxnj6KbVZug7QmMCohQmCsoxFAX6lm8HUkXRIDRmz4/Qp5HCxKxHaUVdH7ERp8nerXnIFCTqHtYZwYzJVccb8ohkgrq3d0oiNORnkClhtfe2IwYVsaHTAxZ17u6ggHI4w1Le\" // Follow the steps of creating secret key given in the documentation\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2.1/partner-apis/wallet/cards"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"state\": \"Success\",\n \"message\": \"Credit card added successfully\"\n}"}],"_postman_id":"5cc6d631-b6b9-4138-b8fe-a9a1d58b8321"},{"name":"4 - Get Credit Cards Associated To Wallet","event":[{"listen":"test","script":{"id":"24fba6a9-ab12-4a0b-815c-ebbdbad72b24","exec":["var jsonData = JSON.parse(responseBody);\r","postman.setEnvironmentVariable(\"cardId\", jsonData[0].id);"],"type":"text/javascript","packages":{}}}],"id":"a044d0b9-fba3-4033-970c-71ab9a3dc2bc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"url":"{{host}}/v2/partner-apis/wallet/{{walletId}}/cards","urlObject":{"path":["v2","partner-apis","wallet","{{walletId}}","cards"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"a9a9417a-6e84-43a7-b2c1-aebc14ea4af0","name":"Get Credit Cards Associated To Wallet","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"url":"{{host}}/v2.1/partner-apis/wallet/{{walletId}}/cards"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"4e17a735-9810-4236-8544-790886d53f5f\",\n \"lastFour\": \"0564\",\n \"brand\": \"VISA\",\n \"default\": true,\n \"expired\" : false //optional\n },\n {\n \"id\": \"90a23da-9810-4236-8544-790886d53f5f\",\n \"lastFour\": \"0564\",\n \"brand\": \"VISA\",\n \"default\": false,\n \"expired\" : false //optional\n }\n]"}],"_postman_id":"a044d0b9-fba3-4033-970c-71ab9a3dc2bc"},{"name":"5 - Get Credit Card By Id","id":"db9df158-7918-4708-9eb7-fd77f2d07bc0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"url":"{{host}}/v2/partner-apis/wallet/{{walletId}}/cards/{{cardId}}","urlObject":{"path":["v2","partner-apis","wallet","{{walletId}}","cards","{{cardId}}"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"f2d9272c-e897-484f-a5da-4bfc8a42767a","name":"Get Credit Card By Id","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"url":"{{host}}/v2.1/partner-apis/wallet/{{walletId}}/cards/{{cardId}}"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"4e17a735-9810-4236-8544-790886d53f5f\",\n \"lastFour\": \"0564\",\n \"brand\": \"VISA\",\n \"default\": true,\n \"expired\" : false //optional\n}"}],"_postman_id":"db9df158-7918-4708-9eb7-fd77f2d07bc0"},{"name":"6 - Mark Credit Card As Default","id":"6c431500-66d8-4022-95d1-9eba8be59147","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"url":"{{host}}/v2/partner-apis/wallet/{{walletId}}/cards/{{cardId}}","urlObject":{"path":["v2","partner-apis","wallet","{{walletId}}","cards","{{cardId}}"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"b1cec473-3410-41ed-a828-a3fa2aa1e3a0","name":"Mark Credit Card As Default","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"url":"{{host}}/v2.1/partner-apis/wallet/{{walletId}}/cards/{{cardId}}"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"state\": \"Success\",\n \"message\": \"Card set as default\"\n}"}],"_postman_id":"6c431500-66d8-4022-95d1-9eba8be59147"},{"name":"7 - Delete Credit Card","id":"20cefcb8-824a-4e1e-b7ac-e34a38289028","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"url":"{{host}}/v2/partner-apis/wallet/{{walletId}}/cards/{{cardId}}","urlObject":{"path":["v2","partner-apis","wallet","{{walletId}}","cards","{{cardId}}"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"b77c1f93-ca70-469c-9981-0c7ca72ce24c","name":"Delete Credit Card","originalRequest":{"method":"DELETE","header":[],"url":"{{host}}/v2.1/partner-apis/wallet/{{walletId}}/cards/{{cardId}}"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"state\": \"Success\",\n \"message\": \"Credit card has been deleted successfully\"\n}"}],"_postman_id":"20cefcb8-824a-4e1e-b7ac-e34a38289028"}],"id":"92fdbf11-4fde-45e4-8c02-f6407dc858e4","_postman_id":"92fdbf11-4fde-45e4-8c02-f6407dc858e4","description":""},{"name":"Get Supported Payment Methods","id":"12f40f5a-0638-449e-a642-5c0f3edad701","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"url":"{{host}}/v2/partner-apis/payments/supported-payment-methods?programCode={{programCode}}","urlObject":{"path":["v2","partner-apis","payments","supported-payment-methods"],"host":["{{host}}"],"query":[{"key":"programCode","value":"{{programCode}}"}],"variable":[]}},"response":[{"id":"e5b52c9e-faee-4799-86b1-f4596f0d7940","name":"Get Supported Payment Methods","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text","description":"Received from authentication endpoint"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"url":{"raw":"{{host}}/v2/partner-apis/supported-payment-methods?programCode","host":["{{host}}"],"path":["v2","partner-apis","supported-payment-methods"],"query":[{"key":"programCode","value":null}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n \"CREDITCARD\",\n \"UPI\",\n \"BNPL\",\n \"WALLET\", //White Labeled Wallet\n \"LOYALTYPOINTS\"\n]"}],"_postman_id":"12f40f5a-0638-449e-a642-5c0f3edad701"},{"name":"Authorize Payment","id":"a2e9b1dd-f578-493f-add1-03dff8de7608","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"purchaseAmount\" : 150,\n \"paymentInstruments\" :[\n {\n \"type\": \"creditCard\",\n \"id\": \"card_41414141\",\n \"amount\": 100 \n },\n {\n \"amount\" : 50,\n \"type\": \"rewards\",\n \"loyaltyProgramId\": \"loyalty_123456\", // id received from the Loyalty -> GetMyPrograms API \n \"organizationId\": \"Sheeva-1\", //Deprecated\n \"serviceProviderCode\": \"Sheeva-1\"\n }\n ],\n \"demoMode\": 0\n}"},"url":"{{host}}/v2/partner-apis/payments/authorize-transaction?sessionId={{sessionId}}","description":"Sending demoMode=1 would run a transaction with fake payment and will not activate the pump, charger or the parking lot. This helps with simulated testing in the sandbox / development.
\n","urlObject":{"path":["v2","partner-apis","payments","authorize-transaction"],"host":["{{host}}"],"query":[{"key":"sessionId","value":"{{sessionId}}"}],"variable":[]}},"response":[{"id":"20b2377d-7153-4380-af48-5bf802034dc3","name":"UPI : Authorize Payment Example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"purchaseAmount\" : 150,\n \"paymentInstruments\" :[\n {\n \"amount\": 100,\n \"type\": \"upi\"\n },\n {\n \"amount\" : 50,\n \"type\": \"rewards\",\n \"loyaltyProgramId\": \"loyalty_123456\", // id received from the Loyalty -> GetMyPrograms API \n \"organizationId\": \"Sheeva-1\", //Deprecated\n \"serviceProviderCode\": \"Sheeva-1\"\n }\n ],\n \"demoMode\": 0\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/v2/partner-apis/payments/authorize-transaction?sessionId=fuel_cugQQuUJD0zlbTqGfO4Y","host":["{{host}}"],"path":["v2","partner-apis","payments","authorize-transaction"],"query":[{"key":"sessionId","value":"fuel_cugQQuUJD0zlbTqGfO4Y"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"purchaseAmount\" : 150,\n \"success\": true,\n \"demoMode\":0,\n \"paymentInstruments\" :[\n {\n \"type\": \"upi\",\n \"amount\": 150,\n \"transactionId\": \"pay_IsLdcLbTjTtp8ShiE1oq\",\n \"paymentUrl\": \"upi://url\"\n\n }\n ]\n}"},{"id":"1e9582b0-3e60-4ee5-8708-8293e2641b42","name":"Rewards : Authorize Payment Example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"purchaseAmount\": 15,\n \"paymentInstruments\": [\n {\n \"amount\": 15,\n \"type\": \"rewards\",\n \"loyaltyProgramId\": \"iocl_xtrarewards\", \n \"serviceProviderCode\": \"IOCL\"\n }\n ],\n \"demoMode\": 0\n}\n","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/v2/partner-apis/payments/authorize-transaction?sessionId=fuel_cugQQuUJD0zlbTqGfO4Y","host":["{{host}}"],"path":["v2","partner-apis","payments","authorize-transaction"],"query":[{"key":"sessionId","value":"fuel_cugQQuUJD0zlbTqGfO4Y"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"paymentInstruments\": [ \n {\n \"type\": \"rewards\",\n \"amount\": 15.0,\n \"loyaltyProgramId\": \"iocl_xtrarewards\",\n \"transactionId\": \"fuel_331idNPv0VGjXfIoVkt4\",\n \"serviceProviderCode\": \"IOCL\"\n }\n ],\n \"purchaseAmount\": 15.0,\n \"demoMode\": \"0\",\n \"success\": true\n}\n"},{"id":"61094205-9d1d-4c8b-9bf4-f2e8d92f1bd9","name":"Credit Card : Authorize Payment Example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"purchaseAmount\" : 150,\n \"paymentInstruments\" :[\n {\n \"amount\": 100,\n \"type\": \"creditCard\",\n \"id\": \"card_41414141\"\n },\n {\n \"amount\" : 50,\n \"type\": \"rewards\",\n \"loyaltyProgramId\": \"loyalty_123456\", // id received from the Loyalty -> GetMyPrograms API \n \"organizationId\": \"Sheeva-1\", //Deprecated\n \"serviceProviderCode\": \"Sheeva-1\"\n }\n ],\n \"demoMode\": 0\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/v2/partner-apis/payments/authorize-transaction?sessionId={{sessionId}}","host":["{{host}}"],"path":["v2","partner-apis","payments","authorize-transaction"],"query":[{"key":"sessionId","value":"{{sessionId}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"purchaseAmount\" : 150,\n \"success\" : true,\n \"paymentInstruments\" :[\n {\n \"type\": \"creditCard\",\n \"amount\": 100,\n \"id\": \"card_41414141\",\n \"transactionId\" : \"tx_141414141\"\n },\n {\n \"type\": \"rewards\",\n \"amount\" : 50,\n \"transactionId\": \"lp_yiyifaf131\",\n \"organizationId\": \"Sheeva-1\", // Deprecated\n \"serviceProviderCode\": \"Sheeva-1\",\n \"serviceProviderName\": \"Sheeva\",\n \"loyaltyProgramId\": \"loyalty_123456\" // id received from the Loyalty -> GetMyPrograms API \n }\n ],\n \"demoMode\":0\n}"},{"id":"3550e3fe-bb96-46e4-b687-8c9e168efcbd","name":"Wallet : Authorize Payment Example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"purchaseAmount\" : 150,\n \"paymentInstruments\" :[\n {\n \"amount\": 100,\n \"type\": \"wallet\",\n \"id\": \"wallet_41414141\"\n },\n {\n \"amount\" : 50,\n \"type\": \"rewards\",\n \"loyaltyProgramId\": \"loyalty_123456\", // id received from the Loyalty -> GetMyPrograms API \n \"organizationId\": \"Sheeva-1\", //Deprecated\n \"serviceProviderCode\": \"Sheeva-1\"\n }\n ],\n \"demoMode\": 0\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/v2/partner-apis/payments/authorize-transaction?sessionId={{sessionId}}","host":["{{host}}"],"path":["v2","partner-apis","payments","authorize-transaction"],"query":[{"key":"sessionId","value":"{{sessionId}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"purchaseAmount\" : 150,\n \"success\" : true,\n \"paymentInstruments\" :[\n {\n \"type\": \"wallet\",\n \"amount\": 100,\n \"transactionId\" : \"tx_141414141\",\n \"id\": \"wallet_41414141\"\n },\n {\n \"type\": \"rewards\",\n \"amount\" : 50,\n \"transactionId\": \"lp_yiyifaf131\",\n \"organizationId\": \"Sheeva-1\", // Deprecated\n \"serviceProviderCode\": \"Sheeva-1\",\n \"serviceProviderName\": \"Sheeva\",\n \"loyaltyProgramId\": \"loyalty_123456\" // id received from the Loyalty -> GetMyPrograms API\n }\n ],\n \"demoMode\":0\n}"},{"id":"478eda84-5d33-4039-a103-246177a01052","name":"Failure : Authorize Payment Example Copy","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"purchaseAmount\" : 150,\n \"paymentInstruments\" :[\n {\n \"amount\": 100,\n \"type\": \"wallet\",\n \"id\": \"wallet_41414141\"\n },\n {\n \"amount\" : 50,\n \"type\": \"rewards\",\n \"loyaltyProgramId\": \"loyalty_123456\", // id received from the Loyalty -> GetMyPrograms API \n \"organizationId\": \"Sheeva-1\", //Deprecated\n \"serviceProviderCode\": \"Sheeva-1\"\n }\n ],\n \"demoMode\": 0\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/v2/partner-apis/payments/authorize-transaction?sessionId={{sessionId}}","host":["{{host}}"],"path":["v2","partner-apis","payments","authorize-transaction"],"query":[{"key":"sessionId","value":"{{sessionId}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"success\" : false,\n \"reason\" : \"Credit card declined\"\n}"}],"_postman_id":"a2e9b1dd-f578-493f-add1-03dff8de7608"},{"name":"Payment Status","id":"78eaa765-183a-48c9-a2d4-2770dc31e2fc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text"}],"url":"{{host}}/v2/partner-apis/payments/upi/payment-status?sessionId=12345","urlObject":{"path":["v2","partner-apis","payments","upi","payment-status"],"host":["{{host}}"],"query":[{"key":"sessionId","value":"12345"},{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[{"id":"17bc7551-ca92-4794-9c16-773f62db2c69","name":"Payment Status","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"url":{"raw":"{{host}}/v2/partner-apis/payments/upi/payment-status?sessionId={{sessionId}}","host":["{{host}}"],"path":["v2","partner-apis","payments","upi","payment-status"],"query":[{"key":"sessionId","value":"{{sessionId}}"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"paymentStatus\": \"PAYMENT_COMPLETE\", // Refer API Spec for all the valid payment statuses\n \"paymentAckCode\": \"Pay-12345678\", \n \"paymentAckType\": \"QR_CODE\", // QR_CODE, PLAIN_TEXT \n \"paymentAckPlatform\": \"IOCL PAY\",\n \"paymentConfirmationStatus\": \"READY\", // Possible Values - READY, ACKNOWLEDGED, FAILED, NOT_AVAILABLE, NOT_APPLICABLE, INITIATED, CONFIRMED, IN_PROGRESS, COMPLETED, CANCELED\n \"serviceStatus\": \"SERVICE_CONFIRMED\" // Possible Values - SERVICE_NOT_INITIATED, SERVICE_INITIATED, SERVICE_CONFIRMED, SERVICE_IN_PROGRESS, SERVICE_COMPLETE, SERVICE_CANCELED\n\n}"}],"_postman_id":"78eaa765-183a-48c9-a2d4-2770dc31e2fc"}],"id":"db836814-0782-42ca-b247-835e4f209e3d","_postman_id":"db836814-0782-42ca-b247-835e4f209e3d","description":""},{"name":"Webhooks","item":[{"name":"Register Status Webhook","id":"db76c0f1-51c0-4b48-abd2-de6b2c8a5eb9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"webhookUrl\": \"https://test.denso.com\",\n \"hmacSigningKey\": \"f7bc83f430538424b13298e6aa6fb143ef4d59a14946175997479dbc2d1a3cd8\",\n \"apikey\": \"af75e1f0-f472-48bb-83b2-35541dc860dd\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/partner-apis/webhooks/status-updates","description":"This request allows registering an HTTP POST status webhook with SeevaConnect.
\nIf successful, returns: HTTP 201 CREATED.
\nExamples below demonstrate the json body Sheeva will call your registered webhook endpoint with:
\nStatus:
\n","urlObject":{"path":["v2","partner-apis","webhooks","status-updates"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"68589d59-4d19-437b-8938-1077976afd7f","name":"Status Callback Example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text","description":"Received from authentication endpoint"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text","description":"apiKey submited during webhook registration "}],"body":{"mode":"raw","raw":"{\n \"webhookUrl\": \"https://test.oem.com\",\n \"hmacSigningKey\": \"f7bc83f430538424b13298e6aa6fb143ef4d59a14946175997479dbc2d1a3cd8\",\n \"apikey\": \"af75e1f0-f472-48bb-83b2-35541dc860dd\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/partner-apis/webhooks/status-updates"},"status":"Created","code":201,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"d2c8886e-22db-4191-83dd-953bf44731c5","name":"Low Fuel Alert Example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text","description":"Received from authentication endpoint","disabled":true},{"key":"x-api-key","value":"{{x-api-key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"status\": \"LOW_FUEL_DETECTED\",\n \"driverId\": \"dri_123123\",\n \"vin\": \"TSTLRGBL663PR2127\",\n \"vehicleLocation\": \"40.885482,-74.007431\",\n \"serviceHubs\": [\n {\n \"id\": \"fst_380a228fd332746cadc3\",\n \"displayName\": \"IOCL Fuel Station\",\n \"addressDetails\": {\n \"streetAddress\": \"Aarey Colony, Goregaon\",\n \"city\": \"Mumbai\",\n \"state\": \"Maharashtra\",\n \"zipCode\": \"400065\",\n \"country\": \"India\"\n },\n \"crowDistance\": \"2000\",\n \"crowDistanceUnit\": \"METERS\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{registered-webhook-url}}"},"status":"Created","code":201,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"4d81d075-8445-4917-8be4-3f31640c2f5e","name":"At Service Hub Fuel Example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text","description":"Received from authentication endpoint","disabled":true},{"key":"x-api-key","value":"{{x-api-key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"status\": \"AT_SERVICE_HUB\",\n \"driverId\": \"dri_123123\",\n \"vin\": \"TSTLRGBL663PR2127\",\n \"sessionId\": \"fuel_xab12345\",\n \"vehicleLocation\": \"40.885482,-74.007431\",\n \"serviceHub\": {\n \"id\": \"fst_380a228fd332746cadc3\",\n \"streetAddress\": \"Aarey Colony, Goregaon\",\n \"city\": \"Mumbai\",\n \"state\": \"Maharashtra\",\n \"zipCode\": \"400065\",\n \"country\": \"India\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{registered-webhook-url}}"},"status":"Created","code":201,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"41f8bc83-604b-4cea-8226-2933c0a87b36","name":"Low Charge Alert Example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text","description":"Received from authentication endpoint","disabled":true},{"key":"x-api-key","value":"{{x-api-key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"status\": \"LOW_CHARGE_DETECTED\",\n \"driverId\": \"dri_223124\",\n \"vin\": \"TSTLRGBL663PR2128\",\n \"vehicleLocation\": \"40.885482,-74.007431\",\n \"serviceHubs\": [\n {\n \"id\": \"cst_380a228fd332746cadc3\",\n \"displayName\": \"IOCL Charging Station\",\n \"addressDetails\": {\n \"streetAddress\": \"Aarey Colony, Goregaon\",\n \"city\": \"Mumbai\",\n \"state\": \"Maharashtra\",\n \"zipCode\": \"400065\",\n \"country\": \"India\"\n },\n \"crowDistance\": \"1200\",\n \"crowDistanceUnit\": \"METERS\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{registered-webhook-url}}"},"status":"Created","code":201,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"db76c0f1-51c0-4b48-abd2-de6b2c8a5eb9"},{"name":"Get Registered Web Hooks","id":"899d9ac3-e23b-42fe-a4c8-dfc8a65b0932","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"url":"{{host}}/v2/partner-apis/webhooks","urlObject":{"path":["v2","partner-apis","webhooks"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"4e8c8090-9564-43d9-9d11-b5a1e9db0e18","name":"Get Registered Web Hooks","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text","description":"Received from authentication endpoint"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"url":"{{host}}/v2/partner-apis/webhooks"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"webh_4242424242522\", //Sheeva Assigned ID\n \"type\" : \"status-updates\",\n \"webhookUrl\": {{registered-webhook-url}}, // Full URL for callback. Mandatory.\n \"hmacSigningKey\": \"f7bc83f430538424b13298e6aa6fb143ef4d59a14946175997479dbc2d1a3cd8\", // Secret Key. Mandatory.\n \"apikey\": \"af75e1f0-f472-48bb-83b2-35541dc860dd\" // Authentication Api key. Optional.\n }\n]"}],"_postman_id":"899d9ac3-e23b-42fe-a4c8-dfc8a65b0932"},{"name":"Delete a Web Hook","id":"7d42d36a-963f-4e4b-a9e9-a9071db2170e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"url":"{{host}}/v2/partner-apis/webhooks/{{webhook-id}}","urlObject":{"path":["v2","partner-apis","webhooks","{{webhook-id}}"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"69102ab1-53be-4890-ab92-7ab57fd97965","name":"Delete a Web Hook","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text","description":"Received from authentication endpoint"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"url":"{{host}}/v2/partner-apis/webhooks/{{webhook-id}}"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"7d42d36a-963f-4e4b-a9e9-a9071db2170e"}],"id":"0a3f4756-5d56-41e6-8798-83bc50037e03","description":"SheevaConnect supports various webhooks for callbacks for various status updates.
\n","_postman_id":"0a3f4756-5d56-41e6-8798-83bc50037e03"},{"name":"Loyalty","item":[{"name":"Get Available Programs","id":"3888429a-d05b-4973-b654-0810bc32868b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"url":"{{host}}/v2/partner-apis/loyalty-programs?serviceType=FUEL&serviceProviderCode=IOCL","urlObject":{"path":["v2","partner-apis","loyalty-programs"],"host":["{{host}}"],"query":[{"description":{"content":"Service Type FUEL/PARKING/CHARGING (Optional)
\n","type":"text/plain"},"key":"serviceType","value":"FUEL"},{"description":{"content":"Service Provider Code - Example IOCL(Optional)
\n","type":"text/plain"},"key":"serviceProviderCode","value":"IOCL"}],"variable":[]}},"response":[{"id":"32bc0383-141c-4b27-bcc6-85927dbbfecb","name":"Get Available Programs Example1","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text","description":"Received from authentication endpoint"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"url":{"raw":"{{host}}/v2/partner-apis/loyalty-programs?serviceType=FUEL&serviceProviderCode=IOCL","host":["{{host}}"],"path":["v2","partner-apis","loyalty-programs"],"query":[{"key":"serviceType","value":"FUEL","description":"Optional"},{"key":"serviceProviderCode","value":"IOCL","description":"Optional"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"loyalty_123456\",\n \"name\": \"SheevaRewards\",\n \"organization\": \"IOCL\", //Deprecated\n \"serviceProviderCode\":\"IOCL\",\n \"serviceProviderName\":\"Indian Oil Corporation\",\n \"scheme\": \"PointBasedRewards\",\n \"redemptionRules\": {\n \"minPoints\": 100,\n \"network\": \"Sheeva/IOCL\"\n },\n \"conversionRule\": {\n \"redeem\": \"200\",\n \"redeemCurrency\": \"POINTS\",\n \"exchangeRatio\": 1,\n \"exchangeCurrency\": \"INR\",\n \"displayText\": \"Redeem 200 Points for Rs. 1\"\n },\n \"earningRule\": {\n \"spend\": 100,\n \"spendCurrency\": \"INR\",\n \"earn\": 1,\n \"earnCurrency\": \"POINTS\",\n \"displayText\": \"For every Rs. 100 spent, earn 1 Point(s)\"\n }\n }\n]"}],"_postman_id":"3888429a-d05b-4973-b654-0810bc32868b"},{"name":"Get My Programs","id":"637d51f4-0c4c-40b3-905c-f32b77aa7896","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"url":"{{host}}/v2/partner-apis/loyalty-programs?driverId={{driverId}}&serviceType=FUEL&serviceProviderCode=IOCL","urlObject":{"path":["v2","partner-apis","loyalty-programs"],"host":["{{host}}"],"query":[{"description":{"content":"Partner assigned unique ID [Mandatory]
\n","type":"text/plain"},"key":"driverId","value":"{{driverId}}"},{"description":{"content":"Service Type FUEL/PARKING/CHARGING (Optional)
\n","type":"text/plain"},"key":"serviceType","value":"FUEL"},{"description":{"content":"Service Provider Code - Example IOCL(Optional)
\n","type":"text/plain"},"key":"serviceProviderCode","value":"IOCL"}],"variable":[]}},"response":[{"id":"5ea8819f-1d16-47f0-b8ec-e9b2b29be031","name":"Get My Programs Example1","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text","description":"Received from authentication endpoint"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"url":{"raw":"{{host}}/v2/partner-apis/loyalty-programs?driverId=dri_1dgKow3CMM6kObW6z5s9&serviceType=FUEL&serviceProviderCode=IOCL","host":["{{host}}"],"path":["v2","partner-apis","loyalty-programs"],"query":[{"key":"driverId","value":"dri_1dgKow3CMM6kObW6z5s9","description":"Partner assigned unique ID [Mandatory]"},{"key":"serviceType","value":"FUEL","description":"Optional"},{"key":"serviceProviderCode","value":"IOCL","description":"Optional"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"loyaltyMembershipId\": \"LY100123418489768\",\n \"availablePoints\": 1.0,\n \"id\": \"iocl_xtrarewards\",\n \"name\": \"IOCL Xtrarewards\",\n \"organization\": \"Indian Oil Corporation Ltd\",\n \"serviceProviderCode\": \"IOCL\",\n \"serviceProviderName\": \"Indian Oil Corporation Ltd\",\n \"scheme\": \"PointBasedRewards\",\n \"balance\": {\n \"points\": 800,\n \"amount\": 50,\n \"currency\": \"INR\"\n },\n \"redemptionRules\": {\n \"minPoints\": 50.0,\n \"network\": \"IOCL\"\n },\n \"conversionRule\": {\n \"redeem\": 50.0,\n \"exchangeRatio\": 0.3,\n \"redeemCurrency\": \"POINTS\",\n \"exchangeCurrency\": \"INR\",\n \"displayText\": \"Redeem 50 Points for Rs. 15\"\n },\n \"earningRule\": {\n \"spend\": 75.0,\n \"earn\": 1.0,\n \"spendCurrency\": \"INR\",\n \"earnCurrency\": \"POINTS\",\n \"displayText\": \"For every Rs. 75 spent, earn 1 Point(s)\"\n }\n }\n]"}],"_postman_id":"637d51f4-0c4c-40b3-905c-f32b77aa7896"},{"name":"Sign up for a program","id":"de973840-cdcb-4fd9-9165-278bd6ced488","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"driverId\": \"{{driverId}}\", // Mandaotory. Partner Assigned Driver Identifier.\n \"loyaltyProgramId\": \"{{loyaltyProgramId}}\" // Mandatory. Loyalty Program Identifier, id field retrieved from Get Available Programs\n}\n","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/partner-apis/loyalty-programs","urlObject":{"path":["v2","partner-apis","loyalty-programs"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"0b12aed4-1e76-4c94-a6f3-79452e3aedfa","name":"Sign up for a program example1","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text","description":"Received from authentication endpoint"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"driverId\": \"dri_1dgKow3CMM6kObW6z5s9\", // Mandaotory. Partner Assigned Driver Identifier.\n \"loyaltyProgramId\": \"loyalty_4334324\" // Mandatory. Loyalty Program Identifier, id field retrieved from Get Available Programs\n}\n","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/partner-apis/loyalty-programs"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"Registration Successful!"}],"_postman_id":"de973840-cdcb-4fd9-9165-278bd6ced488"},{"name":"Calculate Rewards (Amount)","id":"9e32bfcd-dd35-42ac-b0ed-134911b96af2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-sheeva-program-code","value":"{{programCode}}"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{accessToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"iocl_xtrarewards\", // loyalty program id\n \"rewardPoints\": 123.43\n}"},"url":"{{host}}/v2/partner-apis/loyalty-programs/convert-my-points","urlObject":{"path":["v2","partner-apis","loyalty-programs","convert-my-points"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"ea68d57b-2ba4-4c0e-be42-34c8a715d7cf","name":"Calculate Rewards (Amount)","originalRequest":{"method":"POST","header":[{"key":"x-sheeva-program-code","value":"{{programCode}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"iocl-xtrarewards\", // loyalty program id\n \"rewardPoints\": 123.43\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/partner-apis/loyalty-programs/convert-my-points"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"iocl-xtrarewards\",\n \"rewardPoints\": 123.43,\n \"amount\": 35.4,\n \"currency\": \"INR\"\n}"}],"_postman_id":"9e32bfcd-dd35-42ac-b0ed-134911b96af2"}],"id":"1210d2b9-f890-4466-a691-853d62270d05","_postman_id":"1210d2b9-f890-4466-a691-853d62270d05","description":""},{"name":"Feedback","item":[{"name":"Get Cancellation Reasons","id":"f8afc047-c746-4d09-8c17-4eb61ad60bd4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{accessToken}}","type":"text"},{"key":"x-sheeva-program-code","value":"{{programCode}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/partner-apis/feedback/reasons?serviceType=UBI_PAYMENTS","description":"This request allows registering an HTTP POST status webhook with SeevaConnect.
\nIf successful, returns: HTTP 201 CREATED.
\nExamples below demonstrate the json body Sheeva will call your registered webhook endpoint with:
\nSheevaConnect supports various webhooks for callbacks for various status updates.
\n","_postman_id":"694a17d6-c9a5-4d28-9497-a2ebdb6adfee"},{"name":"Advertisements","item":[],"id":"0f7f21fd-9cbd-41ac-8131-107d210091a7","_postman_id":"0f7f21fd-9cbd-41ac-8131-107d210091a7","description":""},{"name":"Promotions","item":[],"id":"38fb416e-4d31-48a8-94f6-04badd41f7c8","_postman_id":"38fb416e-4d31-48a8-94f6-04badd41f7c8","description":""},{"name":"Discounts","item":[],"id":"9f97ef96-7b11-4b0a-80e2-fbd0635c5178","_postman_id":"9f97ef96-7b11-4b0a-80e2-fbd0635c5178","description":""}],"variable":[{"key":"serviceType","value":"FUEL"},{"key":"serviceProviderCode","value":"IOCL"}]}