{"info":{"_postman_id":"f04c24cb-d018-4467-8bc0-f664df7cffa8","name":"MedPay APIs","description":"

Welcome to MedPay Health API!

We believe in having open and accessible APIs for healthcare that empower our partners to deliver world-class patient experiences by leveraging our Connected Care Network of Healthcare Providers.
Our API platform is central to our business connecting Providers with Patients and Payers for service fulfilments and digital transactions. We’re excited for you to get started and we hope your integration experience is smooth.

Please refer to this chart for a pictorial representation of the workflows supported by MedPay for Pharmacy, Consultations(Online and Offline) and Diagnostics(Online/Home-pickup and Offline/Self-visit).

If you have any questions, please reach out to techsupport@medpay.in

The API is organised around REST. All requests should be made over SSL. All requests and responses bodies, including errors, are encoded in JSON.

Please find the MedPay Error Codes tabulated here.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"20123811","collectionId":"f04c24cb-d018-4467-8bc0-f664df7cffa8","publishedId":"2s9YXmXLMN","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-11-14T04:54:22.000Z"},"item":[{"name":"00- Authentication","item":[{"name":"Request Access Token","id":"43202fdd-745e-454c-b4ac-b73b6ec787fa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{client_id}}"},{"key":"password","value":"{{client_secret}}"}],"advancedConfig":[{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"client_credentials","type":"text"}]},"url":"{{auth_host}}/oauth2/token","description":"

This endpoint is used to exchange the client_id (username) and client_secret (password) provided during Partner Onboarding for an access_token.

All Partner APIs are protected and can only be accessed using a valid access_token\nThis access token & x-api-key must be set as headers while accessing any Partner API, as follows:

 Authorization: Bearer {{access_token}}

 x-api-key: {{x-api-key}}

","urlObject":{"path":["oauth2","token"],"host":["{{auth_host}}"],"query":[],"variable":[]}},"response":[{"id":"bda4ce5a-37be-452a-b6d0-77120f500479","name":"Successful Authentication","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"client_credentials","type":"text"}]},"url":"https://{{auth_host}}/oauth2/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 30 Apr 2021 10:14:49 GMT"},{"key":"x-amz-cognito-request-id","value":"449c963e-e4d5-4872-bc99-7b29e68440db"},{"key":"X-Application-Context","value":"application:prod:8443"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Server","value":"Server"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 3aa04eb5ac8ae26679166353cb2bc20b.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"DEL54-C1"},{"key":"X-Amz-Cf-Id","value":"Xo8SNCV5TxN3IvmpQ_v_L1r23SmWiq64nPJ6eUUTWNXEUCDoLoAapQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"eyJraWQiOiJDT3g0TSt2TWRISU8xY2UyV2ljXC9haHM4bFRJTTM5dFdUSElWU25ramkzND0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiIxMDBhZ3FyZnNpdnI3Y2trdDh2NjM2ZmRvIiwidG9rZW5fdXNlIjoiYWNjZXNzIiwic2NvcGUiOiJvYXV0aFwvb2F1dGgucmVhZCIsImF1dGhfdGltZSI6MTYxOTc3NzY4OSwiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmFwLXNvdXRoLTEuYW1hem9uYXdzLmNvbVwvYXAtc291dGgtMV92UEFDd0RPckMiLCJleHAiOjE2MTk3ODEyODksImlhdCI6MTYxOTc3NzY4OSwidmVyc2lvbiI6MiwianRpIjoiNjY0OGUyZmMtZGUzMi00MTM2LTg0NTItZmMxN2E2NTBjOTZmIiwiY2xpZW50X2lkIjoiMTAwYWdxcmZzaXZyN2Nra3Q4djYzNmZkbyJ9.fcDdivyWaHdK7yoy_J6v-1dvTRDAeVvmMtz8SejJ-aMPF9dm_G3mcjJuHgqNj4kdN-KMNUyph5diGM-ToyxjbsNJjj4KPHEVzHeof9YCSNgGhNaW85I8Uo8IRHqjJhrNq8Yu_gmMFB-g0EuUCcJvLnSxoK54b2xceR_8iKUpk8tnXS0IMEgHjaLRjralE1IhtU7EVM5OJ6aS68_W4VR1nPOiTvq_jI8Lec4W2fMiPk7lt735v4TU2aIi9hWAyKB1VDjGnl9VPHsm1vQ7EOT0GgX1tKBaJ6_M78yW-L1n7ldjPQ3XY3fAS7GR1wA9ZHryd6wROABy7dyEDBfj-T--ZQ\",\n \"expires_in\": 3600,\n \"token_type\": \"Bearer\"\n}"},{"id":"ff6ebb00-ae50-4799-9a2a-371927bae841","name":"Error - Invalid Client","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"client_credentials","type":"text"}]},"url":"https://{{auth_host}}/oauth2/token"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Fri, 30 Apr 2021 10:13:30 GMT"},{"key":"x-amz-cognito-request-id","value":"789b8a91-3615-47fe-b82a-b5da2497d47e"},{"key":"X-Application-Context","value":"application:prod:8443"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Server","value":"Server"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 3aa04eb5ac8ae26679166353cb2bc20b.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"DEL54-C1"},{"key":"X-Amz-Cf-Id","value":"VEYRdVJWA_U3LdMm3d_4pXkcjNaN7ueZtA97LZZlhVWNUrIMcM-XhA=="}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"invalid_client\"\n}"}],"_postman_id":"43202fdd-745e-454c-b4ac-b73b6ec787fa"}],"id":"eef6f266-7f49-4064-9b18-a051bd609163","description":"

Leverage OAuth2's client-credentials grant flow to ensure a secure integration with the MedPay API.

Upon onboarding, a partner app is assigned a unique Client ID and Client Secret which will be used in the OAuth flow. The Client Secret should not be shared.

Diving In

MedPay provides a flexible and secure way for our clients to integrate with the MedPay API by using the OAuth2 client-credentials grant flow.

\n\n

In this flow, clients will receive a client_id and client_secret that will be exchanged at the MedPay token endpoint for a temporary Bearer access token. This access token, along with the issued API Key, will provide access to the MedPay API until the token expires.

Since the access token is short-lived, auto-retry logic will need to be added to ensure that an active Bearer token is always used.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"a36af044-1c84-413c-9986-45d591757a8c"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"00680bf4-9811-4b5a-9bf9-8946742ad229"}}],"_postman_id":"eef6f266-7f49-4064-9b18-a051bd609163"},{"name":"01- Pharmacy","item":[{"name":"Online: Home Delivery","item":[{"name":"Pincode Serviceability","id":"d6b7e23b-4578-4ff5-82d9-1eca08f950e3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"url":"{{host_url}}/partner/pharmacy/pincode/{{pincode}}","description":"

Pin Code Serviceability API can be used to find out if the given pin code is serviceable or not. We recommend using this API first before using Create Order API to ensure that the patient's location can be served by our Connected Care Network.

Path Params:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Param	Description	Type	Format/Values
`pincode` (required)	Pincode	String	E.g \"560102\"

","urlObject":{"path":["partner","pharmacy","pincode","{{pincode}}"],"host":["{{host_url}}"],"query":[],"variable":[]}},"response":[{"id":"45f86211-7ae3-4d13-b51f-a4fcf862e2b8","name":"Success - Serviceable","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"url":"{{host_url}}/partner/pharmacy/pincode/560102"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"area is serviceable\",\n \"response\": {\n \"pin_code\": \"560102\",\n \"serviceable\": true\n }\n}"},{"id":"6c696e7d-e4f4-4bae-9856-68561d24d757","name":"Error - Not serviceable","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"url":"{{host_url}}/partner/pharmacy/pincode/122001"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"area is not serviceable\",\n \"response\": {\n \"pin_code\": \"122001\",\n \"serviceable\": false\n }\n}"}],"_postman_id":"d6b7e23b-4578-4ff5-82d9-1eca08f950e3"},{"name":"Search SKU","id":"babea4b6-f483-4cb5-aec2-3bd52696cc9e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"url":"{{host_url}}/partner/pharmacy/skus/online/search?partner_name={{partner_name}}&name=Ecosprin Av 75 Caps","description":"

Enhance the user experience of searching for a medicine/product by integrating the Search SKU API in your application. This ultrafast search-as-you-type API is powered by Elastic Search on the backend to provide low latency results.

Path Params:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Param	Description	Type	Format/Values
`name` (required)	String to be searched in the SKU inventory	String
`type` (optional)	SKU Type	String	It can be either \"medicine\" or \"fmcg\"
`category` (optional)	SKU category under a particular SKU Type	String	Different types has different categories

","urlObject":{"path":["partner","pharmacy","skus","online","search"],"host":["{{host_url}}"],"query":[{"key":"partner_name","value":"{{partner_name}}"},{"key":"name","value":"Ecosprin Av 75 Caps"}],"variable":[]}},"response":[{"id":"37b49aa4-dc87-4c69-94b0-1191e0975017","name":"Success - Medicine","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host_url}}/partner/pharmacy/skus/online/search?name=amox&type=medicine&category=allopathy","host":["{{host_url}}"],"path":["partner","pharmacy","skus","online","search"],"query":[{"key":"name","value":"amox"},{"key":"type","value":"medicine"},{"key":"category","value":"allopathy"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 24 Aug 2021 09:01:45 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"3835"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"61ec2a32-ae7c-452d-a4a2-1156c4f5cf4d"},{"key":"x-amz-apigw-id","value":"EkFK8EQEhcwFoug="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6124b579-029a6635321d0c80142c33af"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"skus found\",\n \"response\": [\n {\n \"sku_id\": \"282694\",\n \"type\": \"Medicine\",\n \"name\": \"Amoxgentin 1000mg Tab\",\n \"mfr\": \"Taj Pharma India Limited\",\n \"mrp\": 145,\n \"drug_form\": \"Tablets\",\n \"pack_form\": \"Strip\",\n \"pack_quantity\": 10,\n \"pack_qty_label\": \"strip of 10 tablets\",\n \"rx_required\": \"yes\",\n \"composition\": \"Amoxycillin (1000mg)\",\n \"category\": [\n \"Allopathy\"\n ],\n \"sub_category2\": \"Broad Spectrum Penicillins\"\n },\n {\n \"sku_id\": \"282348\",\n \"type\": \"Medicine\",\n \"name\": \"Amoxydase Forte Caps\",\n \"mfr\": \"Chemech Laboratories Limited\",\n \"mrp\": 65,\n \"drug_form\": \"Capsules\",\n \"pack_form\": \"Strip\",\n \"pack_quantity\": 10,\n \"pack_qty_label\": \"strip of 10 capsules\",\n \"rx_required\": \"yes\",\n \"composition\": \"Amoxycillin (500mg) + Serratiopeptidase (5mg) + Lactobacillus (60Million cells)\",\n \"category\": [\n \"Allopathy\"\n ],\n \"sub_category2\": \"Broad Spectrum Penicillins\"\n },\n {\n \"sku_id\": \"281749\",\n \"type\": \"Medicine\",\n \"name\": \"Amoxyn P 125mg Tab\",\n \"mfr\": \"Saga Laboratories\",\n \"mrp\": 19.5,\n \"drug_form\": \"Tablets\",\n \"pack_form\": \"Strip\",\n \"pack_quantity\": 10,\n \"pack_qty_label\": \"strip of 10 tablets\",\n \"rx_required\": \"yes\",\n \"composition\": \"Amoxycillin (125mg)\",\n \"category\": [\n \"Allopathy\"\n ],\n \"sub_category2\": \"Broad Spectrum Penicillins\"\n },\n {\n \"sku_id\": \"281554\",\n \"type\": \"Medicine\",\n \"name\": \"Amoxydial 250mg Tab\",\n \"mfr\": \"Remedial Healthcare\",\n \"mrp\": 42.6,\n \"drug_form\": \"Tablets\",\n \"pack_form\": \"Strip\",\n \"pack_quantity\": 10,\n \"pack_qty_label\": \"strip of 10 tablets\",\n \"rx_required\": \"yes\",\n \"composition\": \"Amoxycillin (250mg)\",\n \"category\": [\n \"Allopathy\"\n ],\n \"sub_category2\": \"Broad Spectrum Penicillins\"\n },\n {\n \"sku_id\": \"281280\",\n \"type\": \"Medicine\",\n \"name\": \"Amoxylla Dry Syrup\",\n \"mfr\": \"Skylla Pharmaceuticals\",\n \"mrp\": 57.47,\n \"drug_form\": \"Suspension\",\n \"pack_form\": \"Bottle\",\n \"pack_quantity\": 1,\n \"pack_qty_label\": \"bottle of 30 ml Oral Suspension\",\n \"rx_required\": \"yes\",\n \"composition\": \"Amoxycillin (200mg) + Clavulanic Acid (28.5mg)\",\n \"category\": [\n \"Allopathy\"\n ],\n \"sub_category2\": \"Broad Spectrum Penicillins\"\n },\n {\n \"sku_id\": \"280969\",\n \"type\": \"Medicine\",\n \"name\": \"Amoxinat 250mg Caps\",\n \"mfr\": \"Natco Pharma Limited\",\n \"mrp\": 54.9,\n \"drug_form\": \"Capsules\",\n \"pack_form\": \"Strip\",\n \"pack_quantity\": 15,\n \"pack_qty_label\": \"strip of 15 capsules\",\n \"rx_required\": \"yes\",\n \"composition\": \"Amoxycillin (250mg)\",\n \"category\": [\n \"Allopathy\"\n ],\n \"sub_category2\": \"Broad Spectrum Penicillins\"\n },\n {\n \"sku_id\": \"280873\",\n \"type\": \"Medicine\",\n \"name\": \"Amoxrag Syrup\",\n \"mfr\": \"Auriga Labs\",\n \"mrp\": 70,\n \"drug_form\": \"Syrup\",\n \"pack_form\": \"Bottle\",\n \"pack_quantity\": 1,\n \"pack_qty_label\": \"bottle of 30 ml Syrup\",\n \"rx_required\": \"yes\",\n \"composition\": \"Amoxycillin (200mg) + Clavulanic Acid (28.5mg)\",\n \"category\": [\n \"Allopathy\"\n ],\n \"sub_category2\": \"Broad Spectrum Penicillins\"\n }\n ]\n}"},{"id":"0ab0f956-643d-49cb-a179-63041bdb0a95","name":"Success - FMCG","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"url":{"raw":"{{host_url}}/partner/pharmacy/skus/online/search?name=pantene&type=fmcg","host":["{{host_url}}"],"path":["partner","pharmacy","skus","online","search"],"query":[{"key":"name","value":"pantene"},{"key":"type","value":"fmcg"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 01 Apr 2022 09:32:05 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"5907"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"0dc01c79-9a74-4d72-ab08-fa48f3b4a071"},{"key":"x-amz-apigw-id","value":"P5P3TFgfBcwFUkQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6246c694-48b9a67f5057c17d654021b2"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"skus found\",\n \"response\": [\n {\n \"sku_id\": \"375570\",\n \"type\": \"Fmcg\",\n \"name\": \"Pantene Pro-V Advanced Hairfall Solution Hairfall Control Conditioner\",\n \"mfr\": \"Pantene\",\n \"mrp\": 180,\n \"drug_form\": \"Conditioner\",\n \"pack_form\": \"Tube\",\n \"pack_quantity\": 1,\n \"pack_qty_label\": \"tube of 180 ml Conditioner\",\n \"rx_required\": \"no\",\n \"composition\": \"\",\n \"category\": [\n \"Monsoon Store\",\n \"Hair Care\"\n ],\n \"sub_category2\": \"\"\n },\n {\n \"sku_id\": \"375505\",\n \"type\": \"Fmcg\",\n \"name\": \"Pantene Pro-V Advanced Haircare Solution Lively Clean Shampoo\",\n \"mfr\": \"Pantene\",\n \"mrp\": 550,\n \"drug_form\": \"Shampoo\",\n \"pack_form\": \"Pump Bottle\",\n \"pack_quantity\": 1,\n \"pack_qty_label\": \"pump bottle of 650 ml Shampoo\",\n \"rx_required\": \"no\",\n \"composition\": \"\",\n \"category\": [\n \"Monsoon Store\",\n \"Hair Care\"\n ],\n \"sub_category2\": \"\"\n },\n {\n \"sku_id\": \"375420\",\n \"type\": \"Fmcg\",\n \"name\": \"Pantene Pro-V Advanced Hairfall Solution Silky Smooth Care Shampoo\",\n \"mfr\": \"Pantene\",\n \"mrp\": 225,\n \"drug_form\": \"Shampoo\",\n \"pack_form\": \"Bottle\",\n \"pack_quantity\": 1,\n \"pack_qty_label\": \"bottle of 340 ml Shampoo\",\n \"rx_required\": \"no\",\n \"composition\": \"\",\n \"category\": [\n \"Monsoon Store\",\n \"Hair Care\"\n ],\n \"sub_category2\": \"\"\n },\n {\n \"sku_id\": \"375176\",\n \"type\": \"Fmcg\",\n \"name\": \"Pantene Pro-V Advanced Hairfall Solution Silky Smooth Care Conditioner\",\n \"mfr\": \"Pantene\",\n \"mrp\": 180,\n \"drug_form\": \"Conditioner\",\n \"pack_form\": \"Tube\",\n \"pack_quantity\": 1,\n \"pack_qty_label\": \"tube of 180 ml Conditioner\",\n \"rx_required\": \"no\",\n \"composition\": \"\",\n \"category\": [\n \"Monsoon Store\",\n \"Hair Care\"\n ],\n \"sub_category2\": \"\"\n },\n {\n \"sku_id\": \"425521\",\n \"type\": \"Fmcg\",\n \"name\": \"Pantene Pro-V Advanced Hairfall Solution Silky Smooth Care Shampoo\",\n \"mfr\": \"Pantene\",\n \"mrp\": 600,\n \"drug_form\": \"Shampoo\",\n \"pack_form\": \"Pump Bottle\",\n \"pack_quantity\": 1,\n \"pack_qty_label\": \"pump bottle of 1 Ltr Shampoo\",\n \"rx_required\": \"no\",\n \"composition\": \"\",\n \"category\": [\n \"Hair Care\"\n ],\n \"sub_category2\": \"\"\n },\n {\n \"sku_id\": \"375713\",\n \"type\": \"Fmcg\",\n \"name\": \"Pantene Pro-V Advanced Hairfall Solution Silky Smooth Care Shampoo\",\n \"mfr\": \"Pantene\",\n \"mrp\": 60,\n \"drug_form\": \"Shampoo\",\n \"pack_form\": \"Bottle\",\n \"pack_quantity\": 1,\n \"pack_qty_label\": \"bottle of 75 ml Shampoo\",\n \"rx_required\": \"no\",\n \"composition\": \"\",\n \"category\": [\n \"Monsoon Store\",\n \"Hair Care\"\n ],\n \"sub_category2\": \"\"\n },\n {\n \"sku_id\": \"375692\",\n \"type\": \"Fmcg\",\n \"name\": \"Pantene Pro-V Advanced Hairfall Solution Long Black Shampoo\",\n \"mfr\": \"Pantene\",\n \"mrp\": 60,\n \"drug_form\": \"Shampoo\",\n \"pack_form\": \"Bottle\",\n \"pack_quantity\": 1,\n \"pack_qty_label\": \"bottle of 75 ml Shampoo\",\n \"rx_required\": \"no\",\n \"composition\": \"\",\n \"category\": [\n \"Monsoon Store\",\n \"Hair Care\"\n ],\n \"sub_category2\": \"\"\n },\n {\n \"sku_id\": \"375599\",\n \"type\": \"Fmcg\",\n \"name\": \"Pantene Pro-V Advanced Hairfall Solution Total Damage Care Shampoo\",\n \"mfr\": \"Pantene\",\n \"mrp\": 225,\n \"drug_form\": \"Shampoo\",\n \"pack_form\": \"Bottle\",\n \"pack_quantity\": 1,\n \"pack_qty_label\": \"bottle of 340 ml Shampoo\",\n \"rx_required\": \"no\",\n \"composition\": \"\",\n \"category\": [\n \"Monsoon Store\",\n \"Hair Care\"\n ],\n \"sub_category2\": \"\"\n },\n {\n \"sku_id\": \"375576\",\n \"type\": \"Fmcg\",\n \"name\": \"Pantene Pro-V Advanced Haircare Solution Lively Clean Shampoo\",\n \"mfr\": \"Pantene\",\n \"mrp\": 120,\n \"drug_form\": \"Shampoo\",\n \"pack_form\": \"Bottle\",\n \"pack_quantity\": 1,\n \"pack_qty_label\": \"bottle of 200 ml Shampoo\",\n \"rx_required\": \"no\",\n \"composition\": \"\",\n \"category\": [\n \"Monsoon Store\",\n \"Hair Care\"\n ],\n \"sub_category2\": \"\"\n },\n {\n \"sku_id\": \"375551\",\n \"type\": \"Fmcg\",\n \"name\": \"Pantene Pro-V Advanced Hairfall Solution Silky Smooth Care Conditioner\",\n \"mfr\": \"Pantene\",\n \"mrp\": 85,\n \"drug_form\": \"Conditioner\",\n \"pack_form\": \"Tube\",\n \"pack_quantity\": 1,\n \"pack_qty_label\": \"tube of 80 ml Conditioner\",\n \"rx_required\": \"no\",\n \"composition\": \"\",\n \"category\": [\n \"Monsoon Store\",\n \"Hair Care\"\n ],\n \"sub_category2\": \"\"\n }\n ]\n}"},{"id":"f88c3aac-0207-4a31-a7f5-4823e7869058","name":"No Results","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host_url}}/partner/pharmacy/skus/online/search?name=zzz&type=medicine&category=allopathy","host":["{{host_url}}"],"path":["partner","pharmacy","skus","online","search"],"query":[{"key":"name","value":"zzz"},{"key":"type","value":"medicine"},{"key":"category","value":"allopathy"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 24 Aug 2021 09:03:29 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"79"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"e1e2795b-79d0-45e5-8468-57eed48cb01e"},{"key":"x-amz-apigw-id","value":"EkFbPGTlBcwFkAA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6124b5e1-72ca1f8f1307e0ae7fae439f"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"failed\",\n \"message\": \"no sku found!\",\n \"response\": {}\n}"}],"_postman_id":"babea4b6-f483-4cb5-aec2-3bd52696cc9e"},{"name":"Fetch SKU Details","id":"46a72fdb-103c-4b15-a389-bf0b0b06a283","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"url":"{{host_url}}/partner/pharmacy/skus/online/sku?sku_id=235078,485619,521338","description":"

Fetch details of any SKU in our inventory by calling SKU Details API. The maximum number of SKUs that can be fetched in a single request is 10.

Note: In case the partners offer any pre-determined discount to the customers for medicines or FMCG products, this will be reflected in the discounted_price field in the response. For example, if a partner offers a 10% discount on a medicine of MRP Rs. 100, the API response will have two fields: mrp: 100 and discounted_price: 90

In order to display these discounted prices, the query parameters partner_name has to be provided.

Note: In case an SKU is not available for sale online, the status field will reflect the reason and its MRP will be marked as 0. These SKUs will not be allowed during order creation.

Possible values for status are: available, banned for sale, not for sale, discontinued

Query Params:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Param	Description	Type	Format/Values
`sku_ids` (required)	Comma separated string of SKU ids	String	Eg. 272652,155000
`partner_name` (optional)	Partner name	String	Must be provided to get details of discounted price.

","urlObject":{"path":["partner","pharmacy","skus","online","sku"],"host":["{{host_url}}"],"query":[{"key":"sku_id","value":"235078,485619,521338"}],"variable":[]}},"response":[{"id":"8051fa09-0624-459c-8a28-2054f52ee14d","name":"Success - SKUs available","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"jIUnbJiwmr4ce7qrmAHdXsCOnxcwdBY6B6f324p3","type":"text"}],"url":{"raw":"https://api.uat.medpay.in/v1/partner/pharmacy/skus/online/sku?sku_id=235078,485619,521338&partner_name=testpartner","protocol":"https","host":["api","uat","medpay","in"],"path":["v1","partner","pharmacy","skus","online","sku"],"query":[{"key":"sku_id","value":"235078,485619,521338"},{"key":"partner_name","value":"testpartner"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 20 Feb 2023 10:24:53 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"806"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"cfbae787-7109-4516-a825-5255d44f6fb4"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"AoiSWGY1hcwFsoA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-63f34a75-2015b06e09e14a5d282ee9dd"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"response\": [\n {\n \"pack_quantity\": 1,\n \"sku_id\": \"235078\",\n \"sub_category\": [\n \"Ophthalmology,Health Conditions\"\n ],\n \"status\": \"available\",\n \"mrp\": 395.0,\n \"name\": \"Symhylo 1% Eye Drop\",\n \"drug_form\": \"Drop\",\n \"pack_qty_label\": \"bottle of 10 ml Eye Drop\",\n \"sub_category2\": \"Ophthalmological Anti Infectives Medicines\",\n \"category\": [\n \"Allopathy\"\n ],\n \"images\": {\n \"700\": [\n \"https://images.medpay.in/_700/mp235078_1.webp\",\n \"https://images.medpay.in/_700/mp235078_2.webp\",\n \"https://images.medpay.in/_700/mp235078_3.webp\",\n \"https://images.medpay.in/_700/mp235078_4.webp\",\n \"https://images.medpay.in/_700/mp235078_5.webp\"\n ]\n },\n \"composition\": \"Sodium Hyaluronate (1% w/v)\",\n \"mfr\": \"Berry & Herbs Pharma Private Limited\",\n \"rx_required\": \"no\",\n \"pack_form\": \"bottle\",\n \"type\": \"Medicine\",\n \"discounted_price\": 355.5\n },\n {\n \"pack_quantity\": 10,\n \"sku_id\": \"485619\",\n \"sub_category\": [\n \"\"\n ],\n \"status\": \"available\",\n \"mrp\": 199.8,\n \"name\": \"Mecovon OD Capsule\",\n \"drug_form\": \"capsules\",\n \"pack_qty_label\": \"strip of 10 capsules\",\n \"sub_category2\": \"\",\n \"category\": [\n \"Vitamins & Nutrition\",\n \"Allopathy\"\n ],\n \"images\": {\n \"700\": [\n \"https://images.medpay.in/_700/mp485619_1.webp\",\n \"https://images.medpay.in/_700/mp485619_2.webp\",\n \"https://images.medpay.in/_700/mp485619_3.webp\",\n \"https://images.medpay.in/_700/mp485619_4.webp\",\n \"https://images.medpay.in/_700/mp485619_5.webp\",\n \"https://images.medpay.in/_700/mp485619_6.webp\"\n ]\n },\n \"composition\": \"\",\n \"mfr\": \"Zuventus Healthcare Limited\",\n \"rx_required\": \"no\",\n \"pack_form\": \"strip\",\n \"type\": \"Medicine\",\n \"discounted_price\": 179.82\n },\n {\n \"pack_quantity\": 10,\n \"sku_id\": \"521338\",\n \"sub_category\": [\n \"\"\n ],\n \"status\": \"available\",\n \"mrp\": 172.0,\n \"name\": \"Unilastine M 20mg/10mg Tablet\",\n \"drug_form\": \"tablets\",\n \"pack_qty_label\": \"strip of 10 tablets\",\n \"sub_category2\": \"\",\n \"category\": [\n \"\"\n ],\n \"composition\": \"Bilastine (20mg) + Montelukast (10mg)\",\n \"mfr\": \"Uniza Healthcare LLP\",\n \"rx_required\": \"yes\",\n \"pack_form\": \"strip\",\n \"type\": \"Medicine\",\n \"discounted_price\": 154.8,\n \"images\": {\n \"700\": [\n \"https://images.medpay.in/_700/nopreview.webp\"\n ]\n }\n }\n ]\n}"},{"id":"5ea10e3c-fc18-42be-8e89-61c64f2f22b7","name":"Error - Too many SKUs","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"url":"{{host_url}}/partner/pharmacy/skus/online/sku/272652,155000,123922,183452,124562,124352,375570,125182,125417,125309,125234"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 01 Apr 2022 09:36:34 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"91"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"88ee6b4f-47c1-4ce3-9aba-d5359ba2047c"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amzn-Remapped-Content-Length","value":"91"},{"key":"x-amzn-Remapped-Connection","value":"keep-alive"},{"key":"x-amz-apigw-id","value":"P5QhcEAchcwFjiQ="},{"key":"x-amzn-Remapped-Server","value":"nginx/1.20.0"},{"key":"x-amzn-Remapped-Date","value":"Fri, 01 Apr 2022 09:36:34 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"failed\",\n \"message\": \"skus should be ≤ 10!\",\n \"response\": []\n}"},{"id":"6780a93e-ade3-4372-a4f0-48eeceb0273c","name":"Success - SKUs without partner name","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"url":{"raw":"{{host_url}}/partner/pharmacy/skus/online/sku?sku_id=235078,485619,521338","host":["{{host_url}}"],"path":["partner","pharmacy","skus","online","sku"],"query":[{"key":"sku_id","value":"235078,485619,521338"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 20 Feb 2023 10:32:32 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1952"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a95f2051-bf6d-4bac-b133-9470dbfde5e7"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"AojaFE8ThcwFRWA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-63f34c40-5dc2363619987d975cfcded9"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"response\": [\n {\n \"pack_quantity\": 1,\n \"sku_id\": \"235078\",\n \"sub_category\": [\n \"Ophthalmology,Health Conditions\"\n ],\n \"status\": \"available\",\n \"mrp\": 395,\n \"name\": \"Symhylo 1% Eye Drop\",\n \"drug_form\": \"Drop\",\n \"pack_qty_label\": \"bottle of 10 ml Eye Drop\",\n \"sub_category2\": \"Ophthalmological Anti Infectives Medicines\",\n \"category\": [\n \"Allopathy\"\n ],\n \"images\": {\n \"700\": [\n \"https://images.medpay.in/_700/mp235078_1.webp\",\n \"https://images.medpay.in/_700/mp235078_2.webp\",\n \"https://images.medpay.in/_700/mp235078_3.webp\",\n \"https://images.medpay.in/_700/mp235078_4.webp\",\n \"https://images.medpay.in/_700/mp235078_5.webp\"\n ]\n },\n \"composition\": \"Sodium Hyaluronate (1% w/v)\",\n \"mfr\": \"Berry & Herbs Pharma Private Limited\",\n \"rx_required\": \"no\",\n \"pack_form\": \"bottle\",\n \"type\": \"Medicine\"\n },\n {\n \"pack_quantity\": 10,\n \"sku_id\": \"485619\",\n \"sub_category\": [\n \"\"\n ],\n \"status\": \"available\",\n \"mrp\": 199.8,\n \"name\": \"Mecovon OD Capsule\",\n \"drug_form\": \"capsules\",\n \"pack_qty_label\": \"strip of 10 capsules\",\n \"sub_category2\": \"\",\n \"category\": [\n \"Vitamins & Nutrition\",\n \"Allopathy\"\n ],\n \"images\": {\n \"700\": [\n \"https://images.medpay.in/_700/mp485619_1.webp\",\n \"https://images.medpay.in/_700/mp485619_2.webp\",\n \"https://images.medpay.in/_700/mp485619_3.webp\",\n \"https://images.medpay.in/_700/mp485619_4.webp\",\n \"https://images.medpay.in/_700/mp485619_5.webp\",\n \"https://images.medpay.in/_700/mp485619_6.webp\"\n ]\n },\n \"composition\": \"\",\n \"mfr\": \"Zuventus Healthcare Limited\",\n \"rx_required\": \"no\",\n \"pack_form\": \"strip\",\n \"type\": \"Medicine\"\n },\n {\n \"pack_quantity\": 10,\n \"sku_id\": \"521338\",\n \"sub_category\": [\n \"\"\n ],\n \"status\": \"available\",\n \"mrp\": 172,\n \"name\": \"Unilastine M 20mg/10mg Tablet\",\n \"drug_form\": \"tablets\",\n \"pack_qty_label\": \"strip of 10 tablets\",\n \"sub_category2\": \"\",\n \"category\": [\n \"\"\n ],\n \"composition\": \"Bilastine (20mg) + Montelukast (10mg)\",\n \"mfr\": \"Uniza Healthcare LLP\",\n \"rx_required\": \"yes\",\n \"pack_form\": \"strip\",\n \"type\": \"Medicine\",\n \"images\": {\n \"700\": [\n \"https://images.medpay.in/_700/nopreview.webp\"\n ]\n }\n }\n ]\n}"},{"id":"1f369574-2ece-45b6-a39d-2dd6341866d7","name":"Success - Discontinued SKU","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"url":{"raw":"{{host_url}}/partner/pharmacy/skus/online/sku?sku_id=100124&partner_name={{partner_name}}","host":["{{host_url}}"],"path":["partner","pharmacy","skus","online","sku"],"query":[{"key":"sku_id","value":"100124"},{"key":"partner_name","value":"{{partner_name}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 26 Aug 2022 05:53:09 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"735"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"ca0e6173-7292-4154-8d06-f8ad78a35a0d"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"XdPm3EylBcwFveA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-63085fc5-45ff36f23c2809c61943b2e6"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"response\": [\n {\n \"pack_quantity\": 0,\n \"sku_id\": \"100124\",\n \"sub_category\": [\n \"Hormones\"\n ],\n \"status\": \"discontinued\",\n \"mrp\": 0,\n \"name\": \"Nicobolin 25mg Inj\",\n \"drug_form\": \"Injection\",\n \"category\": [\n \"Allopathy\"\n ],\n \"pack_qty_label\": \"\",\n \"sub_category2\": \"Anabolic Hormones Systemic\",\n \"composition\": \"Nandrolone Decanoate (25mg)\",\n \"mfr\": \"Abbott\",\n \"rx_required\": \"yes\",\n \"pack_form\": \"Vial\",\n \"type\": \"Medicine\",\n \"discounted_price\": 0\n }\n ]\n}"}],"_postman_id":"46a72fdb-103c-4b15-a389-bf0b0b06a283"},{"name":"[DEPRECATED] Get Order Status","id":"da7363ed-503e-437a-adf4-6a3b7f69cb68","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"description":"

We have deprecated this API, please register a callback URL to make use of MedPay Partner Webhooks.

\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"da7363ed-503e-437a-adf4-6a3b7f69cb68"},{"name":"Create Order","event":[{"listen":"test","script":{"id":"6176132c-f7d5-40ef-8468-1999fc16a2be","exec":["pm.test(\"Status code is 200\", function () {"," order_id = pm.variables.get(\"partner_order_id\");"," order_id = parseInt(order_id)+1"," pm.environment.set(\"partner_order_id\", order_id.toString());"," pm.response.to.have.status(200);","});"],"type":"text/javascript"}}],"id":"cd8130eb-9d35-434b-8b01-526cacef98ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partner_order_id\": \"22061148\",\n \"partner_name\": \"{{partner_name}}\",\n \"payment_collection\": \"medpay\",\n \"delivery_partner\": \"medpay\",\n \"applied_discount\": \"10\",\n \"customer_details\": {\n \"name\": \"John doe\",\n \"mobile\": \"1234567890\",\n \"gender\": \"male\",\n \"age\": 30,\n \"alternative_mobile\": \"\",\n \"email\": \"xyz@medpay.in\",\n \"address_details\": {\n \"address\": \"1/6, Gandhi Nagar, Banglore\",\n \"landmark\": \"gandhi nagar\",\n \"pin_code\": \"126102\",\n \"city\": \"jind\",\n \"state\": \"haryana\",\n \"coordinates\": \"29.3136163,76.3215712\"\n }\n },\n \"order_details\": {\n \"doctor\": \"Dr. Name\",\n \"prescription_links\": [\n \"https://prescriptions-link1-s3.medpay.in\"\n ],\n \"items\": [\n {\n \"sku_id\": \"400574\",\n \"quantity\": 1\n }\n ]\n },\n \"extra1\": \"your extra1 information\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/pharmacy/order/online/create","description":"

Use Create Order API to place the medicine order for home delivery. MedPay will select a pharmacy in our Connected Care Network that is closest to the customer's address to fulfil the order.

Note: Customer's location coordinates(lat-long) are mandatory under customer_details to ensure seamless delivery of the order.

Note: Please ensure that the customer pin code is serviceable by MedPay providers using the Pincode Serviceability API before placing an order. MedPay will reject any order that is in a non-serviceable location.

Request Params:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Param	Description	Type	Format/Values
`partner_order_id` (required)	Partner Order id	String	Unique order ID passed by the Partner. Partner Order ID can only contain letters, numbers, underscores(_) and hyphens(-).
`partner_name` (required)	Name of the partner placing the order	String	Values shared with API access details. Partner name must be more than 3 characters long
`payment_collection` (required)	Payment collection type reference	String	self, medpay
`delivery_partner` (required)	Type of delivery mode	String	self_pickup (If Partner wants to opt for self delivery or self pickup), medpay (If partner wants to opt for 3rd party delivery option)
`applied_discount` (required)	Discount offered by partner to customer	String	Discount percentage. For e.g, \"10\"
`customer_details` (required)	Customer meta data	Map[object]
`name` (required)	Customer name	String Maximum length: 255 char	Maximum length: 255 char. For e.g, John Doe
`mobile` (required)	10 digits mobile number	String	880XXXXXXX
`gender` (optional)	Customer gender	String	Male/Female/Other
`age` (optional)	Customer age	Integer	Age must be between 0 - 99
`alternative_mobile_number` (optional)	10 digits alternate mobile number	String	880XXXXXXX
`email` (optional)	Customer valid email ID	String	For e.g. xyz@email.in
`address_details` (required)	Customer address meta data	Map[object]
`address` (required)	Customer full address	String	Minimum length: 2 char
`landmark` (required)	Customer address landmark	String	Minimum length: 2 char
`pin_code` (required)	Customer address pincode	String	6 digit pincode. For e.g. 560103
`city` (required)	Customer address city	String	Minimum length: 2 char
`state` (required)	Customer address state	String	Minimum length: 2 char
`coordinates` (required)	Comma-separated lat & long	String	For e.g \"29.3156909,76.3212837\"
`order_details` (required)	Order details	Map[object]
`prescription_links` (required)	List of valid prescription URLs	List	For e.g. [\"http://www.example.com/index.html\"\\]
doctor (optional)	Dr. Name as per prescription	String	For. e.g. Dr. Anuj Gupta
`sku_id` (required)	SKU id received from the Search SKU API	String	For e.g. 460038
`quantity` (required)	item order quantity	integer	Quantity should be between 1 - 50
extra1 (optional)	Any additional instructions or notes about this order	String	For e.g. Customer Policy ID: 10933

","urlObject":{"path":["partner","pharmacy","order","online","create"],"host":["{{host_url}}"],"query":[],"variable":[]}},"response":[{"id":"8ca406e6-19fe-4360-b16d-bb75f1278c86","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"partner_order_id\": \"{{partner_order_id}}\",\n \"partner_name\": \"{{partner_name}}\",\n \"payment_collection\": \"medpay\",\n \"delivery_partner\": \"medpay\",\n \"customer_details\": {\n \"name\": \"John doe\",\n \"mobile\": \"1234567890\",\n \"gender\": \"male\",\n \"age\": 30,\n \"alternative_mobile\": \"\",\n \"email\": \"xyz@medpay.in\",\n \"address_details\": {\n \"address\": \"1/6, Gandhi Nagar, Banglore\",\n \"landmark\": \"gandhi nagar\",\n \"pin_code\": \"126102\",\n \"city\": \"jind\",\n \"state\": \"haryana\",\n \"coordinates\": \"29.3136163,76.3215712\"\n }\n },\n \"order_details\": {\n \"doctor\": \"Dr. Name\",\n \"prescription_links\": [\n \"https://prescriptions-link1-s3.medpay.in\"\n ],\n \"items\": [\n {\n \"sku_id\": \"400574\",\n \"quantity\": 1\n }\n ]\n },\n \"extra1\": \"your extra1 information\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/pharmacy/order/online/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 21 Aug 2021 20:27:51 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1412"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"8073f00b-2657-41cc-89ff-e87857585b1f"},{"key":"x-amz-apigw-id","value":"Ebw2_HGyhcwFasg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-612161c6-327329a50c6fb2ec4025199c"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"order created successfully.\",\n \"response\": {\n \"extra1\": \"your extra1 information\",\n \"partner_order_id\": \"1001\",\n \"payment_collection\": \"medpay\",\n \"delivery_partner\": \"medpay\",\n \"partner_name\": \"testpartner\",\n \"order_status\": \"pending\",\n \"customer_details\": {\n \"name\": \"John doe\",\n \"mobile\": \"1234567890\",\n \"gender\": \"male\",\n \"age\": 30,\n \"alternative_mobile\": \"\",\n \"email\": \"xyz@medpay.in\",\n \"address_details\": {\n \"address\": \"1/6, Gandhi Nagar, Banglore\",\n \"landmark\": \"gandhi nagar\",\n \"pin_code\": \"126102\",\n \"city\": \"Jind\",\n \"state\": \"haryana\"\n }\n },\n \"order_details\": {\n \"doctor\": \"Dr. Name\",\n \"prescription_links\": [\n \"https://prescriptions-link1-s3.medpay.in\"\n ],\n \"items\": [\n {\n \"sku_id\": \"400574\",\n \"item\": \"Mecobal Od Sublingual Tab\",\n \"manufacturer\": \"Mecobal-OD\",\n \"details\": \"strip of 10 Sublingual tablet\",\n \"pack_form\": \"Strip\",\n \"pack_quantity\": 10,\n \"composition\": \"\",\n \"MRP\": \"119.5\",\n \"type\": \"Medicine\",\n \"quantity\": 1,\n \"amount\": \"119.5\"\n }\n ]\n },\n \"created_by\": \"testpartner\",\n \"created_at\": \"21/02/2023 12:20:06.490142\"\n }\n}"},{"id":"198c5e1a-5b83-4737-8673-f348d94ae7a5","name":"Success - Order with Applied Discount","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partner_order_id\": \"{{partner_order_id}}\",\n \"partner_name\": \"{{partner_name}}\",\n \"payment_collection\": \"medpay\",\n \"delivery_partner\": \"medpay\",\n \"applied_discount\": \"10\",\n \"customer_details\": {\n \"name\": \"John doe\",\n \"mobile\": \"1234567890\",\n \"gender\": \"male\",\n \"age\": 30,\n \"alternative_mobile\": \"\",\n \"email\": \"xyz@medpay.in\",\n \"address_details\": {\n \"address\": \"1/6, Gandhi Nagar, Banglore\",\n \"landmark\": \"gandhi nagar\",\n \"pin_code\": \"126102\",\n \"city\": \"jind\",\n \"state\": \"haryana\",\n \"coordinates\": \"29.3136163,76.3215712\"\n }\n },\n \"order_details\": {\n \"doctor\": \"Dr. Name\",\n \"prescription_links\": [\n \"https://prescriptions-link1-s3.medpay.in\"\n ],\n \"items\": [\n {\n \"sku_id\": \"400574\",\n \"quantity\": 1\n }\n ]\n },\n \"extra1\": \"your extra1 information\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/pharmacy/order/online/create"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"8889906a-d20b-4f8a-aded-3ec2d6fd674d","name":"Error - Duplicate Order ID","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"partner_order_id\": \"{{partner_order_id}}\",\n \"partner_name\": \"{{partner_name}}\",\n \"payment_collection\": \"medpay\",\n \"delivery_partner\": \"medpay\",\n \"customer_details\": {\n \"name\": \"John doe\",\n \"mobile\": \"8800684733\",\n \"gender\": \"male\",\n \"age\": 30,\n \"alternative_mobile\": \"\",\n \"email\": \"xyz@medpay.in\",\n \"address_details\": {\n \"address\": \"1/6, Gandhi Nagar, Banglore\",\n \"landmark\": \"gandhi nagar\",\n \"pin_code\": \"126102\",\n \"city\": \"jind\",\n \"state\": \"haryana\",\n \"coordinates\": \"29.3136163,76.3215712\"\n }\n },\n \"order_details\": {\n \"prescription_links\": [\n \"https://prescriptions-link1-s3.medpay.in\"\n ],\n \"items\": [\n {\n \"sku_id\": \"156768\",\n \"quantity\": 1\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/pharmacy/order/online/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 21 Aug 2021 20:28:29 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1116"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a1a89915-00f9-4280-b707-cd989da5cba6"},{"key":"x-amz-apigw-id","value":"Ebw9MFNGhcwFVIg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-612161ed-05c7eca430d913326d52fe2a"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"failed\",\n \"message\": \"order with partner_order_id already exist.\",\n \"response\": {\n \"partner_order_id\": \"10006\",\n \"partner_name\": \"testpartner\",\n \"payment_collection\": \"medpay\",\n \"delivery_partner\": \"medpay\",\n \"customer_details\": {\n \"name\": \"John doe\",\n \"mobile\": \"8800684733\",\n \"gender\": \"male\",\n \"age\": 30,\n \"alternative_mobile\": \"\",\n \"email\": \"xyz@medpay.in\",\n \"address_details\": {\n \"address\": \"1/6, Gandhi Nagar, Banglore\",\n \"landmark\": \"gandhi nagar\",\n \"pin_code\": \"126102\",\n \"city\": \"jind\",\n \"state\": \"haryana\",\n \"coordinates\": \"29.3136163,76.3215712\"\n }\n },\n \"order_details\": {\n \"prescription_links\": [\n \"https://prescriptions-link1-s3.medpay.in\"\n ],\n \"items\": [\n {\n \"sku_id\": \"156768\",\n \"quantity\": 1\n }\n ]\n }\n }\n}"},{"id":"4a63b085-3e41-4f07-8c9d-8f496110913d","name":"Error - Missing Customer Location","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"partner_order_id\": \"pharma-test1\",\n \"partner_name\": \"partner_name\",\n \"payment_collection\": \"medpay\",\n \"delivery_partner\": \"medpay\",\n \"customer_details\": {\n \"name\": \"John doe\",\n \"mobile\": \"8888888888\",\n \"gender\": \"male\",\n \"age\": 30,\n \"alternative_mobile\": \"\",\n \"email\": \"xyz@medpay.in\",\n \"address_details\": {\n \"address\": \"1/6, Gandhi Nagar, Banglore\",\n \"landmark\": \"gandhi nagar\",\n \"pin_code\": \"126102\",\n \"city\": \"banglore\",\n \"state\": \"Karnataka\"\n }\n },\n \"order_details\": {\n \"prescription_links\": [\n \"https://prescriptions-link1-s3.medpay.in\"\n ],\n \"items\": [\n {\n \"sku_id\": \"46038\",\n \"quantity\": 1\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/pharmacy/order/online/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 21 Aug 2021 20:30:29 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"171"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"317c9868-0f8f-4bcd-a43c-c03df2400bee"},{"key":"x-amz-apigw-id","value":"EbxP6EtjhcwFgig="},{"key":"X-Amzn-Trace-Id","value":"Root=1-61216265-25811b744cd5082f60c4b1b8"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": {\n \"customer_details.address_details.coordinates\": \"'coordinates' is a required property\"\n },\n \"message\": \"Input payload validation failed\"\n}"},{"id":"6e9b14e3-a761-4538-b7ed-9275c8f1093b","name":"Error - Order contains only unavailable items","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partner_order_id\": \"{{partner_order_id}}\",\n \"partner_name\": \"{{partner_name}}\",\n \"payment_collection\": \"medpay\",\n \"delivery_partner\": \"medpay\",\n \"customer_details\": {\n \"name\": \"John doe\",\n \"mobile\": \"1234567890\",\n \"gender\": \"male\",\n \"age\": 30,\n \"alternative_mobile\": \"\",\n \"email\": \"xyz@medpay.in\",\n \"address_details\": {\n \"address\": \"1/6, Gandhi Nagar, Banglore\",\n \"landmark\": \"gandhi nagar\",\n \"pin_code\": \"126102\",\n \"city\": \"jind\",\n \"state\": \"haryana\",\n \"coordinates\": \"29.3136163,76.3215712\"\n }\n },\n \"order_details\": {\n \"prescription_links\": [\n \"https://prescriptions-link1-s3.medpay.in\"\n ],\n \"items\": [\n {\n \"sku_id\": \"100124\",\n \"quantity\": 1\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/pharmacy/order/online/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 26 Aug 2022 14:47:42 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1484"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"63e8d1ef-37cf-4b0c-8c86-8c72b3e0af4a"},{"key":"x-amz-apigw-id","value":"Xed6OHdxBcwFmOg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6308dd0e-5eba8fd17f029e02691849b8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"failed\",\n \"message\": \"sku_id is invalid or unavailable\",\n \"response\": {\n \"partner_order_id\": \"10057\",\n \"partner_name\": \"testpartner\",\n \"payment_collection\": \"medpay\",\n \"delivery_partner\": \"medpay\",\n \"customer_details\": {\n \"name\": \"John doe\",\n \"mobile\": \"1234567890\",\n \"gender\": \"male\",\n \"age\": 30,\n \"alternative_mobile\": \"\",\n \"email\": \"xyz@medpay.in\",\n \"address_details\": {\n \"address\": \"1/6, Gandhi Nagar, Banglore\",\n \"landmark\": \"gandhi nagar\",\n \"pin_code\": \"126102\",\n \"city\": \"Jind\",\n \"state\": \"haryana\",\n \"coordinates\": \"29.315166,76.3239279\",\n \"formatted_address\": \"1/6, Gandhi Nagar, Banglore, gandhi nagar, Jind, haryana, 126102\"\n }\n },\n \"order_details\": {\n \"prescription_links\": [\n \"https://prescriptions-link1-s3.medpay.in\"\n ],\n \"items\": [\n {\n \"sku_id\": \"100124\",\n \"quantity\": 1\n }\n ]\n }\n }\n}"}],"_postman_id":"cd8130eb-9d35-434b-8b01-526cacef98ef"},{"name":"Confirm Order","id":"6fef9873-feaa-48a8-9a52-524170623a4d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partner_order_id\": \"{{partner_order_id}}\",\n \"partner_name\": \"{{partner_name}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/pharmacy/order/confirm","description":"

In case the order has been modified by MedPay(in the event of medicines being unavailable, alternative brands available, etc), the order moves to partner_pending state, following which, the partner has to use Partner Confirmation API to confirm that the changes are acceptable.

\n
Note: This API has to be called only if an order is in partner_pending state.
\n

\n
Note: The order status will change to invoice_generated on order confirmation.
\n

Request Params:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Param	Description	Type	Format/Values
`partner_order_id` (required)	Partner Order id	String	Unique order id passed by the Partner
`partner_name` (required)	Name of the partner placing the order	String	Values shared with API access details
`confirmed_items` (optional)	List of confirmed SKUs	Map[object]	To confirm selected sku_id and respective quantity from the available items
`sku_id` (optional)	SKU ID of confirmed SKU	String	For e.g. 460032
`quantity` (optional)	Quantity of confirmed SKU	Number	For e.g. 1

Note: In case, confirmed_items is not provided, the complete order will be processed.

\n","urlObject":{"path":["partner","pharmacy","order","confirm"],"host":["{{host_url}}"],"query":[],"variable":[]}},"response":[{"id":"b65caae5-8b98-4034-b3b4-377ffbb2bb44","name":"Success - Full order confirmation","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partner_order_id\": \"{{partner_order_id}}\",\n \"partner_name\": \"{{partner_name}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/pharmacy/order/confirm"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 01 Apr 2022 09:45:33 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"2187"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"99d11189-d846-4b28-be5b-66e3af01295d"},{"key":"x-amz-apigw-id","value":"P5R1cFTtBcwFXDA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6246c9bc-51da0e9f66f02bbc033b4c18"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"invoice generated successfully.\",\n \"response\": {\n \"extra1\": \"your extra1 information\",\n \"partner_order_id\": \"1001\",\n \"partner_name\": \"testpartner\",\n \"order_details\": {\n \"doctor\": \"Dr. Name\",\n \"items\": [\n {\n \"item\": \"Mecobal Od Sublingual Tab\",\n \"pack_quantity\": 10,\n \"amount\": \"358.5\",\n \"quantity\": 3,\n \"pack_form\": \"Strip\",\n \"sku_id\": \"400574\",\n \"MRP\": \"119.5\",\n \"change_type\": \"quantity\",\n \"type\": \"Medicine\",\n \"manufacturer\": \"Mecobal-OD\",\n \"requested_item\": {\n \"item\": \"Mecobal Od Sublingual Tab\",\n \"pack_quantity\": 10,\n \"amount\": \"119.5\",\n \"quantity\": 1,\n \"pack_form\": \"Strip\",\n \"gst\": \"\",\n \"sku_id\": \"400574\",\n \"MRP\": \"119.5\",\n \"type\": \"Medicine\",\n \"manufacturer\": \"Mecobal-OD\",\n \"composition\": \"\",\n \"details\": \"strip of 10 Sublingual tablet\",\n \"HSNCode\": \"\"\n },\n \"composition\": \"\",\n \"med_from_db\": \"true\",\n \"details\": \"strip of 10 Sublingual tablet\"\n }\n ],\n \"prescription_links\": [\n \"https://prescriptions-link1-s3.medpay.in\"\n ]\n },\n \"order_status\": \"invoice_generated\",\n \"created_at\": \"21/02/2023 11:48:34.697890\",\n \"modified_at\": \"21/02/2023 12:37:20.913491\",\n \"invoice_details\": {\n \"invoice_id\": \"inv193890296702456\",\n \"invoice_link\": \"https://mdpy.in/aCgfCsEUYT\",\n \"payment_status\": \"pending\",\n \"bill_amount\": \"358.5\",\n \"net_amount\": \"358.5\"\n }\n }\n}"},{"id":"21af8260-65a8-4bf3-9d1f-1d420c41ee8d","name":"Success - Partial order confirmation","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partner_order_id\": \"{{partner_order_id}}\",\n \"partner_name\": \"{{partner_name}}\",\n \"confirmed_items\": [\n {\n \"sku_id\": \"124861\",\n \"quantity\": 2\n },\n {\n \"sku_id\": \"118613\",\n \"quantity\": 1\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/pharmacy/order/confirm"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 01 Apr 2022 09:49:13 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1442"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"15b11e73-66bf-4f62-b11c-e3236845c05b"},{"key":"x-amz-apigw-id","value":"P5SXwEXIhcwFpfg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6246ca97-5fc3afd17859d8cc6bdde5e9"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"invoice generated successfully.\",\n \"response\": {\n \"extra1\": \"your extra1 information\",\n \"partner_order_id\": \"1009\",\n \"partner_name\": \"testpartner\",\n \"order_details\": {\n \"doctor\": \"Dr. Who\",\n \"items\": [\n {\n \"item\": \"Vinspas Oral Drops\",\n \"pack_quantity\": 1,\n \"amount\": \"68.0\",\n \"quantity\": 2,\n \"pack_form\": \"Bottle\",\n \"sku_id\": \"124861\",\n \"MRP\": \"34\",\n \"type\": \"Medicine\",\n \"manufacturer\": \"Therawin Formulations\",\n \"composition\": \"Dicyclomine (10mg) + Simethicone (40mg)\",\n \"med_from_db\": \"true\",\n \"details\": \"bottle of 10 ml Oral Drops\"\n },\n {\n \"item\": \"Salsone Cream\",\n \"pack_quantity\": 1,\n \"amount\": \"57.7\",\n \"quantity\": 1,\n \"pack_form\": \"tube\",\n \"sku_id\": \"118613\",\n \"MRP\": \"57.7\",\n \"change_type\": \"alternative\",\n \"drug_form\": \"Cream\",\n \"manufacturer\": \"Salud Care India Pvt Ltd\",\n \"requested_item\": {\n \"item\": \"Sulxone Inj\",\n \"pack_quantity\": 1,\n \"amount\": \"210.0\",\n \"quantity\": 3,\n \"pack_form\": \"Vial\",\n \"gst\": \"\",\n \"sku_id\": \"303503\",\n \"MRP\": \"70\",\n \"type\": \"Medicine\",\n \"manufacturer\": \"Tyrant Pharma Private Limited\",\n \"composition\": \"Ceftriaxone (500mg) + Sulbactam (250mg)\",\n \"med_from_db\": \"true\",\n \"details\": \"vial of 1 Injection\",\n \"HSNCode\": \"\"\n },\n \"composition\": \"Mometasone (NA)\",\n \"med_from_db\": \"true\",\n \"details\": \"tube of 5 gm Cream\"\n }\n ],\n \"prescription_links\": [\n \"https://prescriptions-link1-s3.medpay.in\"\n ]\n },\n \"order_status\": \"invoice_generated\",\n \"created_at\": \"20/02/2023 14:29:05.135562\",\n \"modified_at\": \"21/02/2023 12:45:08.120760\",\n \"invoice_details\": {\n \"invoice_id\": \"inv281315673756744\",\n \"invoice_link\": \"https://mdpy.in/gF0OHYwfL3\",\n \"payment_status\": \"pending\",\n \"bill_amount\": \"125.7\",\n \"net_amount\": \"125.7\"\n }\n }\n}"},{"id":"737548d0-80db-4d6c-aa3d-49ea58c77972","name":"Error - Confirmation Failed","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partner_order_id\": \"10006\",\n \"partner_name\": \"{{partner_name}}\",\n \"confirmed_items\": [\n {\n \"sku_id\": \"156768\",\n \"quantity\": 1\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/pharmacy/order/confirm"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 01 Apr 2022 09:46:39 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"306"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"4ec03e7a-cebd-4e9c-88cc-bb33fa829c37"},{"key":"x-amz-apigw-id","value":"P5R_6F5-hcwFoSQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6246c9ff-4d413b881f5573ac3d4c946e"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"failed\",\n \"message\": \"order confirmation failed.\",\n \"response\": {\n \"partner_order_id\": \"10006\",\n \"partner_name\": \"testpartner\",\n \"confirmed_items\": [\n {\n \"sku_id\": \"156768\",\n \"quantity\": 1\n }\n ]\n }\n}"}],"_postman_id":"6fef9873-feaa-48a8-9a52-524170623a4d"},{"name":"Update Payment Status","id":"55b50eb4-7e52-4b6a-9113-a9a017acff92","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partner_order_id\": \"{{partner_order_id}}\",\n \"invoice_id\": \"inv927303177188542\",\n \"partner_name\": \"{{partner_name}}\",\n \"payment_details\": {\n \"reference_id\": \"3213\",\n \"net_amount\": \"1039.0\",\n \"delivery_fee_exclusive\": \"0\",\n \"delivery_partner\": \"self_pickup\",\n \"payment_type\": \"card\",\n \"payment_timestamp\": \"\"\n },\n \"patient_payable\": \"0\",\n \"payer_payable\": \"1039.0\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/pharmacy/order/payment/confirm","description":"

Use the Update Payment Status API to provide confirmation on the payment status.

\n
Note: Payment confirmation is required from partner before the order status changes to package_picked
Note: Payment can be made fully or partially, in which case, the patient has to complete the payment to move the order to package_picked__. The link for patient to complete payment will be provided in the webhook notification and sent directly to the patient via WhatsApp message.
\n

Request Params:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Param	Description	Type	Format/Values
`partner_order_id` (required)	Partner Order id	String	Unique order id passed by the Partner
`partner_name` (required)	Name of the partner placing the order	String	Values shared with API access details
`invoice_id` (required)	Unique invoice id generated by MedPay when order status changes to invoice_generated	String	E.g \"inv187258418906901\"
`payment_details` (required)	Payment meta data	Map[object]	E.g \"inv187258418906901\"
`reference_id` (required)	Unique payment reference ID generated by Partner	String	E.g \"32132323\"
`net_amount` (required)	Amount paid by the patient	String	E.g \"201.50\"
`payment_type` (required)	Payment mode type	String	Acceptable values: `card, upi, internet_banking, voucher, other`
`payment_timestamp` (optional)	Payment Timestamp	String
`notes` (optional)	Notes	String	To pass additional notes
`payer_payable` (required)	Amount paid by the payer	String
`patient_payable` (required)	Amount to be paid by the patient	String	This amount must be collected from the patient using the link provided by MedPay for the order to be confirmed.

","urlObject":{"path":["partner","pharmacy","order","payment","confirm"],"host":["{{host_url}}"],"query":[],"variable":[]}},"response":[{"id":"645dfdc5-bd25-43a7-abcc-9b4166621d69","name":"Success - Complete payment","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"partner_order_id\": \"1009\",\n \"invoice_id\": \"inv281315673756744\",\n \"partner_name\": \"{{partner_name}}\",\n \"payment_details\": {\n \"reference_id\": \"3213\",\n \"net_amount\": \"126.0\",\n \"delivery_fee_exclusive\": \"0\",\n \"delivery_partner\": \"self_pickup\",\n \"payment_type\": \"card\",\n \"payment_timestamp\": \"\"\n },\n \"patient_payable\": \"0\",\n \"payer_payable\": \"126.0\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/pharmacy/order/payment/confirm"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 24 Aug 2021 06:04:19 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"685"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"12ad808e-b3cd-42e9-8703-915f3ddfffbc"},{"key":"x-amz-apigw-id","value":"EjrLeFcwhcwFo7A="},{"key":"X-Amzn-Trace-Id","value":"Root=1-61248be2-232ea23365391d577449b68d"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"payment confirmed successfully.\",\n \"response\": {\n \"partner_order_id\": \"1009\",\n \"partner_name\": \"testpartner\",\n \"invoice_id\": \"inv281315673756744\",\n \"payment_status\": \"success\",\n \"payment_details\": {\n \"reference_id\": \"3213\",\n \"net_amount\": \"126.0\",\n \"delivery_fee_exclusive\": \"0\",\n \"delivery_partner\": \"self_pickup\",\n \"payment_type\": \"card\",\n \"payment_timestamp\": \"\"\n },\n \"order_status\": \"payment_collected\",\n \"created_at\": \"20/02/2023 14:29:05.135562\",\n \"modified_at\": \"21/02/2023 12:50:24.903068\"\n }\n}"},{"id":"f08b0d7d-700e-4c52-8b97-9eb51da8c2d8","name":"Success - Partial payment","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partner_order_id\": \"10006\",\n \"invoice_id\": \"inv193890296702456\",\n \"partner_name\": \"{{partner_name}}\",\n \"payment_details\": {\n \"reference_id\": \"3213\",\n \"net_amount\": \"359.0\",\n \"delivery_fee_exclusive\": \"0\",\n \"delivery_partner\": \"self_pickup\",\n \"payment_type\": \"card\",\n \"payment_timestamp\": \"\"\n },\n \"patient_payable\": \"9\",\n \"payer_payable\": \"350.0\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/pharmacy/order/payment/confirm"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 01 Apr 2022 09:52:35 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"757"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"370de60b-ec7f-4f19-a1fb-211f5273a13f"},{"key":"x-amz-apigw-id","value":"P5S3cGs0BcwFSMA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6246cb62-5c3e17c45de5c27563c61b9e"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"payment confirmed successfully.\",\n \"response\": {\n \"partner_order_id\": \"10006\",\n \"partner_name\": \"testpartner\",\n \"invoice_id\": \"inv193890296702456\",\n \"payment_status\": \"pending\",\n \"payment_details\": {\n \"reference_id\": \"3213\",\n \"net_amount\": \"359.0\",\n \"delivery_fee_exclusive\": \"0\",\n \"delivery_partner\": \"self_pickup\",\n \"payment_type\": \"card\",\n \"payment_timestamp\": \"\"\n },\n \"order_status\": \"payment_pending\",\n \"created_at\": \"21/02/2023 11:48:34.697890\",\n \"modified_at\": \"21/02/2023 14:11:47.161907\",\n \"patient_payable\": \"9.0\",\n \"payer_payable\": \"350.0\"\n }\n}"},{"id":"6a16dc9f-470f-43b2-9d65-1d2d8a7cb250","name":"Error - Already confirmed","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"partner_order_id\": \"pharma-test10\",\n \"invoice_id\": \"inv179032620539122\",\n \"partner_name\": \"partner_name\",\n \"payment_details\": {\n \"reference_id\": \"3213\",\n \"net_amount\": \"18.12\",\n \"delivery_fee_exclusive\": \"0\",\n \"delivery_partner\": \"self_pickup\",\n \"payment_type\": \"card\",\n \"payment_timestamp\": \"\"\n },\n \"patient_payable\": \"0\",\n \"payer_payable\": \"18.12\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/pharmacy/order/payment/confirm"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 24 Aug 2021 06:05:13 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"115"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"1fbf4484-8726-4273-bc6d-192b9360e65c"},{"key":"x-amz-apigw-id","value":"EjrUBF_YhcwFudg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-61248c19-15aec6e105916cfa0ec726fd"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"failed\",\n \"message\": \"payment cannot be confirmed or already confirmed.\",\n \"response\": {}\n}"}],"_postman_id":"55b50eb4-7e52-4b6a-9113-a9a017acff92"},{"name":"Cancel Order","id":"f28e148a-79f8-4034-ba81-a96a12626177","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partner_order_id\": \"{{partner_order_id}}\",\n \"partner_name\": \"{{partner_name}}\",\n \"cancellation_code\": \"CC03\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/pharmacy/order/cancel","description":"

Use the Cancel Order API to cancel an existing order. An order can be cancelled if it is in the following states:

pending
partner_pending
accepted
invoice_generated
payment_pending

\n
Note: Order cancellation will be processed based on the state of the order and not the time of order delivery.
\n

Request Params:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Param	Description	Type	Format/Values
`partner_order_id` (required)	Partner Order ID	String	Unique order ID passed by the Partner
`partner_name` (required)	Name of the partner placing the order	String	Values shared with API access details
`cancellation_code` (required)	Code for cancellation	String	Acceptable cancellation codes are tabulated below.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Cancellation Code	Cancellation Reason
CC01	Payment not done
CC02	Issue with partial delivery
CC03	Patient has already purchased the medicine
CC04	Patient looking for additional discount
CC05	Patient looking for immediate delivery
CC06	Patient not ready for alternatives
CC07	Patient wants COD

\n
Note: Currently, the Cancel Order API allows either a free-text cancellation reason or a cancellation code that uniquely identifies a specific cancellation reason. From 28 February 2023, the cancelled_reason field will be deprecated and cancellation_code will be made mandatory.
\n

\n","urlObject":{"path":["partner","pharmacy","order","cancel"],"host":["{{host_url}}"],"query":[],"variable":[]}},"response":[{"id":"086a20b5-6b2d-4d6b-947d-1737ee20c72d","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"partner_order_id\": \"17021700\",\n \"partner_name\": \"{{partner_name}}\",\n \"cancellation_code\": \"CC03\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/pharmacy/order/cancel"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 24 Aug 2021 08:07:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"356"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"7e40f0ee-c54d-4943-8c15-31b78ba8f6b0"},{"key":"x-amz-apigw-id","value":"Ej9LjHQohcwFlfg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6124a8b0-2ca3e1da3782b42440c7a69d"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"order cancelled successfully.\",\n \"response\": {\n \"partner_order_id\": \"17021700\",\n \"partner_name\": \"testpartner\",\n \"order_status\": \"cancelled\",\n \"cancelled_reason\": \"Patient has already purchased the medicine\",\n \"cancelled_by\": \"testpartner\",\n \"cancelled_at\": \"21/02/2023 14:16:00.830826\"\n }\n}"},{"id":"badf48f1-9cb4-4f9f-b80f-7cc5e38f3903","name":"Error - Order already cancelled","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"partner_order_id\": \"{{partner_order_id}}\",\n \"partner_name\": \"{{partner_name}}\",\n \"cancellation_code\": \"CC03\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/pharmacy/order/cancel"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 24 Aug 2021 08:07:36 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"254"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"28a1046f-3f97-49a5-89ef-28f19ad2902f"},{"key":"x-amz-apigw-id","value":"Ej9PZEOqhcwFXSQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6124a8c8-7f96496d34cfa53710834588"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"failed\",\n \"message\": \"order partner id: 17021700 is already cancelled.\",\n \"response\": {\n \"partner_order_id\": \"17021700\",\n \"partner_name\": \"testpartner\",\n \"cancellation_code\": \"CC03\"\n }\n}"},{"id":"e7996e94-c5b4-48fc-8079-eee0d2cfa89c","name":"Error - Order past payment collection","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partner_order_id\": \"{{partner_order_id}}\",\n \"partner_name\": \"{{partner_name}}\",\n \"cancellation_code\": \"CC03\"\n}","options":{"raw":{"language":"json"}}},"url":"http://127.0.0.1:9800/partner/pharmacy/order/cancel"},"status":"CONFLICT","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"212"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Server","value":"Werkzeug/1.0.1 Python/3.8.9"},{"key":"Date","value":"Tue, 21 Feb 2023 08:48:46 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"failed\",\n \"message\": \"order cancellation failed.\",\n \"response\": {\n \"partner_order_id\": \"20021440\",\n \"partner_name\": \"testpartner\",\n \"cancellation_code\": \"CC03\"\n }\n}"}],"_postman_id":"f28e148a-79f8-4034-ba81-a96a12626177"}],"id":"90914e74-57d9-4a79-8cde-bc66059b432b","description":"

Enlisted below is the complete set of APIs for Online/Home Delivery/Pickup of medicines:

Check Pincode Serviceability: Enter 6-digit customer pincode to check whether MedPay delivers to the location
Search SKU: Search for a given a item using free-text query.
Fetch SKU Details: Fetch details of upto 10 items including composition, manufacturer details, etc.
Create Order: Place an order with MedPay by providing customer information and order items
Accept order modifications/Confirm Order: In case the order is modified by MedPay (price change, item not available, alternatives), confirm that these modifications are acceptable to the customer
Update Payment Information: Upon invoice generation, confirm payment status, by mentioning any patient payable that has to be collected from the customer by MedPay PG.
Cancel Order: Cancel the order until the order is marked \"Payment Collected.

Partner Webhooks:

In order to receive real-time updates about an ongoing order, partners must configure a webhook URL to receive push notifications. MedPay will POST the most up-to-date information about each order whenever the order status is updated, so that it can be communicated to the user. We enable clients to register their own callback URL to receive notifications related to the status change of an Order/Invoice.

\n
Note: Response fields may vary, as per order states.
\n

Webhook URL: Please share webhook url to get timely order updates.

Method: POST

Authorization: Please provide a persistent Authorization token.

Events:

pending
partner_pending
accepted
invoice_generated
payment_pending
payment_collected
package_picked
package_delivered
cancelled

Sample webhook POST Event structure:

pending:

\n
Note: This event is applicable only for partial orders created automatically upon delivery of the original order. \"Partial Order Creation\" is an optional feature provided by MedPay to allow automated order creation in case the original order has quantity or not_available modifications. Please reach out to MedPay to enable this feature.
\n

{\n  \"partner_order_id\": \"pharma1_part_2\",\n  \"partner_name\": \"testpartner\",\n  \"order_status\": \"pending\",\n  \"timestamp\": \"21/02/2023 14:30:14.233067\",\n  \"reference_order_id\": \"pharma1\",\n  \"order_details\": {\n    \"items\": [\n      {\n        \"item\": \"Augmentin Duo\",\n        \"pack_quantity\": 1,\n        \"amount\": \"210.0\",\n        \"quantity\": 3,\n        \"pack_form\": \"Strip\",\n        \"gst\": \"\",\n        \"sku_id\": \"367610\",\n        \"MRP\": \"70\",\n        \"type\": \"Fmcg\",\n        \"manufacturer\": \"\",\n        \"composition\": \"\",\n        \"details\": \"Strip of 10 tablets\",\n        \"HSNCode\": \"\"\n      }\n    ],\n    \"prescription_links\": [\n      \"https://prescriptions-link1-s3.medpay.in\"\n    ]\n  }\n}\n\n

partner-pending:

{\n    \"partner_order_id\": \"pharma1\",\n    \"partner_name\": \"uat_partner\",\n    \"order_status\": \"partner_pending\",\n    \"order_details\": {\n        \"doctor\": \"Dr.Anuj Gupta\",\n        \"prescription_links\": [\n            \"https://prescriptions-link1-s3.medpay.in\"\n        ]\n        \"items\": [\n            { // New medicine added\n                \"item\": \"Ingen 200mg Tab\",\n                \"pack_quantity\": 10,\n                \"amount\": \"160.0\",\n                \"quantity\": 1,\n                \"pack_form\": \"Strip\",\n                \"gst\": \"12\",\n                \"sku_id\": \"451357\",\n                \"MRP\": \"160\",\n                \"change_type\": \"new\",\n                \"drug_form\": \"Tablets\",\n                \"manufacturer\": \"Medicamen Biotech Limited\",\n                \"composition\": \"Cefixime (200mg) + Lactobacillus (60Million spores)\",\n                \"details\": \"strip of 10 tablets\",\n                \"HSNCode\": \"3004\"\n            },\n            { // Alternative medicine available\n                \"sku_id\": \"223344 \",\n                \"item\": \"Augmentin 625 mg Tab 10 'S\",\n                \"amount\": \"201.71 \",\n                \"quantity\": \"1 \",\n                \"details\": \"10 Tablet(s) in Strip\",\n                \"MRP\": \"201.71 \",\n                \"manufacturer\": \"GLAXOSMITHKLINE\",\n                \"change_type\": \"alternative\",\n                \"requested_item\": {\n                    \"sku_id\": \"1332432\",\n                    \"item\": \"amoxyclav 625 10 'S\",\n                    \"amount\": \"201.71 \",\n                    \"details\": \"10 Tablet(s) in Strip\",\n                    \"MRP\": \"201.71 \",\n                    \"quantity\": 1,\n                    \"manufacturer\": \"Abbot\"\n                }\n            },\n            { // No change\n                \"sku_id\": \"123456\",\n                \"item\": \"Advance Crocin650mg Tab 15 'S\",\n                \"amount\": \"60\",\n                \"quantity\": \"2\",\n                \"details\": \"15 Tablet(s) in Strip\",\n                \"MRP\": \"30\",\n                \"manufacturer\": \"GLAXOSMITHKLINE\"\n            },\n            { // Change in quantity\n                \"sku_id\": \"123457\",\n                \"item\": \"Crocin 300 mg Advance Tab 15 'S\",\n                \"amount\": \"160\",\n                \"quantity\": \"8\",\n                \"details\": \"15 Tablet(s) in Strip\",\n                \"MRP\": \"20\",\n                \"manufacturer\": \"GLAXOSMITHKLINE\",\n                \"change_type\": \"quantity\",\n                \"requested_item\": {\n                    \"sku_id\": \"123457 \",\n                    \"item\": \"Crocin 300 mg Advance Tab 15 'S\",\n                    \"amount\": \"200 \",\n                    \"quantity\": \"10 \",\n                    \"details\": \"15 Tablet(s) in Strip\",\n                    \"MRP\": \"20 \",\n                    \"manufacturer\": \"GLAXOSMITHKLINE\"\n                }\n            },\n            { // Change in price\n                \"sku_id\": \"123458 \",\n                \"item\": \"Crocin 600 mg Advance Tab 15 'S\",\n                \"amount\": \"101.82 \",\n                \"quantity\": \"1 \",\n                \"details\": \"15 Tablet(s) in Strip\",\n                \"MRP\": \"101.82 \",\n                \"manufacturer\": \"GLAXOSMITHKLINE\",\n                \"change_type\": \"price\",\n                \"requested_item\": {\n                    \"sku_id\": \"123458\",\n                    \"item\": \"Crocin 600 mg Advance Tab 15 'S\",\n                    \"amount\": \"91.82\",\n                    \"quantity\": \"1\",\n                    \"details\": \"15 Tablet(s) in Strip\",\n                    \"MRP\": \"91.82\",\n                    \"manufacturer\": \"GLAXOSMITHKLINE\"\n                }\n            },\n            { // Change in quantity and price\n                \"sku_id\": \"123460\",\n                \"item\": \"Crocin 600 mg Advance Tab 15 'S\",\n                \"amount\": \"101\",\n                \"quantity\": \"1\",\n                \"details\": \"15 Tablet(s) in Strip\",\n                \"MRP\": \"101\",\n                \"manufacturer\": \"GLAXOSMITHKLINE\",\n                \"change_type\": \"quantity_price\",\n                \"requested_item\": {\n                    \"sku_id\": \"123460 \",\n                    \"item\": \"Crocin 600 mg Advance Tab 15 'S\",\n                    \"amount\": \"180 \",\n                    \"quantity\": \"2 \",\n                    \"details\": \"15 Tablet(s) in Strip\",\n                    \"MRP\": \"90 \",\n                    \"manufacturer\": \"GLAXOSMITHKLINE\"\n                }\n            },\n            { //Medicine not available\n                \"sku_id\": \"123459 \",\n                \"item\": \"Crocin 100 mg Advance Tab 15 'S\",\n                \"amount\": \"10.82 \",\n                \"quantity\": \"1 \",\n                \"details\": \"15 Tablet(s) in Strip\",\n                \"MRP\": \"10.82\",\n                \"manufacturer\": \"GLAXOSMITHKLINE\",\n                \"change_type\": \"not_available\"\n            }\n        ]\n    }\n}\n\n

order-accepted:

{\n  \"partner_order_id\": \"pharma1\",\n  \"partner_name\": \"uat_partner\",\n  \"order_status\": \"accepted\",\n  \"timestamp\": \"01/04/2022 15:15:32.356292\"\n}\n\n

invoice-generated:

{\n  \"partner_order_id\": \"pharma1\",\n  \"partner_name\": \"uat_partner\",\n  \"order_status\": \"invoice_generated\",\n  \"invoice_details\": {\n    \"partner_discount\": \"0.0\",\n    \"tgst\": \"0.0\",\n    \"bill_amount\": \"239.0\",\n    \"invoice_no\": \"\",\n    \"payment_status\": \"pending\",\n    \"invoice_id\": \"inv111327017423370\",\n    \"payment_collection\": \"medpay\",\n    \"net_amount\": \"239.0\",\n    \"invoice_link\": \"https://mdpy.in/CSHp9iwPFq\",\n    \"receipt_link\": \"https://mdpy.in/CSHp9iwPFq\"\n  },\n  \"timestamp\": \"21/02/2023 12:33:28.187550\"\n}\n\n

payment-pending:

{\n  \"partner_order_id\": \"pharma1\",\n  \"partner_name\": \"uat_partner\",\n  \"order_status\": \"payment_pending\",\n  \"payment_details\": {\n    \"payment_timestamp\": \"\",\n    \"payment_type\": \"card\",\n    \"net_amount\": \"2500\",\n    \"notes\": \"\",\n    \"reference_id\": \"3213\",\n    \"payer_payable\": \"2000.0\",\n    \"patient_payable\": \"500.0\",\n    \"patient_payable_details\": {\n      \"transaction_id\": \"REQ444750295351\",\n      \"link\": \"https://mdpy.in/9nDmPUTMwH\",\n      \"payable_amount\": \"500.0\",\n      \"status\": \"payment link sent successfully\",\n      \"timestamp\": \"17/02/2023 17:14:40.809422\"\n    }\n  },\n  \"timestamp\": \"17/02/2023 17:14:40.040277\"\n}\n\n

payment-collected with no patient_payable:

{\n  \"partner_order_id\": \"pharma1\",\n  \"partner_name\": \"uat_partner\",\n  \"order_status\": \"payment_collected\",\n  \"payment_details\": {\n    \"payment_timestamp\": \"\",\n    \"payment_type\": \"card\",\n    \"net_amount\": \"126.0\",\n    \"reference_id\": \"3213\",\n    \"delivery_fee_exclusive\": \"0\",\n    \"delivery_partner\": \"self_pickup\"\n  },\n  \"timestamp\": \"21/02/2023 12:50:24.903068\",\n  \"eta\": \"21/02/2023, 3PM - 6PM\"\n}\n\n

payment-collected with patient payable

{\n  \"partner_order_id\": \"pharma1\",\n  \"partner_name\": \"uat_partner\",\n  \"order_status\": \"payment_collected\",\n  \"payment_details\": {\n    \"delivery_fee\": 0,\n    \"payment_type\": \"payu\",\n    \"payer_payable\": \"566.62\",\n    \"delivery_partner\": \"medpay\",\n    \"patient_payable\": \"1.0\",\n    \"order_amount\": \"567.62\"\n  },\n  \"timestamp\": \"03/08/2022 18:23:00.095963\",\n  \"eta\": \"03/08/2022 21:23:00.095963\"\n}\n\n

package-picked:

{\n  \"partner_order_id\": \"pharma1\",\n  \"partner_name\": \"uat_partner\",\n  \"order_status\": \"package_picked\",\n  \"timestamp\": \"03/08/2022 17:38:09.511152\",\n  \"eta\": \"03-08-2022, 6PM - 9PM\"\n}\n\n

package-delivered:

{\n  \"partner_order_id\": \"pharma1\",\n  \"partner_name\": \"uat_partner\",\n  \"order_status\": \"package_delivered\",\n  \"timestamp\": \"03/08/2022 18:38:00.000000\"\n}\n\n

order-cancelled:

{\n  \"partner_order_id\": \"pharma1\",\n  \"partner_name\": \"uat_partner\",\n  \"order_status\": \"cancelled\",\n  \"cancelled_reason\": \"Invalid prescription\",\n  \"timestamp\": \"21/02/2023 14:53:04.048730\"\n}\n\n

","_postman_id":"90914e74-57d9-4a79-8cde-bc66059b432b"}],"id":"607c9487-8eaa-472c-97ed-7a432e7a5920","description":"

Developers can use pharmacy APIs to build powerful apps for their users to opt for 1-day home delivery of medicines or to simply show availability of medicines in the local neighborhood pharmacies for walk-ins/pickups.

\n","_postman_id":"607c9487-8eaa-472c-97ed-7a432e7a5920"},{"name":"[DEPRECATED] 02- Diagnostics","item":[{"name":"Home Pickup","item":[{"name":"Pincode Serviceability","id":"7aa24233-6bf3-4c1f-9840-c70ca4cbd82e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"url":"{{host_url}}/partner/diagnostics/pincode/{{pincode}}","description":"

Path Params:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Param	Description	Type	Format/Values
`pincode` (required)	Pincode	String	E.g \"560102\"

","urlObject":{"path":["partner","diagnostics","pincode","{{pincode}}"],"host":["{{host_url}}"],"query":[],"variable":[]}},"response":[{"id":"ae1fad8a-ecfb-4b5f-b9bb-7a9ffaa34b45","name":"Success - Serviceable","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"url":"{{host_url}}/partner/diagnostics/pincode/560102"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"area is serviceable\",\n \"response\": {\n \"pin_code\": \"560102\",\n \"serviceable\": true\n }\n}"},{"id":"9d54f439-6bf3-4831-8ab4-f8b77474cc26","name":"Error - Not serviceable","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"url":"{{host_url}}/partner/diagnostics/pincode/122001"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"area is not serviceable\",\n \"response\": {\n \"pin_code\": \"122001\",\n \"serviceable\": false\n }\n}"}],"_postman_id":"7aa24233-6bf3-4c1f-9840-c70ca4cbd82e"},{"name":"Search SKUs","id":"2eff5e0f-b22d-4e38-835e-6127bb1a148d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"url":"{{host_url}}/partner/diagnostics/skus/online/search/cbc?partner_name={{partner_name}}","description":"

Enhance the user experience of searching for a particular diagnostic test by integrating the Search SKU API in your application. This ultrafast search-as-you-type API is powered by Elastic Search on the backend to provide low latency results.

\n
Note: If the sample_collection is home_visit, only pathology test results will be generated.
\n

Path Params:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Param	Description	Type	Format/Values
`test_name` (required)	String to be searched in the lab tests inventory	String

Query Params:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Param	Description	Type	Format/Values
`partner_name` (required)	Partner name as defined at onboarding	String	E.g.: testpartner
`sample_collection` (optional)	Mode of sample collection	String	`home_visit` or `self_visit`
`category` (optional)	Category of diagnostic test	String	`pathology`/`radiology`/`all`

","urlObject":{"path":["partner","diagnostics","skus","online","search","cbc"],"host":["{{host_url}}"],"query":[{"key":"partner_name","value":"{{partner_name}}"}],"variable":[]}},"response":[{"id":"c157872b-102c-4bb0-9e01-2c5c4aa387e5","name":"Success - All tests","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"url":{"raw":"{{host_url}}/partner/diagnostics/skus/online/search/cbc?partner_name={{partner_name}}","host":["{{host_url}}"],"path":["partner","diagnostics","skus","online","search","cbc"],"query":[{"key":"partner_name","value":"{{partner_name}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 01 Apr 2022 10:19:40 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"537"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"fb714f81-352e-415f-a09e-08826a7bdd03"},{"key":"x-amz-apigw-id","value":"P5W1iF2VBcwFjaw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6246d1bc-4cbb5e695e5cb3742d2c7d45"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"skus found\",\n \"response\": [\n {\n \"test_id\": \"5003\",\n \"sample_type\": \"\",\n \"fasting_required\": \"Not required\",\n \"name\": \"CBCT MANDIBLE\",\n \"label\": \"CBCT MANDIBLE\",\n \"mrp\": 2400.0,\n \"category\": \"test\",\n \"type\": \"radiology\"\n },\n {\n \"test_id\": \"5004\",\n \"sample_type\": \"\",\n \"fasting_required\": \"Not required\",\n \"name\": \"CBCT MAXILLA\",\n \"label\": \"CBCT MAXILLA\",\n \"mrp\": 2400.0,\n \"category\": \"test\",\n \"type\": \"radiology\"\n },\n {\n \"test_id\": \"143\",\n \"sample_type\": \"Serum\",\n \"fasting_required\": \"Not required\",\n \"name\": \"COMPLETE BLOOD COUNT (CBC)\",\n \"label\": \"COMPLETE BLOOD COUNT (CBC)\",\n \"mrp\": 400.0,\n \"category\": \"test\",\n \"type\": \"pathology\"\n },\n {\n \"test_id\": \"5002\",\n \"sample_type\": \"\",\n \"fasting_required\": \"Not required\",\n \"name\": \"CBCT 3D FULL SKULL\",\n \"label\": \"CBCT 3D FULL SKULL\",\n \"mrp\": 2400.0,\n \"category\": \"test\",\n \"type\": \"radiology\"\n },\n {\n \"test_id\": \"5001\",\n \"sample_type\": \"\",\n \"fasting_required\": \"Not required\",\n \"name\": \"CBCT 3D FULL JAW\",\n \"label\": \"CBCT 3D FULL JAW\",\n \"mrp\": 2400.0,\n \"category\": \"test\",\n \"type\": \"radiology\"\n },\n {\n \"test_id\": \"5005\",\n \"sample_type\": \"\",\n \"fasting_required\": \"Not required\",\n \"name\": \"CBCT SMALL SECTION 5X5 CM\",\n \"label\": \"CBCT SMALL SECTION 5X5 CM\",\n \"mrp\": 1200.0,\n \"category\": \"test\",\n \"type\": \"radiology\"\n },\n {\n \"test_id\": \"1001\",\n \"sample_type\": \"\",\n \"fasting_required\": \"Not required\",\n \"name\": \"Kenko PPMC Package\",\n \"label\": \"CBC, Thyroid profile, HbA1c, LFT, Lipid profile, Kidney profile\",\n \"mrp\": 1500,\n \"category\": \"test\",\n \"type\": \"pathology\"\n }\n ]\n}"},{"id":"50e0456c-46f4-4e4d-9f32-8acceb78acc7","name":"Success - Home visit tests only","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"url":{"raw":"{{host_url}}/partner/diagnostics/skus/online/search/li?sample_collection=home_visit&partner_name={{partner_name}}","host":["{{host_url}}"],"path":["partner","diagnostics","skus","online","search","li"],"query":[{"key":"sample_collection","value":"home_visit"},{"key":"partner_name","value":"{{partner_name}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 31 May 2022 11:08:05 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"3120"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"6d22546d-723c-4c9f-912c-d0403ce0caee"},{"key":"x-amz-apigw-id","value":"S_OLUEHthcwFhPQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6295f715-669aea9a544b2c72374ee1ef"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"skus found\",\n \"response\": [\n {\n \"test_id\": \"204\",\n \"sample_type\": \"Serum\",\n \"fasting_required\": \"8-12hrs\",\n \"name\": \"LIPASE\",\n \"label\": \"LIPASE\",\n \"mrp\": 560.0,\n \"category\": \"test\",\n \"type\": \"pathology\"\n },\n {\n \"test_id\": \"207\",\n \"sample_type\": \"Blood\",\n \"fasting_required\": \"Not required\",\n \"name\": \"LITHIUM\",\n \"label\": \"LITHIUM\",\n \"mrp\": 1200.0,\n \"category\": \"test\",\n \"type\": \"pathology\"\n },\n {\n \"test_id\": \"205\",\n \"sample_type\": \"Serum\",\n \"fasting_required\": \"Minimum of 10-12hrs\",\n \"name\": \"LIPID PROFILE\",\n \"label\": \"LIPID PROFILE\",\n \"mrp\": 720.0,\n \"category\": \"test\",\n \"type\": \"pathology\"\n },\n {\n \"test_id\": \"208\",\n \"sample_type\": \"Blood\",\n \"fasting_required\": \"10-12hrs\",\n \"name\": \"LIVER FUNCTION TEST\",\n \"label\": \"LIVER FUNCTION TEST\",\n \"mrp\": 710.0,\n \"category\": \"test\",\n \"type\": \"pathology\"\n },\n {\n \"test_id\": \"206\",\n \"sample_type\": \"Blood\",\n \"fasting_required\": \"8-12hrs\",\n \"name\": \"LIPID PROFILE-EXTENDED\",\n \"label\": \"LIPID PROFILE-EXTENDED\",\n \"mrp\": 1450.0,\n \"category\": \"test\",\n \"type\": \"pathology\"\n },\n {\n \"test_id\": \"209\",\n \"sample_type\": \"Blood\",\n \"fasting_required\": \"Not required\",\n \"name\": \"LIPOPROTEIN(A) (LP(A))\",\n \"label\": \"LIPOPROTEIN(A) (LP(A))\",\n \"mrp\": 2000.0,\n \"category\": \"test\",\n \"type\": \"pathology\"\n },\n {\n \"test_id\": \"1001\",\n \"sample_type\": \"\",\n \"fasting_required\": \"Not required\",\n \"name\": \"Kenko PPMC Package\",\n \"label\": \"CBC, Thyroid profile, HbA1c, LFT, Lipid profile, Kidney profile\",\n \"mrp\": 1500,\n \"category\": \"test\",\n \"type\": \"pathology\"\n }\n ]\n}"},{"id":"f6191d97-ce2d-483c-b88a-130948e3d733","name":"Error - No SKU Found","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"url":"{{host_url}}/partner/diagnostics/skus/online/search/amz"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 01 Apr 2022 10:20:53 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"79"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"2e27ad6a-7e91-4822-af04-7dbfc3bcd6d7"},{"key":"x-amz-apigw-id","value":"P5XA4FklBcwFl8A="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6246d205-78ac075e0b38bf356d3a59f3"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"failed\",\n \"message\": \"no sku found!\",\n \"response\": {}\n}"},{"id":"98b474c3-91dc-4c65-ab24-d6a0fa83bcc1","name":"Error - Missing partner name","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"url":"{{host_url}}/partner/diagnostics/skus/online/search/{{test_name}}"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": \"failed\",\n \"message\": \"Missing query parameter partner_name\",\n \"response\": {}\n}"}],"_postman_id":"2eff5e0f-b22d-4e38-835e-6127bb1a148d"},{"name":"Fetch SKU Details V2","id":"8ce5adbc-f204-4e71-89e5-42c6b29218b5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"url":"{{host_url}}/partner/diagnostics/test?test_id={{test_id}}&partner_name={{partner_name}}&pin_code=560103","description":"

Fetch details of any SKU in our inventory by calling Fetch SKU Details V2 API. The API also lists the vendors that are available in the area, based on the given pin code.

Query Params:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Params	Description	Type	Format/Values
`test_id` (required)	Test ID as shown in Search SKU API response	String	Eg: 264,228
`pin_code` (required)	Customer pin code	String	6-digit pincode. Eg: 560103, 560102
`partner_name` (required)	Partner name	String

","urlObject":{"path":["partner","diagnostics","test"],"host":["{{host_url}}"],"query":[{"key":"test_id","value":"{{test_id}}"},{"key":"partner_name","value":"{{partner_name}}"},{"key":"pin_code","value":"560103"}],"variable":[]}},"response":[{"id":"827a5aeb-67a1-45fc-95bf-110cf7133611","name":"Success - Serviceable by MedPay and others","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_key}}","type":"text"},{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":{"raw":"{{host_url}}/partner/diagnostics/test?test_id=264&partner_name={{partner_name}}&pin_code=632014","host":["{{host_url}}"],"path":["partner","diagnostics","test"],"query":[{"key":"test_id","value":"264"},{"key":"partner_name","value":"{{partner_name}}"},{"key":"pin_code","value":"632014"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 11 Apr 2023 09:32:25 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1066"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"bbafbabc-b3ff-4dc1-a114-968c54a16ce4"},{"key":"x-amz-apigw-id","value":"DNNeeEQzhcwFhrQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-64352929-4a5a2bbb1b3d5b893a954687"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"response\": {\n \"test_id\": \"264\",\n \"category\": \"test\",\n \"description\": \"Thyroid Stimulating Hormone or TSH 3rd Generation is one of the essential blood assays to diagnose the presence of TSH levels in the blood. It is one of the preliminary blood tests to diagnose hyperthyroidism. If the TSH Test results reflect abnormal hormonal levels, the doctor might recommend T4 or a complete Thyroid Profile Test.\",\n \"fasting_required\": \"Not required\",\n \"also_known_as\": \"Ultra-Sensitive TSH, TSH Hypersensitive, Sensitive TSH, TSH\",\n \"parameters\": 1,\n \"gender\": \"all\",\n \"recommended_age\": \"0-99\",\n \"result_tat\": \"2 days\",\n \"label\": \"TSH ULTRA - SENSITIVE\",\n \"name\": \"TSH ULTRA - SENSITIVE\",\n \"other_instructions\": \"\",\n \"sample_type\": \"Serum\",\n \"sub_categories\": [\n \"Thyroid\"\n ],\n \"type\": \"pathology\",\n \"labs\": [\n {\n \"lab_id\": \"1002-MDPY-0001-0001\",\n \"name\": \"MedPay Care Network\",\n \"price\": 330\n },\n {\n \"lab_id\": \"1002-THYRO-0001-0001\",\n \"name\": \"Thyrocare Lab\",\n \"price\": 200\n },\n {\n \"lab_id\": \"1002-RCLF-0001-0001\",\n \"name\": \"Redcliffe Lab\",\n \"price\": 219\n }\n ]\n }\n}"},{"id":"040a275e-c252-4465-8939-43568f3c4aeb","name":"Success - Serviceable by MedPay","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_key}}","type":"text"},{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":{"raw":"http://127.0.0.1:9800/partner/diagnostics/test?test_id=264&partner_name={{partner_name}}&pin_code=560102","protocol":"http","host":["127","0","0","1"],"port":"9800","path":["partner","diagnostics","test"],"query":[{"key":"test_id","value":"264"},{"key":"partner_name","value":"{{partner_name}}"},{"key":"pin_code","value":"560102"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1136"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Server","value":"Werkzeug/1.0.1 Python/3.8.9"},{"key":"Date","value":"Tue, 11 Apr 2023 09:43:29 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"response\": {\n \"test_id\": \"264\",\n \"category\": \"test\",\n \"description\": \"Thyroid Stimulating Hormone or TSH 3rd Generation is one of the essential blood assays to diagnose the presence of TSH levels in the blood. It is one of the preliminary blood tests to diagnose hyperthyroidism. If the TSH Test results reflect abnormal hormonal levels, the doctor might recommend T4 or a complete Thyroid Profile Test.\",\n \"fasting_required\": \"Not required\",\n \"also_known_as\": \"Ultra-Sensitive TSH, TSH Hypersensitive, Sensitive TSH, TSH\",\n \"parameters\": 1,\n \"gender\": \"all\",\n \"recommended_age\": \"0-99\",\n \"result_tat\": \"2 days\",\n \"label\": \"TSH ULTRA - SENSITIVE\",\n \"name\": \"TSH ULTRA - SENSITIVE\",\n \"other_instructions\": \"\",\n \"sample_type\": \"Serum\",\n \"sub_categories\": [\n \"Thyroid\"\n ],\n \"type\": \"pathology\",\n \"labs\": [\n {\n \"lab_id\": \"1002-MDPY-0001-0001\",\n \"name\": \"MedPay Care Network\",\n \"price\": 330\n }\n ]\n }\n}"},{"id":"426a6380-10b6-4789-9760-c487750959e1","name":"Error - Pincode not serviceable","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_key}}","type":"text"},{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":{"raw":"{{host_url}}/partner/diagnostics/test?test_id=264&partner_name={{partner_name}}&pin_code=632014","host":["{{host_url}}"],"path":["partner","diagnostics","test"],"query":[{"key":"test_id","value":"264"},{"key":"partner_name","value":"{{partner_name}}"},{"key":"pin_code","value":"632014"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 11 Apr 2023 09:39:11 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"63"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"c8cef9ae-ddbc-46a8-84b6-8145dc15ca5d"},{"key":"x-amz-apigw-id","value":"DNOd_GWDhcwFnfQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-64352abf-2a3fa6e6120679d22899f6f4"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"failed\",\n \"message\": \"pin code is not serviceable\"\n}"}],"_postman_id":"8ce5adbc-f204-4e71-89e5-42c6b29218b5"},{"name":"Available slots","id":"29fb6a8f-77af-4e83-8321-03ea49f98280","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_key}}","type":"text"},{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":"{{host_url}}/partner/diagnostics/slots?lab_id=1002-THYRO-0001-0001&date=23-06-2023&time_of_day=morning","description":"

Use the Available Slots API to fetch the list of time slots of a particular lab/centre for a particular date and time of day.

\n
Note: All time slots will have a duration of 30 minutes.
\n

Request Params:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Param	Description	Type	Format/Values
`lab_id` (required)	Unique ID of the lab	String	E.g: \"1002-THYRO-0001-0001\"
`date` (required)	Date for which slots are required	String	Date must be of the format `dd-mm-yyyy` For example: 04-02-2022
`time_of_day` (optional)	The preferred time of day	String	Acceptable values: `morning` - 9am - 12pm `afternoon` - 12pm - 3pm `evening` - 3pm -6pm `night` - 6pm - 9pm If no values are provided, slots for the whole day will be returned.

\n
Note: In case the requested date is in the past, or the combination of date and time of day is past the current portion of the day, an error will be returned. For example, if the current date/time is 01-01-2022, 11 AM and slots are requested for 31-12-2021 afternoon or 01-01-2022 morning , the endpoint will return an error.
Note: * In case slots are requested for the current date and time of day, only future slots in the current time of day will be returned. For example, if the current date/time is 01-01-2022 10.45 AM and slots are requested for 01-01-2022 morning, only slots from 11 AM - 12 PM will be returned.
\n

\n","urlObject":{"path":["partner","diagnostics","slots"],"host":["{{host_url}}"],"query":[{"key":"lab_id","value":"1002-THYRO-0001-0001"},{"key":"date","value":"23-06-2023"},{"key":"time_of_day","value":"morning"}],"variable":[]}},"response":[],"_postman_id":"29fb6a8f-77af-4e83-8321-03ea49f98280"},{"name":"[DEPRECATED] Get Order Status","id":"cbceb19d-0fc2-47f9-a43a-8edc3599af2f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"description":"

We have deprecated this API, please register a callback URL to make use of MedPay Partner Webhooks.

\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"cbceb19d-0fc2-47f9-a43a-8edc3599af2f"},{"name":"[DEPRECATED] Fetch SKU details","id":"696fbb15-8c65-499c-9034-4b5d7965fe4a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"url":"{{host_url}}/partner/diagnostics/skus/online/sku?sku_id=143,218&partner_name={{partner_name}}","description":"

\n
Note: This API will be deprecated by 15 April 2023. Please use the Fetch SKU details V2 for all further integrations.
\n

Fetch details of any SKU in our inventory by calling SKU Details API. The maximum number of SKUs that can be fetched in a single request is 10.

Path Params:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Param	Description	Type	Format/Values
`sku_ids` (required)	Comma separated string of SKU ids	String	Eg. 143,218
`partner_name` (optional)	Partner name	String	Must be provided to get details of discounted price.

","urlObject":{"path":["partner","diagnostics","skus","online","sku"],"host":["{{host_url}}"],"query":[{"key":"sku_id","value":"143,218"},{"key":"partner_name","value":"{{partner_name}}"}],"variable":[]}},"response":[{"id":"499663a5-afe7-48ad-beea-f5f2c1b684a2","name":"Success - Response without discounted price","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"url":{"raw":"{{host_url}}/partner/diagnostics/skus/online/sku?sku_id=243,190","host":["{{host_url}}"],"path":["partner","diagnostics","skus","online","sku"],"query":[{"key":"sku_id","value":"243,190"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"response\": [\n {\n \"sku_id\": \"243\",\n \"sub_category\": [],\n \"label\": \"SGPT/ALT\",\n \"mrp\": 160.0,\n \"fasting_required\": \"Not required\",\n \"other_instructions\": \"\",\n \"name\": \"SGPT/ALT\",\n \"category\": \"test\",\n \"composition\": \"\",\n \"sample_type\": \"Blood\",\n \"description\": \"Used to assess kidney damage, measures the liver enzyme AST-aspartate serum transferase\",\n \"type\": \"pathology\",\n \"status\": \"available\"\n },\n {\n \"sku_id\": \"190\",\n \"sub_category\": [],\n \"label\": \"HLA B27\",\n \"mrp\": 2500.0,\n \"fasting_required\": \"Not required\",\n \"other_instructions\": \"\",\n \"name\": \"HLA B27\",\n \"category\": \"test\",\n \"composition\": \"\",\n \"sample_type\": \"Blood\",\n \"description\": \"Indicates the risk of growing certain autoimmune disorders\",\n \"type\": \"pathology\",\n \"status\": \"available\"\n }\n ]\n}"},{"id":"4341e0b3-f50d-4e0c-91ea-dde8115a6f99","name":"Success - Response with partner discount","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"url":{"raw":"{{host_url}}/partner/diagnostics/skus/online/sku?sku_id=150&partner_name={{partner_name}}","host":["{{host_url}}"],"path":["partner","diagnostics","skus","online","sku"],"query":[{"key":"sku_id","value":"150"},{"key":"partner_name","value":"{{partner_name}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 03 Aug 2022 09:09:33 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"625"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"c9e5aacb-03e1-47c9-b6b9-81ee5a9f4b75"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"WR40KHRZhcwFVLA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-62ea3b4d-22a9879776b08204474aa073"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"response\": [\n {\n \"sku_id\": \"150\",\n \"sub_category\": [],\n \"label\": \"CULTURE & SENSITIVITY, AEROBIC BACTERIA\",\n \"mrp\": 710.0,\n \"fasting_required\": \"Not required\",\n \"other_instructions\": \"\",\n \"name\": \"CULTURE & SENSITIVITY, AEROBIC BACTERIA\",\n \"category\": \"test\",\n \"composition\": \"\",\n \"sample_type\": \"Urine\",\n \"description\": \"Tests that detects bacterial growth in UTI patients\",\n \"type\": \"pathology\",\n \"status\": \"available\",\n \"discounted_price\": 603.5\n }\n ]\n}"},{"id":"285c9614-af73-48ff-8045-7d4794623907","name":"Success - Multiple SKUs","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"url":{"raw":"{{host_url}}/partner/diagnostics/skus/online/sku?sku_id=243,190&partner_name={{partner_name}}","host":["{{host_url}}"],"path":["partner","diagnostics","skus","online","sku"],"query":[{"key":"sku_id","value":"243,190"},{"key":"partner_name","value":"{{partner_name}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 03 Aug 2022 09:12:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1117"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"32bde8a0-246d-4dee-9810-50caacf64b82"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"WR5M7GbeBcwFYqQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-62ea3bec-2b4833b30366bc1d3f39ef7e"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"response\": [\n {\n \"sku_id\": \"243\",\n \"sub_category\": [],\n \"label\": \"SGPT/ALT\",\n \"mrp\": 160.0,\n \"fasting_required\": \"Not required\",\n \"other_instructions\": \"\",\n \"name\": \"SGPT/ALT\",\n \"category\": \"test\",\n \"composition\": \"\",\n \"sample_type\": \"Blood\",\n \"description\": \"Used to assess kidney damage, measures the liver enzyme AST-aspartate serum transferase\",\n \"type\": \"pathology\",\n \"status\": \"available\",\n \"discounted_price\": 136.0\n },\n {\n \"sku_id\": \"190\",\n \"sub_category\": [],\n \"label\": \"HLA B27\",\n \"mrp\": 2500.0,\n \"fasting_required\": \"Not required\",\n \"other_instructions\": \"\",\n \"name\": \"HLA B27\",\n \"category\": \"test\",\n \"composition\": \"\",\n \"sample_type\": \"Blood\",\n \"description\": \"Indicates the risk of growing certain autoimmune disorders\",\n \"type\": \"pathology\",\n \"status\": \"available\",\n \"discounted_price\": 2125.0\n }\n ]\n}"}],"_postman_id":"696fbb15-8c65-499c-9034-4b5d7965fe4a"},{"name":"Create Order","id":"ffdc3f39-a4e1-4c85-9b76-09627f0094df","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"body":{"mode":"raw","raw":"{ \n \"partner_order_id\": \"{{partner_order_id}}\",\n \"partner_name\": \"{{partner_name}}\",\n \"sample_collection\": \"home_visit\",\n \"payment_collection\": \"medpay\",\n \"time_slot\": \"09-03-2022, 05:00 PM\",\n \"customer_details\": {\n \"name\": \"Jane Doe\",\n \"mobile\": \"1234567890\",\n \"gender\": \"female\",\n \"age\": 29,\n \"alternative_mobile\": \"\",\n \"email\": \"xyz@email.in\",\n \"address_details\": {\n \"address\": \"1/6, Gandhi Nagar, pune\",\n \"landmark\": \"gandhi nagar\",\n \"pin_code\": \"126102\",\n \"city\": \"pune\",\n \"state\": \"mumbai\",\n \"coordinates\":\"29.3156909,76.3212837\"\n }\n },\n \"order_details\": {\n \"prescription_links\": [],\n \"items\": [\n { \n \"test_id\": \"190\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/diagnostics/order/online/create","description":"

Use Create Order API to place a diagnostic test order for home pickup. MedPay will find a clinic in our Connected Care Network that is closest to the customer address to fulfil the order.

Note: Customer's location coordinates (lat-long) are mandatory within _customer_details_ to ensure seamless delivery of the order.

Request Params:

Param	Description	Type	Format/Values
`partner_order_id` (required)	Partner Order id	String	Unique order ID passed by the Partner. Partner Order ID can only contain letters, numbers, underscores(_) and hyphens(-).
`partner_name` (required)	Name of the partner placing the order	String	Value shared with API access details. Partner name must be more than 3 characters long
`lab_id` (optional)	Unique ID of the lab	String	E.g: \"1002-THYRO-0001-0001\"
`payment_collection` (required)	Payment collection type reference	String	self, medpay
`sample_collection` (required)	Type of delivery mode	String	home_visit (Pass this value for home pickup of samples)
`time_slot` (required)	Preferred time slot for appointment. This may be subject to change depending on the phloebo's availability.	String	E.g. `12-05-2022, 03:00 PM`
`customer_details` (required)	Customer meta data	Map[object]
`name` (required)	Customer name	String	Maximum length: 255 char. For e.g, John Doe
`mobile` (required)	10 digits mobile number	String	E.g. `880XXXXXXX`
`gender` (optional)	Customer gender	String	Male/Female/Other
`age` (optional)	Customer age	Integer	Age must be between 0 - 99
`alternative_mobile_number` (optional)	10 digits alternate mobile number	String	E.g. `880XXXXXXX`
`email` (optional)	Customer valid email id	String	E.g. `xyz@email.in`
`address_details` (required)	Customer address meta data	Map[object]
`address` (required)	Customer full address	String	Minimum length: 2 char
`landmark` (required)	Customer address landmark	String	Minimum length: 2 char
`pin_code` (required)	Customer address pincode	String	6-digit pincode
`city` (required)	Customer address city	String	Minimum length: 2 char
`state` (required)	Customer address state	String	Minimum length: 2 char
`coordinates` (required)	Comma-separated lat & long	String	e.g `29.3156909,76.3212837`
`order_details` (required)	Order details	Map[object]
`prescription_links` (required)	List of valid prescription URLs	List	For e.g. [\"http://www.example.com/index.html\"]
`items` (required)	List of valid test_ids	List
`test_id` (required)	Test ID received from the Search SKU API	String	e.g `46038`

","urlObject":{"path":["partner","diagnostics","order","online","create"],"host":["{{host_url}}"],"query":[],"variable":[]}},"response":[{"id":"d75182db-cabf-493f-a983-45e0686479e2","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"raw","raw":"{ \n \"partner_order_id\": \"{{partner_order_id}}\",\n \"partner_name\": \"{{partner_name}}\",\n \"sample_collection\": \"home_visit\",\n \"payment_collection\": \"medpay\",\n \"time_slot\": \"09-03-2022, 05:00 PM\",\n \"customer_details\": {\n \"name\": \"Jane Doe\",\n \"mobile\": \"1234567890\",\n \"gender\": \"female\",\n \"age\": 29,\n \"alternative_mobile\": \"\",\n \"email\": \"xyz@email.in\",\n \"address_details\": {\n \"address\": \"1/6, Gandhi Nagar, pune\",\n \"landmark\": \"gandhi nagar\",\n \"pin_code\": \"126102\",\n \"city\": \"pune\",\n \"state\": \"mumbai\",\n \"coordinates\":\"29.3156909,76.3212837\"\n }\n },\n \"order_details\": {\n \"prescription_links\": [],\n \"items\": [\n { \n \"test_id\": \"190\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/diagnostics/order/online/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 27 Aug 2021 08:06:30 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1218"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"dde412c7-049b-49ba-8940-786636b63aa4"},{"key":"x-amz-apigw-id","value":"Et140HrSBcwFsYw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-61289d05-49fe63f52e4c21b32ebca4a8"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"order created successfully.\",\n \"response\": {\n \"partner_order_id\": \"1001\",\n \"payment_collection\": \"medpay\",\n \"sample_collection\": \"home_visit\",\n \"partner_name\": \"testpartner\",\n \"order_status\": \"pending\",\n \"time_slot\": \"09-03-2022, 05:00 PM\",\n \"lab_id\": \"\",\n \"customer_details\": {\n \"name\": \"Jane Doe\",\n \"mobile\": \"1234567890\",\n \"gender\": \"female\",\n \"age\": 29,\n \"alternative_mobile\": \"\",\n \"email\": \"xyz@email.in\",\n \"address_details\": {\n \"address\": \"1/6, Gandhi Nagar, pune\",\n \"landmark\": \"gandhi nagar\",\n \"pin_code\": \"126102\",\n \"city\": \"Pune\",\n \"state\": \"mumbai\"\n }\n },\n \"order_details\": {\n \"prescription_links\": [],\n \"items\": [\n {\n \"test_id\": \"190\",\n \"item\": \"HLA B27\",\n \"details\": \"Test : HLA B27\",\n \"MRP\": \"2500\",\n \"amount\": \"2500\",\n \"sample_type\": \"Blood\",\n \"fasting_required\": \"Not required\",\n \"description\": \"Indicates the risk of growing certain autoimmune disorders\"\n }\n ]\n },\n \"created_by\": \"testpartner\",\n \"created_at\": \"21/02/2023 19:28:02.347650\"\n }\n}"},{"id":"8e22e0c5-74c3-45a4-8491-f6cfe14b2960","name":"Error - Missing sample_collection","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{ \n \"lab_id\": \"1002-5744-7299-6215\",\n \"partner_order_id\": \"Lab4\",\n \"partner_name\": \"practo\",\n \"payment_collection\": \"medpay\",\n \"customer_details\": {\n \"name\": \"John Doe\",\n \"mobile\": \"8800880088\",\n \"gender\": \"male\",\n \"age\": 29,\n \"alternative_mobile\": \"\",\n \"email\": \"xyz@email.in\",\n \"address_details\": {\n \"address\": \"1/6, Gandhi Nagar, pune\",\n \"landmark\": \"gandhi nagar\",\n \"pin_code\": \"126102\",\n \"city\": \"pune\",\n \"state\": \"mumbai\",\n \"coordinates\":\"29.3156909,76.3212837\"\n }\n },\n \"order_details\": {\n \"prescription_links\": [],\n \"items\": [\n { \n \"sku_id\": \"1\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/diagnostics/order/online/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 27 Aug 2021 08:07:33 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"150"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"ccb2de46-9f19-465f-a72c-f4f540e2d803"},{"key":"x-amz-apigw-id","value":"Et2C4GTghcwFfkw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-61289d45-1c312f1b6f9dfcd61ccaaa69"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": {\n \"sample_collection\": \"'sample_collection' is a required property\"\n },\n \"message\": \"Input payload validation failed\"\n}"},{"id":"026958a0-205c-4ec6-b9f2-0f08fc8a351d","name":"Error - Duplicate Order ID","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{ \n \"lab_id\": \"1002-5744-7299-6215\",\n \"partner_order_id\": \"Lab4\",\n \"partner_name\": \"practo\",\n \"sample_collection\": \"home_visit\",\n \"payment_collection\": \"medpay\",\n \"customer_details\": {\n \"name\": \"John Doe\",\n \"mobile\": \"8800880088\",\n \"gender\": \"male\",\n \"age\": 29,\n \"alternative_mobile\": \"\",\n \"email\": \"xyz@email.in\",\n \"address_details\": {\n \"address\": \"1/6, Gandhi Nagar, pune\",\n \"landmark\": \"gandhi nagar\",\n \"pin_code\": \"126102\",\n \"city\": \"pune\",\n \"state\": \"mumbai\",\n \"coordinates\":\"29.3156909,76.3212837\"\n }\n },\n \"order_details\": {\n \"prescription_links\": [],\n \"items\": [\n { \n \"sku_id\": \"1\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/diagnostics/order/online/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 27 Aug 2021 08:06:59 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"995"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"636aacc3-6388-4911-a31c-547cb15579db"},{"key":"x-amz-apigw-id","value":"Et19mESYhcwFheA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-61289d23-1d4d232639a7844368f7c93a"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"failed\",\n \"message\": \"order with partner_order_id already exist.\",\n \"response\": {\n \"partner_order_id\": \"Lab7\",\n \"partner_name\": {{partner_name}},\n \"sample_collection\": \"home_visit\",\n \"payment_collection\": \"medpay\",\n \"customer_details\": {\n \"name\": \"Anuj Gupta\",\n \"mobile\": \"8800684733\",\n \"gender\": \"male\",\n \"age\": 29,\n \"alternative_mobile\": \"\",\n \"email\": \"anuj@medpay.in\",\n \"address_details\": {\n \"address\": \"1/6, Gandhi Nagar, Jind\",\n \"landmark\": \"gandhi nagar\",\n \"pin_code\": \"126102\",\n \"city\": \"jind\",\n \"state\": \"haryana\",\n \"coordinates\": \"29.3156909,76.3212837\"\n }\n },\n \"order_details\": {\n \"prescription_links\": [],\n \"items\": [\n {\n \"sku_id\": \"1\"\n }\n ]\n }\n }\n}"}],"_postman_id":"ffdc3f39-a4e1-4c85-9b76-09627f0094df"},{"name":"Confirm Order","id":"ec3ab31a-e632-443d-b3a8-38c6ffc9845b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partner_order_id\": \"{{partner_order_id}}\",\n \"partner_name\": \"{{partner_name}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/diagnostics/order/confirm","description":"

In case the order was modified by MedPay(In the event of changes to requested clinic, appointment date/time, etc.), use the Partner Confirmation API to confirm that the changes are acceptable to the patient.

\n
Note: This API has to be called only if an order is in partner_pending state.
\n

Request Params:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Param	Description	Type	Format/Values
`partner_order_id` (required)	Partner Order id	String	Unique order id passed by the Partner
`partner_name` (required)	Name of the partner placing the order	String	Values shared with API access details

","urlObject":{"path":["partner","diagnostics","order","confirm"],"host":["{{host_url}}"],"query":[],"variable":[]}},"response":[{"id":"1f7b1f5f-f82e-4078-8819-84b527a671f8","name":"Success - Modifications confirmed","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partner_order_id\": \"10020\",\n \"partner_name\": \"{{partner_name}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/diagnostics/order/confirm"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 01 Apr 2022 10:33:34 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"818"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"d63f5e71-0a74-46ee-a8e0-7282b065ffb0"},{"key":"x-amz-apigw-id","value":"P5Y3eGHEBcwFQWg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6246d4fc-534d532a5dd3280f1b479115"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"invoice generated successfully.\",\n \"response\": {\n \"partner_order_id\": \"10020\",\n \"partner_name\": \"testpartner\",\n \"order_details\": {\n \"items\": [\n {\n \"item\": \"CSF INDIA INK PREPARATION\",\n \"amount\": \"270.0\",\n \"quantity\": null,\n \"gst\": \"0\",\n \"sku_id\": \"143\",\n \"details\": \"Test : CSF INDIA INK PREPARATION\",\n \"MRP\": \"270\",\n \"test_id\": \"143\"\n }\n ],\n \"prescription_links\": []\n },\n \"order_status\": \"invoice_generated\",\n \"created_at\": \"01/04/2022 15:52:55.364266\",\n \"modified_at\": \"01/04/2022 16:03:33.991483\"\n }\n}"},{"id":"e5c24a36-8788-4134-aea5-b56939a083b5","name":"Error - Already confirmed","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partner_order_id\": \"{{partner_order_id}}\",\n \"partner_name\": \"{{partner_name}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/diagnostics/order/confirm"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 01 Apr 2022 10:40:34 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"172"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"d142afde-3f4b-4110-a1b5-c2c43a517ce7"},{"key":"x-amz-apigw-id","value":"P5Z5YEB2hcwFd0A="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6246d6a2-5952c6451c80488443e53d3b"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"failed\",\n \"message\": \"order is already confirmed\",\n \"response\": {\n \"partner_order_id\": \"10020\",\n \"partner_name\": \"testpartner\"\n }\n}"}],"_postman_id":"ec3ab31a-e632-443d-b3a8-38c6ffc9845b"},{"name":"Update Payment Status","id":"12a7720f-507c-447b-8c48-620b01aff793","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partner_order_id\": \"{{partner_order_id}}\",\n \"invoice_id\": \"inv113212418949896\",\n \"partner_name\": \"{{partner_name}}\",\n \"payment_details\": {\n \"reference_id\": \"3213\",\n \"net_amount\": \"2500\",\n \"payment_type\": \"card\",\n \"payment_timestamp\": \"\",\n \"notes\": \"\"\n },\n \"patient_payable\": \"0\",\n \"payer_payable\": \"2500\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/diagnostics/order/payment/confirm","description":"

Use the Update Payment Status API to provide confirmation on the payment status.

\n
Note: Payment confirmation is required from partner before the order status can be updated.\nNote: Payment can be made fully or partially, in which case, the patient has to complete the payment to update the order status. The link for patient to complete payment will be provided in the webhook notification and sent directly to the patient via WhatsApp message.
\n

Request Params:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Param	Description	Type	Format/Values
`partner_order_id` (required)	Partner Order id	String	Unique order id passed by the Partner
`partner_name` (required)	Name of the partner placing the order	String	Values shared with API access details
`invoice_id` (required)	Unique invoice id generated by MedPay when order status changes to invoice_generated	String	E.g \"inv187258418906901\"
`payment_details` (required)	Payment meta data	Map[object]	E.g \"inv187258418906901\"
`reference_id` (required)	Unique payment reference ID generated by Partner	String	E.g \"32132323\"
`net_amount` (required)	Amount paid by the patient	String	E.g \"201.50\"
`payment_type` (required)	Payment mode type	String	Acceptable values: card, upi, internet_banking, voucher, other
`payment_timestamp` (optional)	Payment Timestamp	String
`notes` (optional)	Notes	String	To pass additional notes
`payer_payable` (required)	Amount paid by the payer	String	E.g \"201.50\"
`patient_payable` (required)	Amount paid by the patient	String	E.g \"1.50\"

","urlObject":{"path":["partner","diagnostics","order","payment","confirm"],"host":["{{host_url}}"],"query":[],"variable":[]}},"response":[{"id":"eaed2103-1f4e-41af-88f0-faa1db169b39","name":"Success - Full Payment","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partner_order_id\": \"1009\",\n \"invoice_id\": \"inv113212418949896\",\n \"partner_name\": \"{{partner_name}}\",\n \"payment_details\": {\n \"reference_id\": \"3213\",\n \"net_amount\": \"2500\",\n \"payment_type\": \"card\",\n \"payment_timestamp\": \"\",\n \"notes\": \"\"\n },\n \"patient_payable\": \"0\",\n \"payer_payable\": \"2500\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/diagnostics/order/payment/confirm"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 01 Apr 2022 11:18:10 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"615"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"022c5f1d-3b71-4d75-8d0c-92b6eb15c38a"},{"key":"x-amz-apigw-id","value":"P5fZ1FH9hcwFmgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6246df71-3537dbc763c0931a34f62a33"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"payment confirmed successfully.\",\n \"response\": {\n \"partner_order_id\": \"1009\",\n \"partner_name\": \"testpartner\",\n \"invoice_id\": \"inv113212418949896\",\n \"payment_status\": \"success\",\n \"payment_details\": {\n \"reference_id\": \"3213\",\n \"net_amount\": \"2500\",\n \"payment_type\": \"card\",\n \"payment_timestamp\": \"\",\n \"notes\": \"\"\n },\n \"order_status\": \"payment_collected\",\n \"created_at\": \"22/02/2023 11:38:32.090548\",\n \"modified_at\": \"22/02/2023 12:18:06.600307\"\n }\n}"},{"id":"2e1428f2-905c-4d5c-bc19-fc250c553e84","name":"Success - Partial payment","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partner_order_id\": \"10021\",\n \"invoice_id\": \"inv295654283689134\",\n \"partner_name\": \"{{partner_name}}\",\n \"payment_details\": {\n \"reference_id\": \"3213\",\n \"net_amount\": \"460\",\n \"payment_type\": \"card\",\n \"payment_timestamp\": \"\",\n \"notes\": \"\"\n },\n \"payer_payable\": \"400\",\n \"patient_payable\": \"60\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/diagnostics/order/payment/confirm"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 01 Apr 2022 11:20:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"688"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"dc632114-96d6-4a9c-b5f9-a7ac6ec81716"},{"key":"x-amz-apigw-id","value":"P5fsUFXMBcwFpDg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6246dfe8-6958afe160c1c50f47f48882"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"payment confirmed successfully.\",\n \"response\": {\n \"partner_order_id\": \"10021\",\n \"partner_name\": \"testpartner\",\n \"invoice_id\": \"inv295654283689134\",\n \"payment_status\": \"success\",\n \"payment_details\": {\n \"reference_id\": \"3213\",\n \"net_amount\": \"460\",\n \"payment_type\": \"card\",\n \"payment_timestamp\": \"\",\n \"notes\": \"\",\n \"payer_payable\": \"400\",\n \"patient_payable\": \"60\"\n },\n \"order_status\": \"payment_collected\",\n \"created_at\": \"01/04/2022 15:54:10.697525\",\n \"modified_at\": \"01/04/2022 16:50:08.407404\"\n }\n}"},{"id":"699c2ed5-56ba-4d87-8709-bd4454684735","name":"Error - Payment Already Confirmed","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partner_order_id\": \"10020\",\n \"invoice_id\": \"inv236384093378023\",\n \"partner_name\": \"{{partner_name}}\",\n \"payment_details\": {\n \"reference_id\": \"3213\",\n \"net_amount\": \"270\",\n \"payment_type\": \"card\",\n \"payment_timestamp\": \"\",\n \"notes\": \"\"\n },\n \"patient_payable\": \"0\",\n \"payer_payable\": \"270\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/diagnostics/order/payment/confirm"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 01 Apr 2022 11:18:32 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"115"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"7f91d63c-2b45-4652-beb6-7287c5df010a"},{"key":"x-amz-apigw-id","value":"P5fdVEJjhcwFd1g="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6246df88-551db8b519ade5034e313dff"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"failed\",\n \"message\": \"payment cannot be confirmed or already confirmed.\",\n \"response\": {}\n}"},{"id":"89532a19-e5d0-4c3a-8b27-3fc78b5afa98","name":"Error - Incorrect Invoice ID","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partner_order_id\": \"10020\",\n \"invoice_id\": \"inv236384093378023\",\n \"partner_name\": \"{{partner_name}}\",\n \"payment_details\": {\n \"reference_id\": \"3213\",\n \"net_amount\": \"270\",\n \"payment_type\": \"card\",\n \"payment_timestamp\": \"\",\n \"notes\": \"\"\n },\n \"patient_payable\": \"0\",\n \"payer_payable\": \"270\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/diagnostics/order/payment/confirm"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 01 Apr 2022 11:18:55 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"118"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"aceed4e7-2e0a-4a86-bb92-3272a644ba7b"},{"key":"x-amz-apigw-id","value":"P5fg6HpmBcwFr6A="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6246df9f-605792a526c09b70616bbdd0"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"failed\",\n \"message\": \"partial amount is not acceptable for net_amount: 270\",\n \"response\": {}\n}"}],"_postman_id":"12a7720f-507c-447b-8c48-620b01aff793"},{"name":"Cancel Order","id":"8fd2f05b-3301-42aa-9109-ad8e04a55874","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partner_order_id\": \"{{partner_order_id}}\",\n \"partner_name\": \"{{partner_name}}\",\n \"cancellation_code\": \"CC08\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/diagnostics/order/cancel","description":"

Use the Cancel Order API to cancel an existing order. An order can be cancelled if it is in the following states:

pending
partner_pending
accepted
invoice_generated
payment_pending

\n
Note: Order cancellation will be processed based on the state of the order and not the time of appointment.
\n

Request Params:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Param	Description	Type	Format/Values
`partner_order_id` (required)	Partner Order ID	String	Unique order id passed by the Partner
`partner_name` (required)	Name of the partner placing the order	String	Values shared with API access details
`cancellation_code` (required)	Code for cancellation	String	Acceptable cancellation codes are tabulated below.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Cancellation Code	Cancellation Reason
CC01	Payment not done
CC08	Patient not happy with alternate provider / timings
CC09	No confirmation from patient
CC10	Patient refused sample pick-up

\n
Note: Currently, the Cancel Order API allows either a free-text cancellation reason or a cancellation code that uniquely identifies a specific cancellation reason. From 28 February 2023, the cancelled_reason field will be deprecated and cancellation_code will be made mandatory.
\n

\n","urlObject":{"path":["partner","diagnostics","order","cancel"],"host":["{{host_url}}"],"query":[],"variable":[]}},"response":[{"id":"25b36f8f-5389-4011-82dc-1f73cf1a74bd","name":"Error - Order already cancelled","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"partner_order_id\": \"{{partner_order_id}}\",\n \"partner_name\": \"{{partner_name}}\",\n \"cancellation_code\": \"CC08\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/diagnostics/order/cancel"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 27 Aug 2021 08:09:15 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"228"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"ddecfb26-1389-4a03-9f6b-76d224bb612c"},{"key":"x-amz-apigw-id","value":"Et2SxEFXhcwFTXg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-61289dab-59cf732e520efea348b92f17"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"failed\",\n \"message\": \"order partner id: 1009 is already cancelled.\",\n \"response\": {\n \"partner_order_id\": \"1009\",\n \"partner_name\": \"testpartner\",\n \"cancellation_code\": \"CC08\"\n }\n}"},{"id":"7a52c876-9508-4cbb-b948-ee00e750af4b","name":"Success - Order cancelled","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partner_order_id\": \"10022\",\n \"partner_name\": \"{{partner_name}}\",\n \"cancelled_reason\": \"not required\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/diagnostics/order/cancel"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 01 Apr 2022 10:34:52 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"350"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"c9dcb39f-052f-4292-82a6-27deac9cd13b"},{"key":"x-amz-apigw-id","value":"P5ZD6F9JhcwFoKQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6246d54c-306ecb0a6790aa6d0cb322ea"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"order cancelled successfully.\",\n \"response\": {\n \"partner_order_id\": \"22021135\",\n \"partner_name\": \"testpartner\",\n \"order_status\": \"cancelled\",\n \"cancelled_reason\": \"Patient not happy with alternate provider / timings\",\n \"cancelled_by\": \"testpartner\",\n \"cancelled_at\": \"22/02/2023 12:23:01.462641\"\n }\n}"}],"_postman_id":"8fd2f05b-3301-42aa-9109-ad8e04a55874"}],"id":"e8625f87-0fd3-4c8a-aabb-f5cea9f495d6","description":"

Partner Webhooks:

Partners can configure a webhook URL to receive real-time push notifications about ongoing orders. MedPay will POST the most up-to-date information about each order whenever the order status is updated, so that it can be communicated to the user. We enable clients to register their own callback URL to receive notifications related to the status change of an Order/Invoice.

\n
Note: Response fields may vary, as per current order states.
\n

Webhook URL: Please share webhook_url to get timely order updates.

Method: POST

Events:

partner_pending
accepted
invoice_generated
payment_pending
payment_collected
sample_collected
reports_generated
cancelled

Sample webhook POST Event structure:

partner-pending:

{\n  \"partner_order_id\": \"diagno1\",\n  \"partner_name\": \"uat_partner\",\n  \"order_status\": \"partner_pending\",\n  \"booking_details\": {\n    \"name\": \"Hi Tech Pathology Laboratory\",\n    \"address\": \"Neeta Park, GVXQ+FQ2, Airport Rd, White House Society, Yerawada, Pune, Maharashtra 411006, India\",\n    \"coordinates\": \"18.5486294,73.8894048\",\n    \"time_slot\": \"24-02-2023, 09:00 AM\",\n    \"change_type\": \"rescheduled\",\n    \"requested_booking_details\": {\n      \"name\": \"Hi Tech Pathology Laboratory\",\n      \"address\": \"Neeta Park, GVXQ+FQ2, Airport Rd, White House Society, Yerawada, Pune, Maharashtra 411006, India\",\n      \"coordinates\": \"18.5486294,73.8894048\",\n      \"time_slot\": \"28-02-2023, 10:00 AM\"\n    }\n  },\n  \"timestamp\": \"22/02/2023 16:32:14.154563\"\n}\n\n

order-accepted:

{\n  \"partner_order_id\": \"diagno1\",\n  \"partner_name\": \"uat_partner\",\n  \"order_status\": \"accepted\",\n  \"timestamp\": \"22/02/2023 16:40:15.070597\",\n  \"booking_details\": {\n    \"name\": \"Hi Tech Pathology Laboratory\",\n    \"address\": \"Neeta Park, GVXQ+FQ2, Airport Rd, White House Society, Yerawada, Pune, Maharashtra 411006, India\",\n    \"coordinates\": \"18.5486294,73.8894048\",\n    \"time_slot\": \"09-03-2022, 05:00 PM\"\n  }\n}\n\n

invoice-generated:

{\n  \"partner_order_id\": \"diagno1\",\n  \"partner_name\": \"uat_partner\",\n  \"order_status\": \"invoice_generated\",\n  \"invoice_details\": {\n    \"partner_discount\": \"0.0\",\n    \"tgst\": \"0.0\",\n    \"bill_amount\": \"2500.0\",\n    \"invoice_no\": null,\n    \"payment_status\": \"pending\",\n    \"invoice_id\": \"inv119454704256904\",\n    \"payment_collection\": \"medpay\",\n    \"net_amount\": \"2500.0\",\n    \"invoice_link\": \"https://mdpy.in/T07S8sUBV1\"\n  },\n  \"timestamp\": \"22/02/2023 16:40:16.567199\"\n}\n\n

payment-pending:

{\n  \"partner_order_id\": \"diagno_1\",\n  \"partner_name\": \"uat_partner\",\n  \"order_status\": \"payment_pending\",\n  \"payment_details\": {\n    \"payment_timestamp\": \"\",\n    \"payment_type\": \"card\",\n    \"net_amount\": \"460\",\n    \"notes\": \"\",\n    \"reference_id\": \"3213\",\n    \"payer_payable\": \"360.0\",\n    \"patient_payable\": \"100.0\",\n    \"patient_payable_details\": {\n      \"transaction_id\": \"REQ123412341234\",\n      \"link\": \"https://mdpy.in/8U88g000Jc\",\n      \"status\": \"payment link sent successfully\",\n      \"timestamp\": \"06/06/2022 12:05:31.092986\"\n    }\n  },\n  \"timestamp\": \"06/06/2022 12:05:30.282692\"\n}\n\n

payment-collected:

{\n  \"partner_order_id\": \"22021140\",\n  \"partner_name\": \"testpartner\",\n  \"order_status\": \"payment_collected\",\n  \"payment_details\": {\n    \"payment_timestamp\": \"\",\n    \"payment_type\": \"card\",\n    \"net_amount\": \"2500\",\n    \"notes\": \"\",\n    \"reference_id\": \"3213\"\n  },\n  \"timestamp\": \"22/02/2023 16:43:29.105604\"\n}\n\n

sample-collected:

{\n  \"partner_order_id\": \"diagno1\",\n  \"partner_name\": \"uat_ppartner\",\n  \"order_status\": \"sample_collected\",\n  \"timestamp\": \"06/06/2022 12:25:27.013538\"\n}\n\n

reports-generated:

{\n  \"partner_order_id\": \"diagno1\",\n  \"partner_name\": \"uat_partner\",\n  \"order_status\": \"reports_generated\",\n  \"timestamp\": \"22/02/2023 16:46:51.384277\",\n  \"reports_details\": {\n    \"links\": [\n      \"https://medpay-diagnostics-reports-dev.s3.ap-southeast-1.amazonaws.com/077F1006_339F_4221_894C_E1F59171883F_702_000000A65966FC75_1677064582.jpeg\",\n      \"https://medpay-diagnostics-reports-dev.s3.ap-southeast-1.amazonaws.com/22222_1677064598.jpeg\"\n    ]\n  }\n}\n\n

order-cancelled:

{\n  \"partner_order_id\": \"diagno1\",\n  \"partner_name\": \"uat_partner\",\n  \"order_status\": \"cancelled\",\n  \"cancelled_reason\": \"Home sample collection not possible for the patient\",\n  \"timestamp\": \"22/02/2023 16:50:32.916056\"\n}\n\n

","_postman_id":"e8625f87-0fd3-4c8a-aabb-f5cea9f495d6"},{"name":"Self-Visit","item":[{"name":"Search SKUs","id":"5a8fe9aa-e6c5-4795-8133-431765afa7f1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"url":"{{host_url}}/partner/diagnostics/skus/online/search/{{test_name}}?partner_name={{partner_name}}","description":"

Path Params:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Param	Description	Type	Format/Values
`test_name` (required)	String to be searched in the lab tests inventory	String

Query Params:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Param	Description	Type	Format/Values
`partner_name` (required)	Partner name as defined at onboarding	String	E.g.: testpartner
`sample_collection` (optional)	Mode of sample collection	String	`home_visit` or `self_visit`
`category` (optional)	Category of diagnostic test	String	`pathology`/`radiology`/`all`

","urlObject":{"path":["partner","diagnostics","skus","online","search","{{test_name}}"],"host":["{{host_url}}"],"query":[{"key":"partner_name","value":"{{partner_name}}"}],"variable":[]}},"response":[{"id":"1ace7005-4344-4929-a8c8-8d1e96577e02","name":"Success - Single result","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJraWQiOiJDT3g0TSt2TWRISU8xY2UyV2ljXC9haHM4bFRJTTM5dFdUSElWU25ramkzND0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI2YzdxazYxaXV2MGpkb2sybnVrZ2tvNmRm...","type":"text"},{"key":"x-api-key","value":"jIUnbJiwmr4ce7qrmAHdXsCOnxcwdBY6B6f324p3","type":"text"}],"url":{"raw":"https://api.uat.medpay.in/v1/partner/diagnostics/skus/online/search/{{test_name}}?partner_name={{partner_name}}","protocol":"https","host":["api","uat","medpay","in"],"path":["v1","partner","diagnostics","skus","online","search","{{test_name}}"],"query":[{"key":"partner_name","value":"{{partner_name}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 12 Sep 2021 04:54:10 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"295"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"8bd8046c-9750-423a-a140-73863c04d0b0"},{"key":"x-amz-apigw-id","value":"FiIt7GufhcwFbfQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-613d87f2-1881530d7e81c4181e787073"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"skus found\",\n \"response\": [\n {\n \"type\": \"pathology\",\n \"name\": \"Complete Blood Count (CBC)\",\n \"mrp\": 400,\n \"label\": \"Complete Blood Count (CBC)\",\n \"category\": \"test\",\n \"test_id\": \"143\"\n }\n ]\n}"},{"id":"87a12c52-73ca-43ea-b5af-e7630d2c4a5a","name":"Success - Multiple results","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"url":{"raw":"{{host_url}}/partner/diagnostics/skus/online/search/glucose?partner_name={{partner_name}}","host":["{{host_url}}"],"path":["partner","diagnostics","skus","online","search","glucose"],"query":[{"key":"partner_name","value":"{{partner_name}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 01 Apr 2022 10:19:40 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"537"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"fb714f81-352e-415f-a09e-08826a7bdd03"},{"key":"x-amz-apigw-id","value":"P5W1iF2VBcwFjaw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6246d1bc-4cbb5e695e5cb3742d2c7d45"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"skus found\",\n \"response\": [\n {\n \"type\": \"pathology\",\n \"name\": \"Blood Glucose Fasting\",\n \"mrp\": 80,\n \"label\": \"Blood Glucose Fasting\",\n \"category\": \"test\",\n \"test_id\": \"125\"\n },\n {\n \"type\": \"pathology\",\n \"name\": \"Glucose Postprandial\",\n \"mrp\": 80,\n \"label\": \"Glucose Postprandial\",\n \"category\": \"test\",\n \"test_id\": \"169\"\n }\n ]\n}"},{"id":"21ba68ef-bdcc-4c97-9eca-4aeb7d470e71","name":"Success - Radiology results only","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"url":{"raw":"{{host_url}}/partner/diagnostics/skus/online/search/li?category=radiology&partner_name={{partner_name}}","host":["{{host_url}}"],"path":["partner","diagnostics","skus","online","search","li"],"query":[{"key":"category","value":"radiology"},{"key":"partner_name","value":"{{partner_name}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 31 May 2022 11:07:03 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"3351"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a9fbc97e-871c-4c74-b8ab-907c52192253"},{"key":"x-amz-apigw-id","value":"S_OBvE_vBcwFuFw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6295f6d7-7a8d3d180955695303735254"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"skus found\",\n \"response\": [\n {\n \"test_id\": \"5476\",\n \"sample_type\": \"\",\n \"fasting_required\": \"Not required\",\n \"category\": \"test\",\n \"type\": \"radiology\",\n \"label\": \"USG UPPER LIMBS DOPPLER\",\n \"name\": \"USG UPPER LIMBS DOPPLER\",\n \"mrp\": 4800\n },\n {\n \"test_id\": \"5158\",\n \"sample_type\": \"\",\n \"fasting_required\": \"Not required\",\n \"category\": \"test\",\n \"type\": \"radiology\",\n \"label\": \"MRI BOTH LOWER LIMBS\",\n \"name\": \"MRI BOTH LOWER LIMBS\",\n \"mrp\": 7200\n },\n {\n \"test_id\": \"5357\",\n \"sample_type\": \"\",\n \"fasting_required\": \"Not required\",\n \"category\": \"test\",\n \"type\": \"radiology\",\n \"label\": \"MRI UPPER LIMB\",\n \"name\": \"MRI UPPER LIMB\",\n \"mrp\": 7200\n },\n {\n \"test_id\": \"5426\",\n \"sample_type\": \"\",\n \"fasting_required\": \"Not required\",\n \"category\": \"test\",\n \"type\": \"radiology\",\n \"label\": \"USG LOWER LIMB ARTERIAL BOTH\",\n \"name\": \"USG LOWER LIMB ARTERIAL BOTH\",\n \"mrp\": 2480\n },\n {\n \"test_id\": \"5428\",\n \"sample_type\": \"\",\n \"fasting_required\": \"Not required\",\n \"category\": \"test\",\n \"type\": \"radiology\",\n \"label\": \"USG LOWER LIMB ARTERIAL RIGHT\",\n \"name\": \"USG LOWER LIMB ARTERIAL RIGHT\",\n \"mrp\": 1280\n },\n {\n \"test_id\": \"5007\",\n \"sample_type\": \"\",\n \"fasting_required\": \"Not required\",\n \"category\": \"test\",\n \"type\": \"radiology\",\n \"label\": \"CT ABDOMEN (P&C) - DONOR LIVER TRANSPLANT\",\n \"name\": \"CT ABDOMEN (P&C) - DONOR LIVER TRANSPLANT\",\n \"mrp\": 4800\n },\n {\n \"test_id\": \"5475\",\n \"sample_type\": \"\",\n \"fasting_required\": \"Not required\",\n \"category\": \"test\",\n \"type\": \"radiology\",\n \"label\": \"USG UPPER LIMBS ARTERY (BOTH)\",\n \"name\": \"USG UPPER LIMBS ARTERY (BOTH)\",\n \"mrp\": 2480\n },\n {\n \"test_id\": \"5477\",\n \"sample_type\": \"\",\n \"fasting_required\": \"Not required\",\n \"category\": \"test\",\n \"type\": \"radiology\",\n \"label\": \"USG UPPER LIMBS VENOUS (BOTH)\",\n \"name\": \"USG UPPER LIMBS VENOUS (BOTH)\",\n \"mrp\": 2480\n },\n {\n \"test_id\": \"5478\",\n \"sample_type\": \"\",\n \"fasting_required\": \"Not required\",\n \"category\": \"test\",\n \"type\": \"radiology\",\n \"label\": \"USG UPPER LIMBS VENOUS RIGHT\",\n \"name\": \"USG UPPER LIMBS VENOUS RIGHT\",\n \"mrp\": 1280\n },\n {\n \"test_id\": \"5311\",\n \"sample_type\": \"\",\n \"fasting_required\": \"Not required\",\n \"category\": \"test\",\n \"type\": \"radiology\",\n \"label\": \"MRI PERIPHERAL VENOGRAM LOWER LIMBS WITH CONTRAST\",\n \"name\": \"MRI PERIPHERAL VENOGRAM LOWER LIMBS WITH CONTRAST\",\n \"mrp\": 8800\n }\n ]\n}"},{"id":"1383b078-433a-4e48-bc15-4c189dce0553","name":"Error - Missing partner name","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"url":"{{host_url}}/partner/diagnostics/skus/online/search/{{test_name}}"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": \"failed\",\n \"message\": \"Missing query parameter partner_name\",\n \"response\": {}\n}"},{"id":"6a98d565-ff09-4c98-91b5-ff17579b2ea6","name":"Error - No SKU Found","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"url":{"raw":"{{host_url}}/partner/diagnostics/skus/online/search/amz?partner_name={{partner_name}}","host":["{{host_url}}"],"path":["partner","diagnostics","skus","online","search","amz"],"query":[{"key":"partner_name","value":"{{partner_name}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 01 Apr 2022 10:20:53 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"79"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"2e27ad6a-7e91-4822-af04-7dbfc3bcd6d7"},{"key":"x-amz-apigw-id","value":"P5XA4FklBcwFl8A="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6246d205-78ac075e0b38bf356d3a59f3"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"failed\",\n \"message\": \"no sku found!\",\n \"response\": {}\n}"}],"_postman_id":"5a8fe9aa-e6c5-4795-8133-431765afa7f1"},{"name":"Pincode Serviceability","id":"66fc1acb-1749-42aa-9ea9-aa3155deed9d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"url":"{{host_url}}/partner/diagnostics/pincode/{{pincode}}","description":"

Path Params:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Param	Description	Type	Format/Values
`pincode` (required)	Pincode	String	E.g \"560102\"

","urlObject":{"path":["partner","diagnostics","pincode","{{pincode}}"],"host":["{{host_url}}"],"query":[],"variable":[]}},"response":[{"id":"0fafd9de-a3ce-43a1-8347-451a23c5ad5f","name":"Success - Serviceable","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"url":"{{host_url}}/partner/diagnostics/pincode/560102"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"area is serviceable\",\n \"response\": {\n \"pin_code\": \"560102\",\n \"serviceable\": true\n }\n}"},{"id":"dff69e53-6c5c-4eaf-a010-b2046bb6e4d1","name":"Error - Not serviceable","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"url":"{{host_url}}/partner/diagnostics/pincode/122001"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"area is not serviceable\",\n \"response\": {\n \"pin_code\": \"122001\",\n \"serviceable\": false\n }\n}"}],"_postman_id":"66fc1acb-1749-42aa-9ea9-aa3155deed9d"},{"name":"Fetch SKU details","id":"e118a8d1-0267-449b-96df-a5fb90febcc1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"url":"{{host_url}}/partner/diagnostics/skus/online/sku?sku_id=143,218&partner_name={{partner_name}}","description":"

Fetch details of any SKU in our inventory by calling SKU Details API. The maximum number of SKUs that can be fetched in a single request is 10.

\n
Note: In case the partners offer any pre-determined discount to the customers for diagnostic tests, this will be reflected in the discounted_price field in the response. For example, if a partner offers a 15% discount on a test of MRP Rs. 1000, the API response will have two fields: mrp: 1000 and discounted_price: 850
\n

Path Params:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Param	Description	Type	Format/Values
`sku_ids` (required)	Comma separated string of SKU ids	String	Eg. 143,218
`partner_name` (optional)	Partner name	String	Must be provided to get details of discounted price.

","urlObject":{"path":["partner","diagnostics","skus","online","sku"],"host":["{{host_url}}"],"query":[{"key":"sku_id","value":"143,218"},{"key":"partner_name","value":"{{partner_name}}"}],"variable":[]}},"response":[{"id":"65b75e95-c44e-4c52-9835-c3f45d2eef9e","name":"Success - Response without discounted price","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"url":{"raw":"{{host_url}}/partner/diagnostics/skus/online/sku?sku_id=243,190","host":["{{host_url}}"],"path":["partner","diagnostics","skus","online","sku"],"query":[{"key":"sku_id","value":"243,190"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"response\": [\n {\n \"sku_id\": \"243\",\n \"sub_category\": [],\n \"label\": \"SGPT/ALT\",\n \"mrp\": 160.0,\n \"fasting_required\": \"Not required\",\n \"other_instructions\": \"\",\n \"name\": \"SGPT/ALT\",\n \"category\": \"test\",\n \"composition\": \"\",\n \"sample_type\": \"Blood\",\n \"description\": \"Used to assess kidney damage, measures the liver enzyme AST-aspartate serum transferase\",\n \"type\": \"pathology\",\n \"status\": \"available\"\n },\n {\n \"sku_id\": \"190\",\n \"sub_category\": [],\n \"label\": \"HLA B27\",\n \"mrp\": 2500.0,\n \"fasting_required\": \"Not required\",\n \"other_instructions\": \"\",\n \"name\": \"HLA B27\",\n \"category\": \"test\",\n \"composition\": \"\",\n \"sample_type\": \"Blood\",\n \"description\": \"Indicates the risk of growing certain autoimmune disorders\",\n \"type\": \"pathology\",\n \"status\": \"available\"\n }\n ]\n}"},{"id":"e303c392-13f9-43d4-a09e-161c5ef89cde","name":"Success - Response with partner discount","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"url":{"raw":"{{host_url}}/partner/diagnostics/skus/online/sku?sku_id=150&partner_name={{partner_name}}","host":["{{host_url}}"],"path":["partner","diagnostics","skus","online","sku"],"query":[{"key":"sku_id","value":"150"},{"key":"partner_name","value":"{{partner_name}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 03 Aug 2022 09:09:33 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"625"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"c9e5aacb-03e1-47c9-b6b9-81ee5a9f4b75"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"WR40KHRZhcwFVLA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-62ea3b4d-22a9879776b08204474aa073"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"response\": [\n {\n \"sku_id\": \"150\",\n \"sub_category\": [],\n \"label\": \"CULTURE & SENSITIVITY, AEROBIC BACTERIA\",\n \"mrp\": 710.0,\n \"fasting_required\": \"Not required\",\n \"other_instructions\": \"\",\n \"name\": \"CULTURE & SENSITIVITY, AEROBIC BACTERIA\",\n \"category\": \"test\",\n \"composition\": \"\",\n \"sample_type\": \"Urine\",\n \"description\": \"Tests that detects bacterial growth in UTI patients\",\n \"type\": \"pathology\",\n \"status\": \"available\",\n \"discounted_price\": 603.5\n }\n ]\n}"},{"id":"fd671e28-ed4c-43e2-8813-2f4b52e510a3","name":"Success - Multiple SKUs","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"url":{"raw":"{{host_url}}/partner/diagnostics/skus/online/sku?sku_id=243,190&partner_name={{partner_name}}","host":["{{host_url}}"],"path":["partner","diagnostics","skus","online","sku"],"query":[{"key":"sku_id","value":"243,190"},{"key":"partner_name","value":"{{partner_name}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 03 Aug 2022 09:12:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1117"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"32bde8a0-246d-4dee-9810-50caacf64b82"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"WR5M7GbeBcwFYqQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-62ea3bec-2b4833b30366bc1d3f39ef7e"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"response\": [\n {\n \"sku_id\": \"243\",\n \"sub_category\": [],\n \"label\": \"SGPT/ALT\",\n \"mrp\": 160.0,\n \"fasting_required\": \"Not required\",\n \"other_instructions\": \"\",\n \"name\": \"SGPT/ALT\",\n \"category\": \"test\",\n \"composition\": \"\",\n \"sample_type\": \"Blood\",\n \"description\": \"Used to assess kidney damage, measures the liver enzyme AST-aspartate serum transferase\",\n \"type\": \"pathology\",\n \"status\": \"available\",\n \"discounted_price\": 136.0\n },\n {\n \"sku_id\": \"190\",\n \"sub_category\": [],\n \"label\": \"HLA B27\",\n \"mrp\": 2500.0,\n \"fasting_required\": \"Not required\",\n \"other_instructions\": \"\",\n \"name\": \"HLA B27\",\n \"category\": \"test\",\n \"composition\": \"\",\n \"sample_type\": \"Blood\",\n \"description\": \"Indicates the risk of growing certain autoimmune disorders\",\n \"type\": \"pathology\",\n \"status\": \"available\",\n \"discounted_price\": 2125.0\n }\n ]\n}"}],"_postman_id":"e118a8d1-0267-449b-96df-a5fb90febcc1"},{"name":"Available slots","id":"d078b5b6-d823-4100-a225-759c539fe75b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{API_key}}","type":"text"},{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":"{{host_url}}/partner/diagnostics/slots?lab_id=11002-THYRO-0001-0001&date=23-06-2023&time_of_day=morning","description":"

Use the Available Slots API to fetch the list of time slots of a particular lab/centre for a particular date and time of day.

\n
Note: All time slots will have a duration of 30 minutes.
\n

Request Params:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Param	Description	Type	Format/Values
`lab_id` (required)	Unique ID of the lab	String	E.g: \"1002-THYRO-0001-0001\"
`date` (required)	Date for which slots are required	String	Date must be of the format `dd-mm-yyyy` For example: 04-02-2022
`time_of_day` (optional)	The preferred time of day	String	Acceptable values: `morning` - 9am - 12pm `afternoon` - 12pm - 3pm `evening` - 3pm -6pm `night` - 6pm - 9pm If no values are provided, slots for the whole day will be returned.

\n
Note: In case the requested date is in the past, or the combination of date and time of day is past the current portion of the day, an error will be returned. For example, if the current date/time is 01-01-2022, 11 AM and slots are requested for 31-12-2021 afternoon or 01-01-2022 morning , the endpoint will return an error.
Note: * In case slots are requested for the current date and time of day, only future slots in the current time of day will be returned. For example, if the current date/time is 01-01-2022 10.45 AM and slots are requested for 01-01-2022 morning, only slots from 11 AM - 12 PM will be returned.
\n

\n","urlObject":{"path":["partner","diagnostics","slots"],"host":["{{host_url}}"],"query":[{"key":"lab_id","value":"11002-THYRO-0001-0001"},{"key":"date","value":"23-06-2023"},{"key":"time_of_day","value":"morning"}],"variable":[]}},"response":[],"_postman_id":"d078b5b6-d823-4100-a225-759c539fe75b"},{"name":"[DEPRECATED] Get Order Status","id":"c71675f9-d91c-4b14-8b82-6f55cece7dd5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"description":"

We have deprecated this API, please register a callback URL to make use of MedPay Partner Webhooks.

\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"c71675f9-d91c-4b14-8b82-6f55cece7dd5"},{"name":"Create Order","id":"a5372747-b08c-4540-8ceb-5881553da0d7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"body":{"mode":"raw","raw":"{ \n \"partner_order_id\": \"{{partner_order_id}}\",\n \"partner_name\": \"{{partner_name}}\",\n \"sample_collection\": \"self_visit\",\n \"payment_collection\": \"medpay\",\n \"time_slot\": \"09-04-2022, 05:00 PM\",\n \"customer_details\": {\n \"name\": \"Jane Doe\",\n \"mobile\": \"8800880088\",\n \"gender\": \"female\",\n \"age\": 29,\n \"alternative_mobile\": \"\",\n \"email\": \"xyz@email.in\",\n \"address_details\": {\n \"address\": \"1/6, Gandhi Nagar, pune\",\n \"landmark\": \"gandhi nagar\",\n \"pin_code\": \"126102\",\n \"city\": \"pune\",\n \"state\": \"mumbai\",\n \"coordinates\":\"29.3156909,76.3212837\"\n }\n },\n \"order_details\": {\n \"prescription_links\": [],\n \"items\": [\n { \n \"test_id\": \"190\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/diagnostics/order/online/create","description":"

Use Create Order API to place a diagnostic test order for home pickup. MedPay will find a clinic in our Connected Care Network that is closest to the customer address to fulfil the order.

Note: Customer's location coordinates (lat-long) are mandatory within customer_details to ensure seamless delivery of the order.

Request Params:

Param	Description	Type	Format/Values
`partner_order_id` (required)	Partner Order id	String	Unique order ID passed by the Partner. Partner Order ID can only contain letters, numbers, underscores(_) and hyphens(-).
`partner_name` (required)	Name of the partner placing the order	String	Value shared with API access details. Partner name must be more than 3 characters long
`payment_collection` (required)	Payment collection type reference	String	self, medpay
`sample_collection` (required)	Type of delivery mode	String	self_visit (Pass this value for self-visit to the lab)
`time_slot`* (required)*	Preferred time slot for appointment. This may be subject to change depending on the lab's availability.	String	E.g. `09-06-2022, 05:00 PM`
`customer_details` (required)	Customer meta data	Map[object]
`name` (required)	Customer name	String	Maximum length: 255 char. For e.g, John Doe
`mobile` (required)	10 digits mobile number	String	E.g `880XXXXXXX`
`gender` (optional)	Customer gender	String	Male/Female/Other
`age` (optional)	Customer age	Integer	Age must be between 0 - 99
`alternative_mobile_number` (optional)	10 digits alternate mobile number	String	E.g `880XXXXXXX`
`email` (optional)	Customer valid email id	String	E.g `xyz@email.in`
`address_details` (required)	Customer address meta data	Map[object]
`address` (required)	Customer full address	String	Minimum length: 2 char
`landmark` (required)	Customer address landmark	String	Minimum length: 2 char
`pin_code` (required)	Customer address pincode	String	6-digit pincode
`city` (required)	Customer address city	String	Minimum length: 2 char
`state` (required)	Customer address state	String	Minimum length: 2 char
`coordinates` (required)	Comma-separated lat & long	String	e.g `29.3156909,76.3212837`
`order_details` (required)	Order details	Map[object]
`prescription_links` (required)	List of valid prescription URLs	List	For e.g. [\"http://www.example.com/index.html\"\\]
`test_id` (required)	Test id received from the Search SKU API	String	e.g `46038`

","urlObject":{"path":["partner","diagnostics","order","online","create"],"host":["{{host_url}}"],"query":[],"variable":[]}},"response":[{"id":"bd978461-c8bd-4b11-8c80-804774ccaa81","name":"Success - Order created","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"body":{"mode":"raw","raw":"{ \n \"partner_order_id\": \"{{partner_order_id}}\",\n \"partner_name\": \"{{partner_name}}\",\n \"sample_collection\": \"self_visit\",\n \"payment_collection\": \"medpay\",\n \"time_slot\": \"09-03-2023, 05:00 PM\",\n \"customer_details\": {\n \"name\": \"Jane Doe\",\n \"mobile\": \"1234567890\",\n \"gender\": \"female\",\n \"age\": 29,\n \"alternative_mobile\": \"\",\n \"email\": \"xyz@email.in\",\n \"address_details\": {\n \"address\": \"1/6, Gandhi Nagar, pune\",\n \"landmark\": \"gandhi nagar\",\n \"pin_code\": \"126102\",\n \"city\": \"pune\",\n \"state\": \"mumbai\",\n \"coordinates\":\"29.3156909,76.3212837\"\n }\n },\n \"order_details\": {\n \"prescription_links\": [],\n \"items\": [\n { \n \"test_id\": \"190\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/diagnostics/order/online/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 04 Apr 2022 05:13:25 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1326"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"c0a00ce3-548e-4f05-97ed-be28433712ca"},{"key":"x-amz-apigw-id","value":"QCiySGDcBcwFj5w="},{"key":"X-Amzn-Trace-Id","value":"Root=1-624a7e74-22bdef4e2cd323240034af9e"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"order created successfully.\",\n \"response\": {\n \"partner_order_id\": \"1009\",\n \"payment_collection\": \"medpay\",\n \"sample_collection\": \"self_visit\",\n \"partner_name\": \"testpartner\",\n \"order_status\": \"pending\",\n \"time_slot\": \"09-03-2023, 05:00 PM\",\n \"lab_id\": \"\",\n \"customer_details\": {\n \"name\": \"Jane Doe\",\n \"mobile\": \"1234567890\",\n \"gender\": \"female\",\n \"age\": 29,\n \"alternative_mobile\": \"\",\n \"email\": \"xyz@email.in\",\n \"address_details\": {\n \"address\": \"1/6, Gandhi Nagar, pune\",\n \"landmark\": \"gandhi nagar\",\n \"pin_code\": \"126102\",\n \"city\": \"Pune\",\n \"state\": \"mumbai\"\n }\n },\n \"order_details\": {\n \"prescription_links\": [],\n \"items\": [\n {\n \"test_id\": \"190\",\n \"item\": \"HLA B27\",\n \"details\": \"Test : HLA B27\",\n \"MRP\": \"2500\",\n \"amount\": \"2500\",\n \"sample_type\": \"Blood\",\n \"fasting_required\": \"Not required\",\n \"description\": \"Indicates the risk of growing certain autoimmune disorders\"\n }\n ]\n },\n \"created_by\": \"testpartner\",\n \"created_at\": \"22/02/2023 12:29:07.712732\"\n }\n}"},{"id":"e8a4e988-cdba-40d0-9d3d-2235a5701b2f","name":"Error - Missing field","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"body":{"mode":"raw","raw":"{ \n \"partner_order_id\": \"{{partner_order_id}}\",\n \"partner_name\": \"{{partner_name}}\",\n \"payment_collection\": \"medpay\",\n \"time_slot\": \"09-04-2022, 05:00 PM\",\n \"customer_details\": {\n \"name\": \"Jesna James\",\n \"mobile\": \"8547621425\",\n \"gender\": \"female\",\n \"age\": 29,\n \"alternative_mobile\": \"\",\n \"email\": \"xyz@email.in\",\n \"address_details\": {\n \"address\": \"1/6, Gandhi Nagar, pune\",\n \"landmark\": \"gandhi nagar\",\n \"pin_code\": \"126102\",\n \"city\": \"pune\",\n \"state\": \"mumbai\",\n \"coordinates\":\"29.3156909,76.3212837\"\n }\n },\n \"order_details\": {\n \"prescription_links\": [],\n \"items\": [\n { \n \"test_id\": \"190\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/diagnostics/order/online/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 04 Apr 2022 05:22:59 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"150"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"1069dbbf-fa39-4de0-aac4-21014b66cdf7"},{"key":"x-amz-apigw-id","value":"QCkMCEguhcwFmzA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-624a80b3-135472f16784fbe361984990"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": {\n \"sample_collection\": \"'sample_collection' is a required property\"\n },\n \"message\": \"Input payload validation failed\"\n}"}],"_postman_id":"a5372747-b08c-4540-8ceb-5881553da0d7"},{"name":"Confirm Order","id":"fa1756cf-3363-42c9-9830-3274576651f1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partner_order_id\": \"{{partner_order_id}}\",\n \"partner_name\": \"{{partner_name}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/diagnostics/order/confirm","description":"

\n
Note: This API has to be called only if an order is in partner_pending state.
\n

Request Params:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Param	Description	Type	Format/Values
`partner_order_id` (required)	Partner Order id	String	Unique order id passed by the Partner
`partner_name` (required)	Name of the partner placing the order	String	Values shared with API access details

","urlObject":{"path":["partner","diagnostics","order","confirm"],"host":["{{host_url}}"],"query":[],"variable":[]}},"response":[{"id":"d6e0e25f-6d45-41b7-b03e-8749123bc3b8","name":"Success - Modifications confirmed","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partner_order_id\": \"{{partner_order_id}}\",\n \"partner_name\": \"{{partner_name}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/diagnostics/order/confirm"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 01 Apr 2022 10:33:34 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"818"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"d63f5e71-0a74-46ee-a8e0-7282b065ffb0"},{"key":"x-amz-apigw-id","value":"P5Y3eGHEBcwFQWg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6246d4fc-534d532a5dd3280f1b479115"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"invoice generated successfully.\",\n \"response\": {\n \"partner_order_id\": \"10020\",\n \"partner_name\": \"testpartner\",\n \"order_details\": {\n \"items\": [\n {\n \"item\": \"CSF INDIA INK PREPARATION\",\n \"amount\": \"270.0\",\n \"quantity\": null,\n \"gst\": \"0\",\n \"sku_id\": \"143\",\n \"details\": \"Test : CSF INDIA INK PREPARATION\",\n \"MRP\": \"270\",\n \"test_id\": \"143\"\n }\n ],\n \"prescription_links\": []\n },\n \"order_status\": \"invoice_generated\",\n \"created_at\": \"01/04/2022 15:52:55.364266\",\n \"modified_at\": \"01/04/2022 16:03:33.991483\"\n }\n}"},{"id":"6788ed8d-2e98-4943-8070-d3a4bac2e03c","name":"Error - Already confirmed","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partner_order_id\": \"{{partner_order_id}}\",\n \"partner_name\": \"{{partner_name}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/diagnostics/order/confirm"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 01 Apr 2022 10:40:34 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"172"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"d142afde-3f4b-4110-a1b5-c2c43a517ce7"},{"key":"x-amz-apigw-id","value":"P5Z5YEB2hcwFd0A="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6246d6a2-5952c6451c80488443e53d3b"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"failed\",\n \"message\": \"order is already confirmed\",\n \"response\": {\n \"partner_order_id\": \"10020\",\n \"partner_name\": \"testpartner\"\n }\n}"},{"id":"b3170c0f-c199-4c8e-9efb-97b2e41eef8c","name":"Error - Failed confirmation","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partner_order_id\": \"{{partner_order_id}}\",\n \"partner_name\": \"{{partner_name}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/diagnostics/order/confirm"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 04 Apr 2022 05:31:44 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"175"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"13d6b5c0-7a17-404f-b0e1-fa307655e6e2"},{"key":"x-amz-apigw-id","value":"QCleAEczBcwFQwA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-624a82bf-754c98e70fd06b73147e924e"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"failed\",\n \"message\": \"order confirmation failed.\",\n \"response\": {\n \"partner_order_id\": \"1002\",\n \"partner_name\": \"testpartner\"\n }\n}"}],"_postman_id":"fa1756cf-3363-42c9-9830-3274576651f1"},{"name":"Update Payment Status","id":"83ca4614-2c2d-48d4-b444-ecb5e22457db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partner_order_id\": \"{{partner_order_id}}\",\n \"invoice_id\": \"inv953322359411684\",\n \"partner_name\": \"{{partner_name}}\",\n \"payment_details\": {\n \"reference_id\": \"3213\",\n \"net_amount\": \"460\",\n \"payment_type\": \"card\",\n \"payment_timestamp\": \"\",\n \"notes\": \"\"\n },\n \"patient_payable\": \"0\",\n \"payer_payable\": \"460.0\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/diagnostics/order/payment/confirm","description":"

Use the Update Payment Status API to provide confirmation on the payment status.

\n
Note: Payment confirmation is required from partner before the order status can be updated.
Note: Payment can be made fully or partially, in which case, the patient has to complete the payment to update the order status. The link for patient to complete payment will be provided in the webhook notification and sent directly to the patient via WhatsApp message.
\n

Request Params:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Param	Description	Type	Format/Values
`partner_order_id` (required)	Partner Order id	String	Unique order id passed by the Partner
`partner_name` (required)	Name of the partner placing the order	String	Values shared with API access details
`invoice_id` (required)	Unique invoice id generated by MedPay when order status changes to invoice_generated	String	E.g \"inv187258418906901\"
`payment_details` (required)	Payment meta data	Map[object]	E.g \"inv187258418906901\"
`reference_id` (required)	Unique payment reference ID generated by Partner	String	E.g \"32132323\"
`net_amount` (required)	Amount paid by the patient	String	E.g \"201.50\"
`payment_type` (required)	Payment mode type	String	Acceptable values: card, upi, internet_banking, voucher, other
`payment_timestamp` (optional)	Payment Timestamp	String
`notes` (optional)	Notes	String	To pass additional notes
`payer_payable` (required)	Amount paid by the payer	String	E.g \"201.50\"
`patient_payable` (required)	Amount paid by the patient	String	E.g \"1.50\"

","urlObject":{"path":["partner","diagnostics","order","payment","confirm"],"host":["{{host_url}}"],"query":[],"variable":[]}},"response":[{"id":"abce2daf-7b62-4fb4-881d-4ad57da836a9","name":"Success - Full Payment","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partner_order_id\": \"{{partner_order_id}}\",\n \"invoice_id\":\"inv236384093378023\",\n \"partner_name\": \"{{partner_name}}\",\n \"payment_details\":{\n \"reference_id\": \"3213\",\n \"net_amount\": \"270\",\n \"payment_type\": \"card\",\n \"payment_timestamp\": \"\" ,\n \"notes\" : \"\" \n },\n \"patient_payable\": \"0\",\n \"payer_payable\": \"270.0\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/diagnostics/order/payment/confirm"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 01 Apr 2022 11:18:10 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"615"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"022c5f1d-3b71-4d75-8d0c-92b6eb15c38a"},{"key":"x-amz-apigw-id","value":"P5fZ1FH9hcwFmgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6246df71-3537dbc763c0931a34f62a33"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"payment confirmed successfully.\",\n \"response\": {\n \"partner_order_id\": \"10020\",\n \"partner_name\": \"testpartner\",\n \"invoice_id\": \"inv236384093378023\",\n \"payment_status\": \"success\",\n \"payment_details\": {\n \"reference_id\": \"3213\",\n \"net_amount\": \"270\",\n \"payment_type\": \"card\",\n \"payment_timestamp\": \"\",\n \"notes\": \"\"\n },\n \"order_status\": \"payment_collected\",\n \"created_at\": \"01/04/2022 15:52:55.364266\",\n \"modified_at\": \"01/04/2022 16:48:10.039918\"\n }\n}"},{"id":"8d264d3d-2b84-4fb8-b5a3-d2629bdc6773","name":"Success - Partial payment","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partner_order_id\": \"{{partner_order_id}}\",\n \"invoice_id\":\"inv295654283689134\",\n \"partner_name\": \"{{partner_name}}\",\n \"payment_details\":{\n \"reference_id\": \"3213\",\n \"net_amount\": \"460\",\n \"payment_type\": \"card\",\n \"payment_timestamp\": \"\" ,\n \"notes\" : \"\",\n \"payer_payable\": \"400\",\n \"patient_payable\": \"60\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/diagnostics/order/payment/confirm"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 01 Apr 2022 11:20:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"688"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"dc632114-96d6-4a9c-b5f9-a7ac6ec81716"},{"key":"x-amz-apigw-id","value":"P5fsUFXMBcwFpDg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6246dfe8-6958afe160c1c50f47f48882"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"payment confirmed successfully.\",\n \"response\": {\n \"partner_order_id\": \"10021\",\n \"partner_name\": \"testpartner\",\n \"invoice_id\": \"inv295654283689134\",\n \"payment_status\": \"success\",\n \"payment_details\": {\n \"reference_id\": \"3213\",\n \"net_amount\": \"460\",\n \"payment_type\": \"card\",\n \"payment_timestamp\": \"\",\n \"notes\": \"\",\n \"payer_payable\": \"400\",\n \"patient_payable\": \"60\"\n },\n \"order_status\": \"payment_collected\",\n \"created_at\": \"01/04/2022 15:54:10.697525\",\n \"modified_at\": \"01/04/2022 16:50:08.407404\"\n }\n}"},{"id":"ea4d44cf-4dbd-49f7-afc2-721d9215dd63","name":"Error - Payment Already Confirmed","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partner_order_id\": \"{{partner_order_id}}\",\n \"invoice_id\":\"inv236384093378023\",\n \"partner_name\": \"{{partner_name}}\",\n \"payment_details\":{\n \"reference_id\": \"3213\",\n \"net_amount\": \"270\",\n \"payment_type\": \"card\",\n \"payment_timestamp\": \"\" ,\n \"notes\" : \"\" \n },\n \"payer_payable\": \"270\",\n \"patient_payable\": \"0\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/diagnostics/order/payment/confirm"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 01 Apr 2022 11:18:32 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"115"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"7f91d63c-2b45-4652-beb6-7287c5df010a"},{"key":"x-amz-apigw-id","value":"P5fdVEJjhcwFd1g="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6246df88-551db8b519ade5034e313dff"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"failed\",\n \"message\": \"payment cannot be confirmed or already confirmed.\",\n \"response\": {}\n}"},{"id":"76a52db0-f550-451e-847c-16620a701f53","name":"Error - Incorrect Invoice ID","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partner_order_id\": \"{{partner_order_id}}\",\n \"invoice_id\":\"inv236384093478023\",\n \"partner_name\": \"{{partner_name}}\",\n \"payment_details\":{\n \"reference_id\": \"3213\",\n \"net_amount\": \"270\",\n \"payment_type\": \"card\",\n \"payment_timestamp\": \"\" ,\n \"notes\" : \"\" \n },\n \"payer_payable\": \"270\",\n \"patient_payable\": \"0\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/diagnostics/order/payment/confirm"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 01 Apr 2022 11:18:55 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"118"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"aceed4e7-2e0a-4a86-bb92-3272a644ba7b"},{"key":"x-amz-apigw-id","value":"P5fg6HpmBcwFr6A="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6246df9f-605792a526c09b70616bbdd0"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"failed\",\n \"message\": \"partial amount is not acceptable for net_amount: 270\",\n \"response\": {}\n}"}],"_postman_id":"83ca4614-2c2d-48d4-b444-ecb5e22457db"},{"name":"Cancel Order","id":"d062167b-c925-43a5-a030-19468fd9d928","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partner_order_id\": \"{{partner_order_id}}\",\n \"partner_name\": \"{{partner_name}}\",\n \"cancellation_code\": \"CC08\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/diagnostics/order/cancel","description":"

Use the Cancel Order API to cancel an existing order. An order can be cancelled if it is in the following states:

pending
partner_pending
accepted
invoice_generated
payment_pending

\n
Note: Order cancellation will be processed based on the state of the order and not the time of appointment.
\n

Request Params:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Param	Description	Type	Format/Values
`partner_order_id` (required)	Partner Order ID	String	Unique order id passed by the Partner
`partner_name` (required)	Name of the partner placing the order	String	Values shared with API access details
`cancellation_code` (required)	Code for cancellation	String	Acceptable cancellation codes are tabulated below.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Cancellation Code	Cancellation Reason
CC01	Payment not done
CC08	Patient not happy with alternate provider / timings
CC09	No confirmation from patient
CC10	Patient refused sample pick-up

\n
Note: Currently, the Cancel Order API allows either a free-text cancellation reason or a cancellation code that uniquely identifies a specific cancellation reason. From 28 February 2023, the cancelled_reason field will be deprecated and cancellation_code will be made mandatory.
\n

\n","urlObject":{"path":["partner","diagnostics","order","cancel"],"host":["{{host_url}}"],"query":[],"variable":[]}},"response":[{"id":"72b6eb64-744b-4f43-96f3-c8201dd09ca6","name":"Error - Order already cancelled","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"partner_order_id\": \"22021233\",\n \"partner_name\": \"{{partner_name}}\",\n \"cancellation_code\": \"CC08\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/diagnostics/order/cancel"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 27 Aug 2021 08:09:15 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"228"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"ddecfb26-1389-4a03-9f6b-76d224bb612c"},{"key":"x-amz-apigw-id","value":"Et2SxEFXhcwFTXg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-61289dab-59cf732e520efea348b92f17"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"failed\",\n \"message\": \"order partner id: 22021233 is already cancelled.\",\n \"response\": {\n \"partner_order_id\": \"22021233\",\n \"partner_name\": \"testpartner\",\n \"cancellation_code\": \"CC08\"\n }\n}"},{"id":"9a49a169-8de3-40bd-9824-1235f7426e6c","name":"Success - Order cancelled","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partner_order_id\": \"22021233\",\n \"partner_name\": \"{{partner_name}}\",\n \"cancellation_code\": \"CC08\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/diagnostics/order/cancel"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 01 Apr 2022 10:34:52 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"350"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"c9dcb39f-052f-4292-82a6-27deac9cd13b"},{"key":"x-amz-apigw-id","value":"P5ZD6F9JhcwFoKQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6246d54c-306ecb0a6790aa6d0cb322ea"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"order cancelled successfully.\",\n \"response\": {\n \"partner_order_id\": \"22021233\",\n \"partner_name\": \"testpartner\",\n \"order_status\": \"cancelled\",\n \"cancelled_reason\": \"Patient not happy with alternate provider / timings\",\n \"cancelled_by\": \"testpartner\",\n \"cancelled_at\": \"22/02/2023 12:34:13.215002\"\n }\n}"}],"_postman_id":"d062167b-c925-43a5-a030-19468fd9d928"}],"id":"9e097142-3bc7-4e31-a0f0-61a68c8921c6","description":"

The Self-Visit Diagnostic APIs have been deprecated. We will be releasing Self-Visit Diagnostic V2 shortly.

Webhooks:

It allows receiving real-time updates to the ongoing order. By configuring a URL, we can POST the most up-to-date information to show to the user. We enable clients to register their own callback URL to receive notifications related to the status change of an Order/Invoice.

\n
Note: Response fields may vary, as per current order states.
\n

Webhook URL: Please share webhook_url to get timely order updates.

Method: POST

Events:

partner_pending
accepted
invoice_generated
payment_pending
payment_collected
booking_confirmed
booking_completed
reports_generated
cancelled

Sample webhook POST Event structure:

partner-pending:

{\n  \"partner_order_id\": \"diagno1\",\n  \"partner_name\": \"uat_partner\",\n  \"order_status\": \"partner_pending\",\n  \"booking_details\": {\n    \"name\": \"Likhitha's Diagnostics & Speciality Lab - Pune\",\n    \"address\": \"Shop no : 8 , Blue hills Society, Nagar Rd, below Lunkad Realty, Mahindra Society, Yerawada, Pune, Maharashtra 411006, India\",\n    \"coordinates\": \"18.5493444,73.89213769999999\",\n    \"time_slot\": \"23-02-2023, 12:30 PM\",\n    \"change_type\": \"rescheduled\",\n    \"requested_booking_details\": {\n      \"name\": \"Likhitha's Diagnostics & Speciality Lab - Pune\",\n      \"address\": \"Shop no : 8 , Blue hills Society, Nagar Rd, below Lunkad Realty, Mahindra Society, Yerawada, Pune, Maharashtra 411006, India\",\n      \"coordinates\": \"18.5493444,73.89213769999999\",\n      \"time_slot\": \"09-04-2022, 05:00 PM\"\n    }\n  },\n  \"timestamp\": \"22/02/2023 17:58:58.597227\"\n}\n\n

order-accepted:

{\n  \"partner_order_id\": \"diagno1\",\n  \"partner_name\": \"testpartner\",\n  \"order_status\": \"accepted\",\n  \"timestamp\": \"22/02/2023 17:59:38.001965\",\n  \"booking_details\": {\n    \"name\": \"Likhitha's Diagnostics & Speciality Lab - Pune\",\n    \"address\": \"Shop no : 8 , Blue hills Society, Nagar Rd, below Lunkad Realty, Mahindra Society, Yerawada, Pune, Maharashtra 411006, India\",\n    \"coordinates\": \"18.5493444,73.89213769999999\",\n    \"time_slot\": \"09-04-2022, 05:00 PM\"\n  }\n}\n\n

invoice-generated:

{\n  \"partner_order_id\": \"diagno1\",\n  \"partner_name\": \"uat_partner\",\n  \"order_status\": \"invoice_generated\",\n  \"invoice_details\": {\n    \"partner_discount\": \"0.0\",\n    \"tgst\": \"0.0\",\n    \"bill_amount\": \"2500.0\",\n    \"discount_pct\": \"0\",\n    \"invoice_no\": null,\n    \"payment_status\": \"pending\",\n    \"invoice_id\": \"inv748746955437556\",\n    \"payment_collection\": \"medpay\",\n    \"net_amount\": \"2500.0\",\n    \"invoice_link\": \"https://mdpy.in/2eMj2dAW0S\"\n  },\n  \"timestamp\": \"04/08/2022 10:31:43.288694\"\n}\n\n

payment-pending:

{\n  \"partner_order_id\": \"10014\",\n  \"partner_name\": \"testpartner\",\n  \"order_status\": \"payment_pending\",\n  \"payment_details\": {\n    \"payment_timestamp\": \"\",\n    \"payment_type\": \"card\",\n    \"net_amount\": \"460\",\n    \"notes\": \"\",\n    \"reference_id\": \"3213\",\n    \"payer_payable\": \"360.0\",\n    \"patient_payable\": \"100.0\",\n    \"patient_payable_details\": {\n      \"transaction_id\": \"REQ001667627743\",\n      \"link\": \"https://mdpy.in/5jLUqPt02B\",\n      \"status\": \"payment link sent successfully\",\n      \"timestamp\": \"06/06/2022 12:45:07.276826\"\n    }\n  },\n  \"timestamp\": \"06/06/2022 12:45:06.850094\"\n}\n\n

payment-collected:

{\n  \"partner_order_id\": \"diagno1\",\n  \"partner_name\": \"uat_partner\",\n  \"order_status\": \"payment_collected\",\n  \"payment_details\": {\n    \"payment_timestamp\": \"\",\n    \"payment_type\": \"card\",\n    \"net_amount\": \"2500\",\n    \"notes\": \"\",\n    \"reference_id\": \"3213\"\n  },\n  \"timestamp\": \"22/02/2023 19:19:51.780952\"\n}\n\n

booking_confirmed:

{\n  \"partner_order_id\": \"diagno1\",\n  \"partner_name\": \"uat_partner\",\n  \"order_status\": \"booking_confirmed\",\n  \"booking_details\": {\n    \"name\": \"Likhitha's Diagnostics & Speciality Lab - Pune\",\n    \"address\": \"Shop no : 8 , Blue hills Society, Nagar Rd, below Lunkad Realty, Mahindra Society, Yerawada, Pune, Maharashtra 411006, India\",\n    \"coordinates\": \"18.5493444,73.89213769999999\",\n    \"time_slot\": \"09-04-2022, 05:00 PM\",\n    \"invoice_details\": {\n      \"partner_discount\": \"0.0\",\n      \"tgst\": \"0.0\",\n      \"bill_amount\": \"2500.0\",\n      \"invoice_no\": null,\n      \"payment_status\": \"success\",\n      \"invoice_id\": \"inv404643782140854\",\n      \"payment_collection\": \"medpay\",\n      \"net_amount\": \"2500.0\",\n      \"invoice_link\": \"https://mdpy.in/OdU3KYM5WV\"\n    },\n    \"patient_check_in_url\": \"https://ccn-dev.medpay.in?token=404643782140854\"\n  }\n}\n\n

booking-completed:

{\n  \"partner_order_id\": \"diagno1\",\n  \"partner_name\": \"uat_partner\",\n  \"order_status\": \"booking_completed\",\n  \"timestamp\": \"04/08/2022 10:52:53.658728\",\n  \"booking_details\": {\n    \"customer_name\": \"Jane Doe\",\n    \"name\": \"G M Diagnostics\",\n    \"address\": \"13-A, Above Indian Oveseas Bank, Opp Post Office, Kalyan Nagar, K.V.Rangareddy,Telangana, 500018\",\n    \"time_slot\": \"09-08-2022, 05:00 PM\"\n  }\n}\n\n

reports-generated:

{\n  \"partner_order_id\": \"diagno1\",\n  \"partner_name\": \"uat_partner\",\n  \"order_status\": \"reports_generated\",\n  \"timestamp\": \"22/02/2023 19:37:53.871651\",\n  \"reports_details\": {\n    \"links\": [\n      \"https://medpay-diagnostics-reports-dev.s3.ap-southeast-1.amazonaws.com/22222_1677074870.jpeg\"\n    ]\n  }\n}\n\n

order-cancelled:

{\n  \"partner_order_id\": \"diagno1\",\n  \"partner_name\": \"uat_partner\",\n  \"order_status\": \"cancelled\",\n  \"cancelled_reason\": \"Others\",\n  \"timestamp\": \"05/04/2022 19:32:55.767373\"\n}\n\n

","_postman_id":"9e097142-3bc7-4e31-a0f0-61a68c8921c6"}],"id":"cce21213-5682-4ea0-ae03-80f950188db8","description":"

We have currently deprecated this module in order to rebuild the APIs required to ensure a smooth flow and enhance the overall patient experience.

\n","_postman_id":"cce21213-5682-4ea0-ae03-80f950188db8"},{"name":"[DEPRECATED] 03- Doctor Consultation","item":[{"name":"Offline: Walk-ins","item":[{"name":"List specialties","id":"6dd6b168-c5d4-4d91-aa8a-74bcf176f071","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"url":"{{host_url}}/partner/consultations/doctors/specialties","description":"

Use the Specialties API to fetch the list of available specialties. The specialty code(recommended) or name mentioned in the response must be used in the Nearby Doctors and Create Order APIs

Path Params:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Param	Description	Type	Format/Values
`category` (optional)	General category of specialty	String	Acceptable values: `general`, `specialty`, `super specialty`

","urlObject":{"path":["partner","consultations","doctors","specialties"],"host":["{{host_url}}"],"query":[],"variable":[]}},"response":[{"id":"176fd0ef-3412-4c05-b621-78fd14db97ca","name":"Success - All","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"url":"{{host_url}}/partner/consultations/doctors/specialties"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 07 Apr 2022 07:12:55 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1749"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"4a2bfced-5dc2-4bdf-8ac8-3870c87e16f2"},{"key":"x-amz-apigw-id","value":"QMtGoHvPBcwFamA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-624e8ef7-2262782a34bbd235577c59d5"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Found specialties\",\n \"response\": [\n {\n \"category\": \"specialty\",\n \"specialty\": \"Dietitian\",\n \"code\": \"SP22\"\n },\n {\n \"category\": \"super specialty\",\n \"specialty\": \"Plastic Surgeon\",\n \"code\": \"SP17\"\n },\n {\n \"category\": \"specialty\",\n \"specialty\": \"Orthopaedic\",\n \"code\": \"SP15\"\n },\n {\n \"category\": \"specialty\",\n \"specialty\": \"Cardiologist\",\n \"code\": \"SP01\"\n },\n {\n \"category\": \"specialty\",\n \"specialty\": \"Endocrinologist\",\n \"code\": \"SP04\"\n },\n {\n \"category\": \"specialty\",\n \"specialty\": \"Psychiatrist \",\n \"code\": \"SP18\"\n },\n {\n \"category\": \"general\",\n \"specialty\": \"Dentist\",\n \"code\": \"SP02\"\n },\n {\n \"category\": \"specialty\",\n \"specialty\": \"Ophthalmology \",\n \"code\": \"SP14\"\n },\n {\n \"category\": \"specialty\",\n \"specialty\": \"General Surgeon\",\n \"code\": \"SP08\"\n },\n {\n \"category\": \"specialty\",\n \"specialty\": \"Neurologist\",\n \"code\": \"SP12\"\n },\n {\n \"category\": \"specialty\",\n \"specialty\": \"Gynaecologists & Obstetrician\",\n \"code\": \"SP09\"\n },\n {\n \"category\": \"general\",\n \"specialty\": \"General Physician\",\n \"code\": \"SP07\"\n },\n {\n \"category\": \"specialty\",\n \"specialty\": \"Paediatrician\",\n \"code\": \"SP16\"\n },\n {\n \"category\": \"super specialty\",\n \"specialty\": \"Vascular Surgeon\",\n \"code\": \"SP21\"\n },\n {\n \"category\": \"specialty\",\n \"specialty\": \"Ent\",\n \"code\": \"SP05\"\n },\n {\n \"category\": \"specialty\",\n \"specialty\": \"Dermatologist\",\n \"code\": \"SP03\"\n },\n {\n \"category\": \"super specialty\",\n \"specialty\": \"Urologist\",\n \"code\": \"SP20\"\n },\n {\n \"category\": \"super specialty\",\n \"specialty\": \"Gastroenterologist\",\n \"code\": \"SP06\"\n },\n {\n \"category\": \"specialty\",\n \"specialty\": \"Nephrologist\",\n \"code\": \"SP11\"\n },\n {\n \"category\": \"super specialty\",\n \"specialty\": \"Oncology\",\n \"code\": \"SP13\"\n },\n {\n \"category\": \"specialty\",\n \"specialty\": \"Internal Medicine\",\n \"code\": \"SP10\"\n },\n {\n \"category\": \"super specialty\",\n \"specialty\": \"Pulmonologist\",\n \"code\": \"SP19\"\n }\n ]\n}"},{"id":"7c78df17-9d42-4f19-90dc-fc21d5b899a3","name":"Success - Super Specialty","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"url":{"raw":"{{host_url}}/partner/consultations/doctors/specialties?category=super specialty","host":["{{host_url}}"],"path":["partner","consultations","doctors","specialties"],"query":[{"key":"category","value":"super specialty"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 07 Apr 2022 07:13:15 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"887"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"27c1056e-0d3e-48e3-b70d-f711ef1bd242"},{"key":"x-amz-apigw-id","value":"QMtJzG5gBcwFfxw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-624e8f0b-41b283652853d01756a65bd2"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Found specialties\",\n \"response\": [\n {\n \"category\": \"super specialty\",\n \"specialty\": \"Plastic Surgeon\",\n \"code\": \"SP17\"\n },\n {\n \"category\": \"super specialty\",\n \"specialty\": \"Vascular Surgeon\",\n \"code\": \"SP21\"\n },\n {\n \"category\": \"super specialty\",\n \"specialty\": \"Urologist\",\n \"code\": \"SP20\"\n },\n {\n \"category\": \"super specialty\",\n \"specialty\": \"Gastroenterologist\",\n \"code\": \"SP06\"\n },\n {\n \"category\": \"super specialty\",\n \"specialty\": \"Oncology\",\n \"code\": \"SP13\"\n },\n {\n \"category\": \"super specialty\",\n \"specialty\": \"Pulmonologist\",\n \"code\": \"SP19\"\n }\n ]\n}"},{"id":"1934a456-65a2-4d8a-bd6d-487211cd5a05","name":"Error - Invalid category","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"url":{"raw":"{{host_url}}/partner/consultations/doctors/specialties?category=medical","host":["{{host_url}}"],"path":["partner","consultations","doctors","specialties"],"query":[{"key":"category","value":"medical"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 07 Apr 2022 07:15:26 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"e1c95e9b-f5cb-4492-adcd-e014d8043e6d"},{"key":"x-amz-apigw-id","value":"QMteVFlnhcwFXfA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-624e8f8e-2d8e06d6077329055a91bbda"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"failed\",\n \"message\": \"Invalid category\",\n \"response\": {}\n}"}],"_postman_id":"6dd6b168-c5d4-4d91-aa8a-74bcf176f071"},{"name":"Near By Doctors","id":"c07e98e8-bcba-4ce9-87a8-36056b368331","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"url":"{{host_url}}/partner/consultations/doctors/offline/nearby?coordinates={{lat,long}}&specialty={{speciality}}","description":"

This API can be used to browse the neighbourhood to find nearby doctors in the MedPay Connected Care Network.

Path Params:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Param	Description	Type	Format/Values
`lat,long` (required)	Comma separated latitude & longitude	String	23.5697,72.528824
`speciality` (required)	Doctor speciality	String	Can either be the specialty code or the specialty name as mentioned in the Specialties API

","urlObject":{"path":["partner","consultations","doctors","offline","nearby"],"host":["{{host_url}}"],"query":[{"key":"coordinates","value":"{{lat,long}}"},{"key":"specialty","value":"{{speciality}}"}],"variable":[]}},"response":[{"id":"3fd24992-db9e-4b25-af9c-9ea77e20bafa","name":"Success - Found doctor by specialty name","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"url":{"raw":"{{host_url}}/partner/consultations/doctors/offline/nearby?coordinates=12.98,77.64&specialty=ENT","host":["{{host_url}}"],"path":["partner","consultations","doctors","offline","nearby"],"query":[{"key":"coordinates","value":"12.98,77.64"},{"key":"specialty","value":"ENT"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 04 Apr 2022 13:15:42 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"523"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a8d7c533-49cd-4e5e-b004-db92be414d7a"},{"key":"x-amz-apigw-id","value":"QDpbyGRKhcwFu4g="},{"key":"X-Amzn-Trace-Id","value":"Root=1-624aef7e-51296be31cf1dbe13805362c"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"records found\",\n \"response\": [\n {\n \"profile_id\": \"1104-2007-2021-6272\",\n \"name\": \"Dr. Anish Gupta\",\n \"gender\": \"\",\n \"experience_in_years\": 18,\n \"consultation_fees\": 900.0,\n \"languages\": \"English\",\n \"degrees\": \"MBBS, MS\",\n \"clinic_name\": \"62 Clinic\",\n \"provider_type\": \"Clinic\",\n \"specialty\": \"ENT, also known as otolaryngologist)\",\n \"address\": \"Basement Of 98.4 Pharmacy, Tot Mall, Sector 62, Tot Mall,Sector 62, Noida,Uttar Pradesh, 201301\",\n \"distance\": \"1738.67 km\"\n }\n ]\n}"},{"id":"4d7fad7b-af0c-4d49-8758-764a30868abb","name":"Success - Found doctors by specialty code","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"url":{"raw":"{{host_url}}/partner/consultations/doctors/offline/nearby?coordinates={{lat,long}}&specialty=SP05","host":["{{host_url}}"],"path":["partner","consultations","doctors","offline","nearby"],"query":[{"key":"coordinates","value":"{{lat,long}}"},{"key":"specialty","value":"SP05"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 09 Apr 2022 09:53:31 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"672"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"913c6a8e-dcca-469f-8ccd-3589e90f23ed"},{"key":"x-amz-apigw-id","value":"QTqgWFZ9hcwFlUQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6251579b-18a8a46431cbbde22e3fac95"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"records found\",\n \"response\": [\n {\n \"profile_id\": \"1104-2007-2021-6272\",\n \"name\": \"Dr. Anish Gupta\",\n \"gender\": \"\",\n \"experience_in_years\": 18,\n \"consultation_fees\": 900.0,\n \"languages\": \"English\",\n \"degrees\": \"MBBS, MS\",\n \"clinic_name\": \"62 Clinic\",\n \"provider_type\": \"Clinic\",\n \"specialty\": \"ENT, also known as otolaryngologist)\",\n \"address\": \"Basement Of 98.4 Pharmacy, Tot Mall, Sector 62, Tot Mall,Sector 62, Noida,Uttar Pradesh, 201301\",\n \"distance\": \"1738.67 km\"\n }\n ]\n}"},{"id":"7175dc50-4434-4333-8af8-3d2c75d24138","name":"No Records - Near By Doctors","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"url":{"raw":"{{host_url}}/partner/consultations/doctors/offline/nearby?coordinates={{lat,long}}&specialty={{speciality}}","host":["{{host_url}}"],"path":["partner","consultations","doctors","offline","nearby"],"query":[{"key":"coordinates","value":"{{lat,long}}"},{"key":"specialty","value":"{{speciality}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 05 Apr 2022 06:44:40 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"84"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a750ed0a-2004-4ff6-b419-47e1eb1a8697"},{"key":"x-amz-apigw-id","value":"QGDF5FMAhcwFd0A="},{"key":"X-Amzn-Trace-Id","value":"Root=1-624be558-0cba18e4750039782d921562"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"response\": [],\n \"message\": \"no records found!\"\n}"},{"id":"45f8860e-94a1-4efb-a5b5-edb85a33838e","name":"Error - Invalid specialty code/name","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"url":{"raw":"{{host_url}}/partner/consultations/doctors/offline/nearby?coordinates=12.98,77.64&specialty=surgeon","host":["{{host_url}}"],"path":["partner","consultations","doctors","offline","nearby"],"query":[{"key":"coordinates","value":"12.98,77.64"},{"key":"specialty","value":"surgeon"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 09 Apr 2022 10:08:07 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"80"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a038c55e-6b04-42aa-b524-3e326b34addc"},{"key":"x-amz-apigw-id","value":"QTspKE8KBcwFsGA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-62515b07-4f20235831dac494450bbcc9"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"failed\",\n \"response\": \"invalid params\",\n \"message\": {}\n}"}],"_postman_id":"c07e98e8-bcba-4ce9-87a8-36056b368331"},{"name":"Available slots","id":"d5cf4f5b-dda7-4305-ac29-e7cd37fb7b4e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"url":"{{host_url}}/partner/consultations/doctors/offline/slots?profile_id=1004-8898-4358-3735&date=23-06-2023&time_of_day=morning","description":"

Use the Available Slots API to fetch the list of time slots of a particular doctor/clinic for a particular date and time of day.

\n
Note: All time slots will have a duration of 30 minutes.
\n

Request Params:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Param	Description	Type	Format/Values
`profile_id` (required)	Unique ID of the clinic or doctor	String	E.g: \"1004-8898-4358-3735\"
`date` (required)	Date for which slots are required	String	Date must be of the format `dd-mm-yyyy` For example: 04-02-2022
`time_of_day` (optional)	The preferred time of day	String	Acceptable values: `morning` - 9am - 12pm `afternoon` - 12pm - 3pm `evening` - 3pm -6pm `night` - 6pm - 9pm If no values are provided, slots for the whole day will be returned.

\n
Note: In case the requested date is in the past, or the combination of date and time of day is past the current portion of the day, an error will be returned. For example, if the current date/time is 01-01-2022, 11 AM and slots are requested for 31-12-2021 afternoon or 01-01-2022 morning , the endpoint will return an error.
Note: * In case slots are requested for the current date and time of day, only future slots in the current time of day will be returned. For example, if the current date/time is 01-01-2022 10.45 AM and slots are requested for 01-01-2022 morning, only slots from 11 AM - 12 PM will be returned.
\n

\n","urlObject":{"path":["partner","consultations","doctors","offline","slots"],"host":["{{host_url}}"],"query":[{"key":"profile_id","value":"1004-8898-4358-3735"},{"key":"date","value":"23-06-2023"},{"key":"time_of_day","value":"morning"}],"variable":[]}},"response":[{"id":"4cc59475-89fe-496b-bfe2-98771de97d83","name":"Success - Slots from 6-9 pm","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"url":{"raw":"{{host_url}}/partner/consultations/doctors/offline/slots?profile_id=1004-8898-4358-3735&date=05-05-2022&time_of_day=night","host":["{{host_url}}"],"path":["partner","consultations","doctors","offline","slots"],"query":[{"key":"profile_id","value":"1004-8898-4358-3735"},{"key":"date","value":"05-05-2022"},{"key":"time_of_day","value":"night"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 04 Apr 2022 13:10:09 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"976"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"209d2e8f-c084-4676-9a59-266e3c6245e2"},{"key":"x-amz-apigw-id","value":"QDonyH3xhcwFh4A="},{"key":"X-Amzn-Trace-Id","value":"Root=1-624aee31-0c51c86d4566a2f21373c603"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Found slots\",\n \"response\": {\n \"profile_id\": \"1004-8898-4358-3735\",\n \"date\": \"05-05-2022\",\n \"slots\": [\n {\n \"time_slot\": \"05-05-2022, 06:00 PM\",\n \"time_of_day\": \"night\"\n },\n {\n \"time_slot\": \"05-05-2022, 06:30 PM\",\n \"time_of_day\": \"night\"\n },\n {\n \"time_slot\": \"05-05-2022, 07:00 PM\",\n \"time_of_day\": \"night\"\n },\n {\n \"time_slot\": \"05-05-2022, 07:30 PM\",\n \"time_of_day\": \"night\"\n },\n {\n \"time_slot\": \"05-05-2022, 08:00 PM\",\n \"time_of_day\": \"night\"\n },\n {\n \"time_slot\": \"05-05-2022, 08:30 PM\",\n \"time_of_day\": \"night\"\n }\n ]\n }\n}"},{"id":"6cb74491-78d4-4228-9ba8-64dc3c231827","name":"Success - All slots","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"url":{"raw":"{{host_url}}/partner/consultations/doctors/offline/slots?profile_id=1004-8898-4358-3735&date=05-05-2022","host":["{{host_url}}"],"path":["partner","consultations","doctors","offline","slots"],"query":[{"key":"profile_id","value":"1004-8898-4358-3735"},{"key":"date","value":"05-05-2022"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 04 Apr 2022 13:10:36 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"3388"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"9385e7ec-2725-4a45-9aaf-c1812811cb5d"},{"key":"x-amz-apigw-id","value":"QDor8E9PhcwFYIg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-624aee4c-64bf64e44b6bc8d338a92860"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Found slots\",\n \"response\": {\n \"profile_id\": \"1004-8898-4358-3735\",\n \"date\": \"05-05-2022\",\n \"slots\": [\n {\n \"time_slot\": \"05-05-2022, 09:00 AM\",\n \"time_of_day\": \"morning\"\n },\n {\n \"time_slot\": \"05-05-2022, 09:30 AM\",\n \"time_of_day\": \"morning\"\n },\n {\n \"time_slot\": \"05-05-2022, 10:00 AM\",\n \"time_of_day\": \"morning\"\n },\n {\n \"time_slot\": \"05-05-2022, 10:30 AM\",\n \"time_of_day\": \"morning\"\n },\n {\n \"time_slot\": \"05-05-2022, 11:00 AM\",\n \"time_of_day\": \"morning\"\n },\n {\n \"time_slot\": \"05-05-2022, 11:30 AM\",\n \"time_of_day\": \"morning\"\n },\n {\n \"time_slot\": \"05-05-2022, 12:00 PM\",\n \"time_of_day\": \"afternoon\"\n },\n {\n \"time_slot\": \"05-05-2022, 12:30 PM\",\n \"time_of_day\": \"afternoon\"\n },\n {\n \"time_slot\": \"05-05-2022, 01:00 PM\",\n \"time_of_day\": \"afternoon\"\n },\n {\n \"time_slot\": \"05-05-2022, 01:30 PM\",\n \"time_of_day\": \"afternoon\"\n },\n {\n \"time_slot\": \"05-05-2022, 02:00 PM\",\n \"time_of_day\": \"afternoon\"\n },\n {\n \"time_slot\": \"05-05-2022, 02:30 PM\",\n \"time_of_day\": \"afternoon\"\n },\n {\n \"time_slot\": \"05-05-2022, 03:00 PM\",\n \"time_of_day\": \"evening\"\n },\n {\n \"time_slot\": \"05-05-2022, 03:30 PM\",\n \"time_of_day\": \"evening\"\n },\n {\n \"time_slot\": \"05-05-2022, 04:00 PM\",\n \"time_of_day\": \"evening\"\n },\n {\n \"time_slot\": \"05-05-2022, 04:30 PM\",\n \"time_of_day\": \"evening\"\n },\n {\n \"time_slot\": \"05-05-2022, 05:00 PM\",\n \"time_of_day\": \"evening\"\n },\n {\n \"time_slot\": \"05-05-2022, 05:30 PM\",\n \"time_of_day\": \"evening\"\n },\n {\n \"time_slot\": \"05-05-2022, 06:00 PM\",\n \"time_of_day\": \"night\"\n },\n {\n \"time_slot\": \"05-05-2022, 06:30 PM\",\n \"time_of_day\": \"night\"\n },\n {\n \"time_slot\": \"05-05-2022, 07:00 PM\",\n \"time_of_day\": \"night\"\n },\n {\n \"time_slot\": \"05-05-2022, 07:30 PM\",\n \"time_of_day\": \"night\"\n },\n {\n \"time_slot\": \"05-05-2022, 08:00 PM\",\n \"time_of_day\": \"night\"\n },\n {\n \"time_slot\": \"05-05-2022, 08:30 PM\",\n \"time_of_day\": \"night\"\n }\n ]\n }\n}"},{"id":"630f52c7-2804-47c0-b30a-0c93effc3d40","name":"Success - Future slots in current time of day","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"url":{"raw":"{{host_url}}/partner/consultations/doctors/offline/slots?profile_id=1004-8898-4358-3735&date=09-04-2022&time_of_day=evening","host":["{{host_url}}"],"path":["partner","consultations","doctors","offline","slots"],"query":[{"key":"profile_id","value":"1004-8898-4358-3735"},{"key":"date","value":"09-04-2022"},{"key":"time_of_day","value":"evening"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 04 Apr 2022 13:09:20 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"113"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"7ec4c1e1-e6e0-4656-b133-afca302491a0"},{"key":"x-amz-apigw-id","value":"QDogEHgshcwFkjQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-624aee00-1c4aed6f036ffe7345dd7175"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Found slots\",\n \"response\": {\n \"profile_id\": \"1004-8898-4358-3735\",\n \"date\": \"09-04-2022\",\n \"slots\": [\n {\n \"time_slot\": \"09-04-2022, 05:00 PM\",\n \"time_of_day\": \"evening\"\n },\n {\n \"time_slot\": \"09-04-2022, 05:30 PM\",\n \"time_of_day\": \"evening\"\n }\n ]\n }\n}"},{"id":"ac980600-3de4-42d5-b479-4866decb7207","name":"Error - Date in the past","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"url":{"raw":"{{host_url}}/partner/consultations/doctors/offline/slots?profile_id=1004-8898-4358-3735&date=05-05-2020","host":["{{host_url}}"],"path":["partner","consultations","doctors","offline","slots"],"query":[{"key":"profile_id","value":"1004-8898-4358-3735"},{"key":"date","value":"05-05-2020"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 04 Apr 2022 13:10:52 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"113"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"64580abf-a55c-4820-83bb-8ecf7980f207"},{"key":"x-amz-apigw-id","value":"QDouhGLxBcwFcEA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-624aee5c-166b3d63044aa7821e34eaa9"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"failed\",\n \"message\": \"Cannot fetch slots in the past.\",\n \"response\": {}\n}"}],"_postman_id":"d5cf4f5b-dda7-4305-ac29-e7cd37fb7b4e"},{"name":"[DEPRECATED] Get Order Status","id":"ba6ef089-b3f9-45cf-b15a-fc83dff229cc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"description":"

We have deprecated this API, please register a callback URL to make use of MedPay Partner Webhooks.

\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"ba6ef089-b3f9-45cf-b15a-fc83dff229cc"},{"name":"Create Order","id":"5f154e4e-44c8-4d62-821e-cf6e2b47dd63","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"profile_id\": \"1004-5586-3645-0187\",\n \"specialty\": \"{{speciality}}\",\n \"partner_order_id\": \"{{partner_order_id}}\",\n \"partner_name\": \"{{partner_name}}\",\n \"payment_collection\": \"medpay\",\n \"time_slot\": \"12-03-2023, 03:00 PM\",\n \"customer_details\": {\n \"name\": \"Jane Doe\",\n \"mobile\": \"1234567890\",\n \"gender\": \"female\",\n \"age\": 29,\n \"alternative_mobile\": \"\",\n \"email\": \"xyz@email.in\",\n \"address_details\": {\n \"address\": \"1/6, Gandhi Nagar, pune\",\n \"landmark\": \"gandhi nagar\",\n \"pin_code\": \"126102\",\n \"city\": \"pune\",\n \"state\": \"mumbai\",\n \"coordinates\": \"{{lat,long}}\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/consultations/order/offline/create","description":"

Use Create Order API to book a walk-in/offline doctor consultation appointment. MedPay will find a doctor in our Connected Care Network who is closest to the patient's address and book an appointment.

Request Params:

Param	Description	Type	Format/Values
`partner_order_id` (required)	Partner Order id	String	Unique order ID passed by the Partner. Partner Order ID can only contain letters, numbers, underscores(_) and hyphens(-).
`partner_name` (required)	Name of the partner placing the order	String	Values shared with API access details. Partner name must be more than 3 characters long
`profile_id` (required)	unique profile id of the doctor	String	E.g `1004-8988-5954-3040`
`speciality` (required)	Doctor speciality	String	Can either be the specialty code or the specialty name as mentioned in the Specialties API. For example: `ENT` or `SP05`
`payment_collection` (required)	Payment collection type reference	String	self, medpay
`time_slot` (required)	Preferred timeslot of the patient	String	E.g. `12-05-2022, 03:00 PM`
`customer_details` (required)	Customer meta data	Map[object]
`name` (required)	Customer name	String	Maximum length: 255 char. For e.g, John Doe
`mobile` (required)	10 digits mobile number	String	E.g `880XXXXXXX`
`gender` (optional)	Customer gender	String	Male/Female/Other
`age` (optional)	Customer age	Integer	Age must be between 0 - 99
`alternative_mobile_number` (optional)	10 digits alternate mobile number	String	E.g `880XXXXXXX`
`email` (optional)	Customer valid email id	String	E.g `xyz@email.in`
`address_details` (required)	Customer address meta data	Map[object]
`address` (optional)	Customer full address	String	Minimum length: 2 char
`landmark` (optional)	Customer address landmark	String	Minimum length: 2 char
`pin_code` (optional)	Customer address pincode	String	6 digit pincode. For e.g. 560103
`city` (optional)	Customer address city	String	Minimum length: 2 char
`state` (optional)	Customer address state	String	Minimum length: 2 char
`coordinates` (required)	Comma-separated lat & long	String	e.g `29.3156909,76.3212837`

","urlObject":{"path":["partner","consultations","order","offline","create"],"host":["{{host_url}}"],"query":[],"variable":[]}},"response":[{"id":"243a4e18-a8d5-4b47-be90-1905d80362d7","name":"Success - Create Order with specialty name","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"profile_id\": \"1004-8898-4358-3735\",\n \"specialty\": \"cardiologist\",\n \"partner_order_id\": \"{{partner_order_id}}\",\n \"partner_name\": \"{{partner_name}}\",\n \"payment_collection\": \"medpay\",\n \"time_slot\": \"09-04-2022, 05:00 PM\",\n \"customer_details\": {\n \"name\": \"Jesna James\",\n \"mobile\": \"8547621425\",\n \"gender\": \"female\",\n \"age\": 29,\n \"alternative_mobile\": \"\",\n \"email\": \"xyz@email.in\",\n \"address_details\": {\n \"address\": \"1/6, Gandhi Nagar, pune\",\n \"landmark\": \"gandhi nagar\",\n \"pin_code\": \"126102\",\n \"city\": \"pune\",\n \"state\": \"mumbai\",\n \"coordinates\": \"{{lat,long}}\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/consultations/order/offline/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1388"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Server","value":"Werkzeug/1.0.1 Python/3.8.9"},{"key":"Date","value":"Tue, 05 Apr 2022 06:39:37 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"order created successfully.\",\n \"response\": {\n \"profile_id\": \"1004-8753-8839-0066\",\n \"partner_order_id\": \"{{partner_order_id}}\",\n \"payment_collection\": \"medpay\",\n \"partner_name\": \"{{partner_name}}\",\n \"specialty\": \"dentist\",\n \"order_status\": \"pending\",\n \"booking_details\": {\n \"time_slot\": \"09-04-2022, 05:00 PM\",\n \"consultation_fees\": 800,\n \"doctor_name\": \"Dr. Anuj Patil\",\n \"specialties\": \"dentist\",\n \"languages_speak\": [\n \"English\",\n \"Hindi\"\n ],\n \"clinic_name\": \"Asha Heart Clinic\",\n \"clinic_address\": \"House 1, Scheme no 6, Gandhi Nagar, Jind, Jind,Haryana, 126102\",\n \"coordinates\": \",\"\n },\n \"customer_details\": {\n \"name\": \"Jesna James\",\n \"mobile\": \"8547621425\",\n \"gender\": \"female\",\n \"age\": 29,\n \"alternative_mobile\": \"\",\n \"email\": \"xyz@email.in\",\n \"address_details\": {\n \"address\": \"1/6, Gandhi Nagar, pune\",\n \"landmark\": \"gandhi nagar\",\n \"pin_code\": \"126102\",\n \"city\": \"pune\",\n \"state\": \"mumbai\"\n }\n },\n \"created_by\": \"testpartner\",\n \"created_at\": \"05/04/2022 12:09:36.406790\"\n }\n}"},{"id":"81599512-e91a-45f1-95ff-8f7ed954387a","name":"Success - Create order with specialty code","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"profile_id\": \"1104-2007-2021-6272\",\n \"specialty\": \"SP05\",\n \"partner_order_id\": \"0904329\",\n \"partner_name\": \"{{partner_name}}\",\n \"payment_collection\": \"medpay\",\n \"time_slot\": \"09-04-2022, 05:00 PM\",\n \"customer_details\": {\n \"name\": \"Jesna James\",\n \"mobile\": \"8547621425\",\n \"gender\": \"female\",\n \"age\": 29,\n \"alternative_mobile\": \"\",\n \"email\": \"xyz@email.in\",\n \"address_details\": {\n \"address\": \"1/6, Gandhi Nagar, pune\",\n \"landmark\": \"gandhi nagar\",\n \"pin_code\": \"126102\",\n \"city\": \"pune\",\n \"state\": \"mumbai\",\n \"coordinates\": \"{{lat,long}}\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/consultations/order/offline/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 09 Apr 2022 09:59:54 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1409"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"84b1e09c-6eae-4cf7-b1ee-231003d9a229"},{"key":"x-amz-apigw-id","value":"QTrcFGJsBcwFS5w="},{"key":"X-Amzn-Trace-Id","value":"Root=1-62515919-05326e0150f6a1d211d7caf0"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"order created successfully.\",\n \"response\": {\n \"profile_id\": \"1104-2007-2021-6272\",\n \"partner_order_id\": \"0904329\",\n \"payment_collection\": \"medpay\",\n \"partner_name\": \"testpartner\",\n \"specialty\": \"ent\",\n \"order_status\": \"pending\",\n \"booking_details\": {\n \"time_slot\": \"09-04-2022, 05:00 PM\",\n \"consultation_fees\": \"900\",\n \"doctor_name\": \"Dr. Anish Gupta\",\n \"specialties\": \"ent\",\n \"languages_speak\": [\n \"English\"\n ],\n \"clinic_name\": \"62 Clinic\",\n \"clinic_address\": \"Basement Of 98.4 Pharmacy, Tot Mall, Sector 62, Tot Mall,Sector 62, Noida,Uttar Pradesh, 201301\",\n \"coordinates\": \"28.61422833,77.37116833\"\n },\n \"customer_details\": {\n \"name\": \"Jesna James\",\n \"mobile\": \"8547621425\",\n \"gender\": \"female\",\n \"age\": 29,\n \"alternative_mobile\": \"\",\n \"email\": \"xyz@email.in\",\n \"address_details\": {\n \"address\": \"1/6, Gandhi Nagar, pune\",\n \"landmark\": \"gandhi nagar\",\n \"pin_code\": \"126102\",\n \"city\": \"pune\",\n \"state\": \"mumbai\"\n }\n },\n \"created_by\": \"testpartner\",\n \"created_at\": \"09/04/2022 15:29:54.549760\"\n }\n}"},{"id":"6ff75dbc-bfaf-4637-99b2-572f2468b4aa","name":"Error - Duplicate Order ID","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"clinic_id\": \"locChIJ6RRXe6OjczkRhJQB0pqKOd0\",\n \"specialty\": \"neurology\",\n \"partner_order_id\": \"01040640\",\n \"partner_name\": \"{{partner_name}}\",\n \"payment_collection\": \"medpay\",\n \"time_slot\": \"09-04-2022, 05:00 PM\",\n \"customer_details\": {\n \"name\": \"Jesna James\",\n \"mobile\": \"8547621425\",\n \"gender\": \"female\",\n \"age\": 29,\n \"alternative_mobile\": \"\",\n \"email\": \"xyz@email.in\",\n \"address_details\": {\n \"address\": \"1/6, Gandhi Nagar, pune\",\n \"landmark\": \"gandhi nagar\",\n \"pin_code\": \"126102\",\n \"city\": \"pune\",\n \"state\": \"mumbai\",\n \"coordinates\": \"{{lat,long}}\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"http://orders-service-dev.eba-mpw73ras.ap-south-1.elasticbeanstalk.com/partner/consultations/order/offline/create"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Sun, 12 Sep 2021 08:57:46 GMT"},{"key":"Server","value":"Apache/2.4.46 (Amazon) mod_wsgi/3.5 Python/3.6.12"},{"key":"Content-Length","value":"934"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"failed\",\n \"message\": \"order with partner_order_id already exist.\",\n \"response\": {\n \"profile_id\": \"{{profile_id}}\",\n \"specialty\": \"dentist\",\n \"partner_order_id\": \"{{partner_order_id}}\",\n \"partner_name\": \"{{partner_name}}\",\n \"payment_collection\": \"medpay\",\n \"time_slot\": \"09-04-2022, 05:00 PM\",\n \"customer_details\": {\n \"name\": \"Jesna James\",\n \"mobile\": \"8547621425\",\n \"gender\": \"female\",\n \"age\": 29,\n \"alternative_mobile\": \"\",\n \"email\": \"xyz@email.in\",\n \"address_details\": {\n \"address\": \"1/6, Gandhi Nagar, pune\",\n \"landmark\": \"gandhi nagar\",\n \"pin_code\": \"126102\",\n \"city\": \"pune\",\n \"state\": \"mumbai\",\n \"coordinates\": \"{{lat,long}}\"\n }\n },\n \"consultation_type\": \"offline\"\n }\n}"},{"id":"bd388c9c-4555-4271-a0ad-378387947891","name":"Error - Validation Error","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"profile_id\": \"{{profile_id}}\",\n \"partner_order_id\": \"{{partner_order_id}}\",\n \"partner_name\": \"{{partner_name}}\",\n \"payment_collection\": \"medpay\",\n \"time_slot\": \"09-04-2022, 05:00 PM\",\n \"customer_details\": {\n \"name\": \"Jesna James\",\n \"mobile\": \"8547621425\",\n \"gender\": \"female\",\n \"age\": 29,\n \"alternative_mobile\": \"\",\n \"email\": \"xyz@email.in\",\n \"address_details\": {\n \"address\": \"1/6, Gandhi Nagar, pune\",\n \"landmark\": \"gandhi nagar\",\n \"pin_code\": \"126102\",\n \"city\": \"pune\",\n \"state\": \"mumbai\",\n \"coordinates\": \"{{lat,long}}\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/consultations/order/offline/create"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Sun, 12 Sep 2021 08:58:37 GMT"},{"key":"Server","value":"Apache/2.4.46 (Amazon) mod_wsgi/3.5 Python/3.6.12"},{"key":"Content-Length","value":"134"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": {\n \"specialty\": \"'specialty' is a required property\"\n },\n \"message\": \"Input payload validation failed\"\n}"},{"id":"49883f54-61e9-42cd-8449-9438d2bf3f65","name":"Error - Invalid specialty","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"profile_id\": \"1104-2007-2021-6272\",\n \"specialty\": \"SP050\",\n \"partner_order_id\": \"0904339\",\n \"partner_name\": \"{{partner_name}}\",\n \"payment_collection\": \"medpay\",\n \"time_slot\": \"09-04-2022, 05:00 PM\",\n \"customer_details\": {\n \"name\": \"Jesna James\",\n \"mobile\": \"8547621425\",\n \"gender\": \"female\",\n \"age\": 29,\n \"alternative_mobile\": \"\",\n \"email\": \"xyz@email.in\",\n \"address_details\": {\n \"address\": \"1/6, Gandhi Nagar, pune\",\n \"landmark\": \"gandhi nagar\",\n \"pin_code\": \"126102\",\n \"city\": \"pune\",\n \"state\": \"mumbai\",\n \"coordinates\": \"{{lat,long}}\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/consultations/order/offline/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 09 Apr 2022 10:09:03 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"902"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"b4f19eac-cbb4-4c05-8ea0-3b608d512de8"},{"key":"x-amz-apigw-id","value":"QTsx2EiuhcwFoWg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-62515b3e-5b3f21971453716b77721c74"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"failed\",\n \"message\": \"invalid specialty\",\n \"response\": {\n \"profile_id\": \"1104-2007-2021-6272\",\n \"specialty\": \"SP050\",\n \"partner_order_id\": \"0904339\",\n \"partner_name\": \"testpartner\",\n \"payment_collection\": \"medpay\",\n \"time_slot\": \"09-04-2022, 05:00 PM\",\n \"customer_details\": {\n \"name\": \"Jesna James\",\n \"mobile\": \"8547621425\",\n \"gender\": \"female\",\n \"age\": 29,\n \"alternative_mobile\": \"\",\n \"email\": \"xyz@email.in\",\n \"address_details\": {\n \"address\": \"1/6, Gandhi Nagar, pune\",\n \"landmark\": \"gandhi nagar\",\n \"pin_code\": \"126102\",\n \"city\": \"pune\",\n \"state\": \"mumbai\",\n \"coordinates\": \"12.98,77.64\"\n }\n },\n \"consultation_type\": \"offline\"\n }\n}"}],"_postman_id":"5f154e4e-44c8-4d62-821e-cf6e2b47dd63"},{"name":"Confirm Order","id":"b4f1de04-719a-468c-8fd7-9b561b82b460","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partner_order_id\": \"{{partner_order_id}}\",\n \"partner_name\": \"{{partner_name}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/consultations/order/confirm","description":"

In case a consultation order was modified by MedPay (in the event of changes to the requested doctor, appointment date/time, etc.), use the Partner Confirmation API to confirm that the changes are acceptable to the patient. If yes, the status of the order will move from partner_pending to accepted.

\n
Note: This API has to be called only if an order is in partner_pending state.
\n

Request Params:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Param	Description	Type	Format/Values
`partner_order_id` (required)	Partner Order id	String	Unique order id passed by the Partner
`partner_name` (required)	Name of the partner placing the order	String	Values shared with API access details

","urlObject":{"path":["partner","consultations","order","confirm"],"host":["{{host_url}}"],"query":[],"variable":[]}},"response":[{"id":"b54bf71c-f0b9-4ee8-9e03-8af26b8ea279","name":"Error - Duplicate Order ID","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"partner_order_id\": \"{{partner_order_id}}\",\n \"partner_name\": \"{{partner_name}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/consultations/order/confirm"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Sun, 12 Sep 2021 09:22:27 GMT"},{"key":"Server","value":"Apache/2.4.46 (Amazon) mod_wsgi/3.5 Python/3.6.12"},{"key":"Content-Length","value":"176"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"failed\",\n \"message\": \"order confirmation failed.\",\n \"response\": {\n \"partner_order_id\": \"2001440\",\n \"partner_name\": \"testpartner\"\n }\n}"},{"id":"7aa210ba-123b-4c32-8a40-c5c8cde729a5","name":"Success - Order confirmed","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partner_order_id\": \"{{partner_order_id}}\",\n \"partner_name\": \"{{partner_name}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/consultations/order/confirm"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 02 Apr 2022 08:47:11 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"330"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"70f4ac41-adbb-4a0c-8087-a1346f529157"},{"key":"x-amz-apigw-id","value":"P8cOMEsKhcwFpVg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-62480d8d-3bf80a8031861ff906d05633"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"invoice generated successfully.\",\n \"response\": {\n \"partner_order_id\": \"2001440\",\n \"partner_name\": \"testpartner\",\n \"order_status\": \"invoice_generated\",\n \"created_at\": \"30/03/2022 13:48:14.781217\",\n \"modified_at\": \"02/04/2022 14:17:11.520845\"\n }\n}"}],"_postman_id":"b4f1de04-719a-468c-8fd7-9b561b82b460"},{"name":"Update Payment Status","id":"f36b3e32-54e8-49ee-ad78-bcee82071737","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partner_order_id\": \"{{partner_order_id}}\",\n \"invoice_id\":\"inv167172119378108\",\n \"partner_name\": \"{{partner_name}}\",\n \"payment_details\":{\n \"reference_id\": \"3213\",\n \"net_amount\": \"400\",\n \"payment_type\": \"card\",\n \"payment_timestamp\": \"\" ,\n \"notes\" : \"\" \n },\n \"payer_payable\": \"400\",\n \"patient_payable\": \"0\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/consultations/order/payment/confirm","description":"

Use the Update Payment Status API to provide confirmation on the payment status.

\n
Note: Payment confirmation is required from partner before the order status can be updated
Note: Payment can be made fully or partially, in which case, the patient has to complete the payment to update the order status. The link for patient to complete payment will be provided in the webhook notification and sent directly to the patient via WhatsApp message.
\n

Request Params:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Param	Description	Type	Format/Values
`partner_order_id` (required)	Partner Order id	String	Unique order id passed by the Partner
`partner_name` (required)	Name of the partner placing the order	String	Values shared with API access details
`invoice_id` (required)	Unique invoice id generated by MedPay when order status changes to invoice_generated	String	E.g \"inv187258418906901\"
`payment_details` (required)	Payment meta data	Map[object]	E.g \"inv187258418906901\"
`reference_id` (required)	Unique payment reference ID generated by Partner	String	E.g \"32132323\"
`net_amount` (required)	Amount paid by the patient	String	E.g \"201.50\"
`payment_type` (required)	Payment mode type	String	card, upi, internet_banking, voucher, other
`payment_timestamp` (required)	Payment Timestamp	String
`notes` (optional)	Notes	String	To pass additional notes
`payer_payable` (required)	Amount paid by the payer	String	E.g \"201.50\"
`patient_payable` (required)	Amount paid by the patient	String	E.g \"1.50\"

","urlObject":{"path":["partner","consultations","order","payment","confirm"],"host":["{{host_url}}"],"query":[],"variable":[]}},"response":[{"id":"6ac42235-217f-4522-bc01-19a819c7e421","name":"Success - Complete payment","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partner_order_id\": \"01040650\",\n \"invoice_id\":\"inv167172119378108\",\n \"partner_name\": \"{{partner_name}}\",\n \"payment_details\":{\n \"reference_id\": \"3213\",\n \"net_amount\": \"400\",\n \"payment_type\": \"card\",\n \"payment_timestamp\": \"\" ,\n \"notes\" : \"\" \n },\n \"payer_payable\": \"400\",\n \"patient_payable\": \"0\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/consultations/order/payment/confirm"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 01 Apr 2022 13:30:32 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"618"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"e6e4f05d-cd20-418d-8c0e-b329dd4f98f4"},{"key":"x-amz-apigw-id","value":"P5yy0HLwBcwFXMw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6246fe78-7bef8a4965ffd8360b2f7f87"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"payment confirmed successfully.\",\n \"response\": {\n \"partner_order_id\": \"01040650\",\n \"partner_name\": \"testpartner\",\n \"invoice_id\": \"inv167172119378108\",\n \"payment_status\": \"success\",\n \"payment_details\": {\n \"reference_id\": \"3213\",\n \"net_amount\": \"400\",\n \"payment_type\": \"card\",\n \"payment_timestamp\": \"\",\n \"notes\": \"\"\n },\n \"order_status\": \"payment_collected\",\n \"created_at\": \"01/04/2022 18:50:25.356530\",\n \"modified_at\": \"01/04/2022 19:00:32.429463\"\n }\n}"},{"id":"d3bc52b7-e645-4661-84ed-3c05caa1d47f","name":"Success - Partial payment","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partner_order_id\": \"01040700\",\n \"invoice_id\": \"inv314657707410991\",\n \"partner_name\": \"{{partner_name}}\",\n \"payment_details\": {\n \"reference_id\": \"3213\",\n \"net_amount\": \"400\",\n \"payment_type\": \"card\",\n \"payment_timestamp\": \"\",\n \"notes\": \"\"\n },\n \"payer_payable\": \"300\",\n \"patient_payable\": \"100\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/consultations/order/payment/confirm"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 01 Apr 2022 13:31:46 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"692"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"088aeacf-78c9-4dd2-bea9-cff3cbc4f814"},{"key":"x-amz-apigw-id","value":"P5y-THzyBcwFlFw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6246fec1-1db3a067230c0c490f1ef9ed"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"payment confirmed successfully.\",\n \"response\": {\n \"partner_order_id\": \"01040700\",\n \"partner_name\": \"testpartner\",\n \"invoice_id\": \"inv314657707410991\",\n \"payment_status\": \"success\",\n \"payment_details\": {\n \"reference_id\": \"3213\",\n \"net_amount\": \"400\",\n \"payment_type\": \"card\",\n \"payment_timestamp\": \"\",\n \"notes\": \"\",\n \"payer_payable\": \"300\",\n \"patient_payable\": \"100\"\n },\n \"order_status\": \"payment_collected\",\n \"created_at\": \"01/04/2022 18:53:31.509089\",\n \"modified_at\": \"01/04/2022 19:01:45.911863\"\n }\n}"},{"id":"10432226-42f4-4c49-adc4-02aee72a48a7","name":"Error - Invalid invoice","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partner_order_id\": \"appointment3\",\n \"invoice_id\": \"inv337312346892246\",\n \"partner_name\": \"uat_partner\",\n \"payment_details\": {\n \"reference_id\": \"3213\",\n \"net_amount\": \"400\",\n \"payment_type\": \"card\",\n \"payment_timestamp\": \"\",\n \"notes\": \"\"\n },\n \"payer_payable\": \"400\",\n \"patient_payable\": \"0\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/consultations/order/payment/confirm"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Sun, 12 Sep 2021 10:37:09 GMT"},{"key":"Server","value":"Apache/2.4.46 (Amazon) mod_wsgi/3.5 Python/3.6.12"},{"key":"Content-Length","value":"118"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"failed\",\n \"message\": \"partial amount is not acceptable for net_amount: 400\",\n \"response\": {}\n}"},{"id":"ede063a3-c45f-4428-a6e3-48b5dcdaa5e4","name":"Error - Already confirmed","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partner_order_id\": \"01040700\",\n \"invoice_id\": \"inv314657707410991\",\n \"partner_name\": \"{{partner_name}}\",\n \"payment_details\": {\n \"reference_id\": \"3213\",\n \"net_amount\": \"300\",\n \"payment_type\": \"card\",\n \"payment_timestamp\": \"\",\n \"notes\": \"\"\n },\n \"payer_payable\": \"300\",\n \"patient_payable\": \"100\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/consultations/order/payment/confirm"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 01 Apr 2022 13:32:19 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"115"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"1a6b8f83-f9fc-440a-9423-53c013ede1ec"},{"key":"x-amz-apigw-id","value":"P5zDgHa7BcwFSRg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6246fee3-744eef8268b371c2378e751b"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"failed\",\n \"message\": \"payment cannot be confirmed or already confirmed.\",\n \"response\": {}\n}"}],"_postman_id":"f36b3e32-54e8-49ee-ad78-bcee82071737"},{"name":"Cancel Order","id":"e61f0c20-b445-4645-b518-bb66bc738047","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partner_order_id\": \"{{partner_order_id}}\",\n \"partner_name\": \"{{partner_name}}\",\n \"cancellation_code\": \"CC08\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/consultations/order/cancel","description":"

Use the Cancel Order API to cancel an existing order. An order can be cancelled upto 1 hour before the scheduled appointment time if it is in the following states:

pending
partner_pending
accepted
invoice_generated
payment_pending
payment_collected
booking_confirmed

Request Params:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Param	Description	Type	Format/Values
`partner_order_id` (required)	Partner Order ID	String	Unique order id passed by the Partner
`partner_name` (required)	Name of the partner placing the order	String	Values shared with API access details
`cancellation_code` (required)	Code for cancellation	String	Acceptable cancellation codes are tabulated below.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Cancellation Code	Cancellation Reason
CC01	Payment not done
CC08	Patient not happy with alternate provider / timings
CC09	No confirmation from patient

\n
Note: Currently, the Cancel Order API allows either a free-text cancellation reason or a cancellation code that uniquely identifies a specific cancellation reason. From 28 February 2023, the cancelled_reason field will be deprecated and cancellation_code will be made mandatory.
\n

\n","urlObject":{"path":["partner","consultations","order","cancel"],"host":["{{host_url}}"],"query":[],"variable":[]}},"response":[{"id":"f05654d2-8db5-446f-b6f0-6d69426ecb2c","name":"Success - Order cancelled","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"partner_order_id\": \"{{partner_order_id}}\",\n \"partner_name\": \"{{partner_name}}\",\n \"cancellation_code\": \"CC08\"\n}","options":{"raw":{"language":"json"}}},"url":"http://orders-service-dev.eba-mpw73ras.ap-south-1.elasticbeanstalk.com/partner/consultations/order/cancel"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Wed, 08 Sep 2021 11:21:28 GMT"},{"key":"Server","value":"Apache/2.4.46 (Amazon) mod_wsgi/3.5 Python/3.6.12"},{"key":"Content-Length","value":"349"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"order cancelled successfully.\",\n \"response\": {\n \"partner_order_id\": \"cons1\",\n \"partner_name\": \"testpartner\",\n \"order_status\": \"cancelled\",\n \"cancelled_reason\": \"Patient not happy with alternate provider / timings\",\n \"cancelled_by\": \"testpartner\",\n \"cancelled_at\": \"23/02/2023 12:23:31.778307\"\n }\n}"},{"id":"f9b645bb-689b-4d6f-ab0a-479adf3c2979","name":"Error - Already cancelled","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partner_order_id\": \"{{partner_order_id}}\",\n \"partner_name\": \"{{partner_name}}\",\n \"cancelled_reason\": \"not required\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/consultations/order/cancel"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Sun, 12 Sep 2021 09:12:45 GMT"},{"key":"Server","value":"Apache/2.4.46 (Amazon) mod_wsgi/3.5 Python/3.6.12"},{"key":"Content-Length","value":"245"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"failed\",\n \"message\": \"order partner id: 01040640 is already cancelled.\",\n \"response\": {\n \"partner_order_id\": \"01040640\",\n \"partner_name\": \"testpartner\",\n \"cancelled_reason\": \"not required\"\n }\n}"}],"_postman_id":"e61f0c20-b445-4645-b518-bb66bc738047"}],"id":"5206311b-ea45-4f64-b6b6-c0874cf4b6d4","description":"

The Offline Consultation APIs have been deprecated. We will be releasing Offline Consultation V2 shortly.

Partner Webhooks:

\n
Note: Response fields may vary, as per current order states.
\n

Webhook URL: Please share webhook_url to get timely order updates.

Method: POST

Events:
partner_pending
accepted
invoice_generated
payment_pending
payment_collected
booking_confirmed
booking_completed
prescription_uploaded

Sample webhook POST Event structure:

order-accepted:

{\n  \"partner_order_id\": \"cons1\",\n  \"partner_name\": \"uat_partner\",\n  \"order_status\": \"accepted\",\n  \"timestamp\": \"06/06/2022 14:27:22.326782\"\n} \n\n

partner-pending:

#rescheduled\n{\n  \"partner_order_id\": \"cons1\",\n  \"partner_name\": \"uat_partner\",\n  \"order_status\": \"partner_pending\",\n  \"booking_details\": {\n    \"name\": \"Dr. Anish Gupta\",\n    \"specialties\": [\n      \"ENT\"\n    ],\n    \"address\": \"Basement Of 98.4 Pharmacy, Tot Mall, Sector 62, Tot Mall,Sector 62, Noida,Uttar Pradesh, 201301\",\n    \"coordinates\": \"28.61422833,77.37116833\",\n    \"time_slot\": \"21-09-2022, 4:00 PM\",\n    \"change_type\": \"rescheduled\",\n    \"requested_booking_details\": {\n      \"name\": \"Dr. Anish Gupta\",\n      \"specialties\": [\n        \"ENT\"\n      ],\n      \"address\": \"Basement Of 98.4 Pharmacy, Tot Mall, Sector 62, Tot Mall,Sector 62, Noida,Uttar Pradesh, 201301\",\n      \"coordinates\": \"28.61422833,77.37116833\",\n      \"time_slot\": \"21-09-2022, 03:00 PM\"\n    }\n  },\n  \"timestamp\": \"20/08/2022 13:44:27.273588\"\n}\n#reassigned\n{\n  \"partner_order_id\": \"cons1\",\n  \"partner_name\": \"uat_partner\",\n  \"order_status\": \"partner_pending\",\n  \"booking_details\": {\n    \"name\": \"Dr. Sudarshen Prabhakar Aahire\",\n    \"specialties\": [\n      \"ENT\"\n    ],\n    \"address\": \"#2Nd Floor, Vyjayanthi Apartment, Near Jyothi Book Stores., Infront Of Kthm College.,Gangapur, Nashik,Maharashtra, 422005\",\n    \"coordinates\": \"20.0059109,73.7767701\",\n    \"time_slot\": \"12-06-2022, 3:00 PM\",\n    \"change_type\": \"reassigned\",\n    \"requested_booking_details\": {\n      \"name\": \"Dr. Anish Gupta\",\n      \"specialties\": [\n        \"ENT\"\n      ],\n      \"address\": \"Basement Of 98.4 Pharmacy, Tot Mall, Sector 62, Tot Mall,Sector 62, Noida,Uttar Pradesh, 201301\",\n      \"coordinates\": \"28.61422833,77.37116833\",\n      \"time_slot\": \"12-06-2022, 03:00 PM\"\n    }\n  },\n  \"timestamp\": \"06/06/2022 15:08:10.617321\"\n}\n#rescheduled_and_reassigned\n{\n  \"partner_order_id\": \"cons1\",\n  \"partner_name\": \"uat_partner\",\n  \"order_status\": \"partner_pending\",\n  \"booking_details\": {\n    \"name\": \"Dr. Sudarshen Prabhakar Aahire\",\n    \"specialties\": [\n      \"ENT\"\n    ],\n    \"address\": \"#2Nd Floor, Vyjayanthi Apartment, Near Jyothi Book Stores., Infront Of Kthm College.,Gangapur, Nashik,Maharashtra, 422005\",\n    \"coordinates\": \"20.0059109,73.7767701\",\n    \"time_slot\": \"12-06-2022, 8:00 PM\",\n    \"change_type\": \"rescheduled_and_reassigned\",\n    \"requested_booking_details\": {\n      \"name\": \"Dr. Anish Gupta\",\n      \"specialties\": [\n        \"ENT\"\n      ],\n      \"address\": \"Basement Of 98.4 Pharmacy, Tot Mall, Sector 62, Tot Mall,Sector 62, Noida,Uttar Pradesh, 201301\",\n      \"coordinates\": \"28.61422833,77.37116833\",\n      \"time_slot\": \"12-06-2022, 3:00 PM\"\n    }\n  },\n  \"timestamp\": \"06/06/2022 15:13:43.593552\"\n}\n\n

invoice-generated:

{\n  \"partner_order_id\": \"cons1\",\n  \"partner_name\": \"uat_partner\",\n  \"order_status\": \"invoice_generated\",\n  \"invoice_details\": {\n    \"partner_discount\": \"0\",\n    \"tgst\": \"0\",\n    \"bill_amount\": \"900.0\",\n    \"invoice_no\": \"\",\n    \"payment_status\": \"pending\",\n    \"invoice_id\": \"inv132020729067028\",\n    \"payment_collection\": \"medpay\",\n    \"net_amount\": \"900.0\",\n    \"invoice_link\": \"https://mdpy.in/oqMWbGzgJz\"\n  },\n  \"timestamp\": \"06/06/2022 14:27:23.891079\"\n}\n\n

payment-pending:

{\n  \"partner_order_id\": \"cons1\",\n  \"partner_name\": \"uat_partner\",\n  \"order_status\": \"payment_pending\",\n  \"payment_details\": {\n    \"payment_timestamp\": \"\",\n    \"payment_type\": \"card\",\n    \"net_amount\": \"900\",\n    \"notes\": \"\",\n    \"reference_id\": \"3213\",\n    \"payer_payable\": \"899.0\",\n    \"patient_payable\": \"1.0\",\n    \"patient_payable_details\": {\n      \"transaction_id\": \"REQ594999591097\",\n      \"link\": \"https://mdpy.in/WlpHzUlHvg\",\n      \"status\": \"payment link sent successfully\",\n      \"timestamp\": \"06/06/2022 14:44:36.023251\"\n    }\n  },\n  \"timestamp\": \"06/06/2022 14:44:35.510315\"\n}\n\n

payment-collected without patient payable

{\n  \"partner_order_id\": \"cons1\",\n  \"partner_name\": \"uat_partner\",\n  \"order_status\": \"payment_collected\",\n  \"payment_details\": {\n    \"payment_timestamp\": \"\",\n    \"payment_type\": \"card\",\n    \"net_amount\": \"900\",\n    \"notes\": \"\",\n    \"reference_id\": \"3213\"\n  },\n  \"timestamp\": \"06/06/2022 14:53:11.338847\"\n}\n\n

payment-collected with patient payable:

{\n  \"partner_order_id\": \"cons1\",\n  \"partner_name\": \"uat_partner\",\n  \"order_status\": \"payment_collected\",\n  \"payment_details\": {\n    \"delivery_fee\": 0,\n    \"payment_type\": \"payu\",\n    \"payer_payable\": \"899.0\",\n    \"delivery_partner\": \"medpay\",\n    \"patient_payable\": \"1.0\",\n    \"order_amount\": \"900.0\"\n  },\n  \"timestamp\": \"04/08/2022 17:46:42.148838\"\n}\n\n

booking_confirmed:

{\n  \"partner_order_id\": \"cons1\",\n  \"partner_name\": \"uat_partner\",\n  \"order_status\": \"booking_confirmed\",\n  \"booking_details\": {\n    \"name\": \"Dr. Anish Gupta\",\n    \"specialties\": [\n      \"ENT\"\n    ],\n    \"address\": \"Basement Of 98.4 Pharmacy, Tot Mall, Sector 62, Tot Mall,Sector 62, Noida,Uttar Pradesh, 201301\",\n    \"coordinates\": \"28.61422833,77.37116833\",\n    \"time_slot\": \"12-06-2022, 4:00 PM\",\n    \"gender\": \"Male\",\n    \"experience_in_years\": \"18\",\n    \"degrees\": [\n      \"MBBS\",\n      \" MS\"\n    ],\n    \"languages_speak\": [\n      \"English\"\n    ],\n    \"patient_check_in_url\": \"https://ccn-dev.medpay.in?token=278643812528232\"\n  }\n}\n\n

booking_completed:

{\n  \"partner_order_id\": \"cons1\",\n  \"partner_name\": \"uat_partner\",\n  \"order_status\": \"booking_completed\",\n  \"timestamp\": \"06/06/2022 14:49:08.415360\",\n  \"booking_details\": {\n    \"customer_name\": \"Jesna James\",\n    \"name\": \"Dr. Anish Gupta\",\n    \"specialties\": [\n      \"ENT\"\n    ],\n    \"address\": \"Basement Of 98.4 Pharmacy, Tot Mall, Sector 62, Tot Mall,Sector 62, Noida,Uttar Pradesh, 201301\",\n    \"coordinates\": \"28.61422833,77.37116833\",\n    \"time_slot\": \"12-06-2022, 4:00 PM\"\n  }\n}\n\n

prescription-uploaded:

{\n  \"partner_order_id\": \"cons1\",\n  \"partner_name\": \"uat_partner\",\n  \"order_status\": \"prescription_uploaded\",\n  \"timestamp\": \"06/06/2022 14:49:19.661901\",\n  \"rx_details\": {\n    \"links\": [\n      \"https://dev-orders-rx.s3.ap-southeast-1.amazonaws.com/practo_prescription_1654507156.pdf\"\n    ]\n  }\n}\n\n

order-cancelled:

{\n    \"partner_order_id\": \"appointment1\",\n    \"partner_name\": \"uat_partner\",\n    \"order_status\": \"cancelled\",\n    \"cancelled_by\": \"self\",\n    \"cancelled_reason\": \"Patient has cancelled the appointment\",\n    \"timestamp\": \"2021-04-18 09:59:14.257219+05:30\",\n}\n\n

","_postman_id":"5206311b-ea45-4f64-b6b6-c0874cf4b6d4"},{"name":"[DEPRECATED] Online: Tele/Video consultation","item":[{"name":"List specialties","id":"d0047509-ad1d-42f5-9f25-a61cb9bd87ba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"url":"{{host_url}}/partner/consultations/doctors/specialties","description":"

This API can be used to fetch the list of specialties.

Path Params:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Param	Description	Type	Format/Values
`category` (optional)	General category of specialty	String	Acceptable values: `general`, `specialty`, `super_specialty`

","urlObject":{"path":["partner","consultations","doctors","specialties"],"host":["{{host_url}}"],"query":[],"variable":[]}},"response":[{"id":"4d00d0bc-8a56-4e52-bc78-2b2ec176af57","name":"Success - All","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"url":"{{host_url}}/partner/consultations/doctors/specialties"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 07 Apr 2022 07:12:55 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1749"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"4a2bfced-5dc2-4bdf-8ac8-3870c87e16f2"},{"key":"x-amz-apigw-id","value":"QMtGoHvPBcwFamA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-624e8ef7-2262782a34bbd235577c59d5"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Found specialties\",\n \"response\": [\n {\n \"code\": \"SP01\",\n \"specialty\": \"Cardiologist\",\n \"category\": \"specialty\"\n },\n {\n \"code\": \"SP02\",\n \"specialty\": \"Dentist\",\n \"category\": \"general\"\n },\n {\n \"code\": \"SP03\",\n \"specialty\": \"Dermatologist\",\n \"category\": \"specialty\"\n },\n {\n \"code\": \"SP04\",\n \"specialty\": \"Endocrinologist\",\n \"category\": \"specialty\"\n },\n {\n \"code\": \"SP05\",\n \"specialty\": \"ENT\",\n \"category\": \"specialty\"\n },\n {\n \"code\": \"SP06\",\n \"specialty\": \"Gastroenterologist\",\n \"category\": \"super_specialty\"\n },\n {\n \"code\": \"SP07\",\n \"specialty\": \"General Physician\",\n \"category\": \"general\"\n },\n {\n \"code\": \"SP08\",\n \"specialty\": \"General Surgeon\",\n \"category\": \"specialty\"\n },\n {\n \"code\": \"SP09\",\n \"specialty\": \"Gynaecologists & Obstetrician\",\n \"category\": \"specialty\"\n },\n {\n \"code\": \"SP10\",\n \"specialty\": \"Internal Medicine\",\n \"category\": \"specialty\"\n },\n {\n \"code\": \"SP11\",\n \"specialty\": \"Nephrologist\",\n \"category\": \"specialty\"\n },\n {\n \"code\": \"SP12\",\n \"specialty\": \"Neurologist\",\n \"category\": \"specialty\"\n },\n {\n \"code\": \"SP13\",\n \"specialty\": \"Oncology\",\n \"category\": \"super_specialty\"\n },\n {\n \"code\": \"SP14\",\n \"specialty\": \"Ophthalmology \",\n \"category\": \"specialty\"\n },\n {\n \"code\": \"SP15\",\n \"specialty\": \"Orthopaedic\",\n \"category\": \"specialty\"\n },\n {\n \"code\": \"SP16\",\n \"specialty\": \"Paediatrician\",\n \"category\": \"specialty\"\n },\n {\n \"code\": \"SP17\",\n \"specialty\": \"Plastic Surgeon\",\n \"category\": \"super_specialty\"\n },\n {\n \"code\": \"SP18\",\n \"specialty\": \"Psychiatrist \",\n \"category\": \"specialty\"\n },\n {\n \"code\": \"SP19\",\n \"specialty\": \"Pulmonologist\",\n \"category\": \"super_specialty\"\n },\n {\n \"code\": \"SP20\",\n \"specialty\": \"Urologist\",\n \"category\": \"super_specialty\"\n },\n {\n \"code\": \"SP21\",\n \"specialty\": \"Vascular Surgeon\",\n \"category\": \"super_specialty\"\n }\n ]\n}"},{"id":"a827290e-f035-435e-89e4-d044238eb187","name":"Success - Super Specialty","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"url":{"raw":"{{host_url}}/partner/consultations/doctors/specialties?category=super_specialty","host":["{{host_url}}"],"path":["partner","consultations","doctors","specialties"],"query":[{"key":"category","value":"super_specialty"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 07 Apr 2022 07:13:15 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"887"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"27c1056e-0d3e-48e3-b70d-f711ef1bd242"},{"key":"x-amz-apigw-id","value":"QMtJzG5gBcwFfxw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-624e8f0b-41b283652853d01756a65bd2"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Found specialties\",\n \"response\": [\n {\n \"code\": \"SP06\",\n \"specialty\": \"Gastroenterologist\",\n \"category\": \"super_specialty\"\n },\n {\n \"code\": \"SP13\",\n \"specialty\": \"Oncology\",\n \"category\": \"super_specialty\"\n },\n {\n \"code\": \"SP17\",\n \"specialty\": \"Plastic Surgeon\",\n \"category\": \"super_specialty\"\n },\n {\n \"code\": \"SP19\",\n \"specialty\": \"Pulmonologist\",\n \"category\": \"super_specialty\"\n },\n {\n \"code\": \"SP20\",\n \"specialty\": \"Urologist\",\n \"category\": \"super_specialty\"\n },\n {\n \"code\": \"SP21\",\n \"specialty\": \"Vascular Surgeon\",\n \"category\": \"super_specialty\"\n }\n ]\n}"},{"id":"ca487327-ec1c-4054-90f4-b44765d78990","name":"Error - Invalid category","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"url":{"raw":"{{host_url}}/partner/consultations/doctors/specialties?category=medical","host":["{{host_url}}"],"path":["partner","consultations","doctors","specialties"],"query":[{"key":"category","value":"medical"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 07 Apr 2022 07:15:26 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"e1c95e9b-f5cb-4492-adcd-e014d8043e6d"},{"key":"x-amz-apigw-id","value":"QMteVFlnhcwFXfA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-624e8f8e-2d8e06d6077329055a91bbda"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"failed\",\n \"message\": \"Invalid category\",\n \"response\": {}\n}"}],"_postman_id":"d0047509-ad1d-42f5-9f25-a61cb9bd87ba"},{"name":"[DEPRECATED] Get Order Status","id":"eb8ea71a-411d-4767-89d1-5188f6519e7a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"description":"

We have deprecated this API, please register a callback URL to make use of MedPay Partner Webhooks.

\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"eb8ea71a-411d-4767-89d1-5188f6519e7a"},{"name":"Create Order","id":"f0fb9eef-f15d-4401-a176-c3970c52ea52","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partner_order_id\": \"{{partner_order_id}}\",\n \"specialty\": \"dentist\",\n \"partner_name\": \"{{partner_name}}\",\n \"payment_collection\": \"medpay\",\n \"time_slot\": \"09-04-2022, 05:00 PM\",\n \"customer_details\": {\n \"name\": \"John Doe\",\n \"mobile\": \"8800880088\",\n \"gender\": \"male\",\n \"age\": 29,\n \"alternative_mobile\": \"\",\n \"email\": \"xyz@email.in\",\n \"address_details\": {\n \"address\": \"1/6, Gandhi Nagar, pune\",\n \"landmark\": \"gandhi nagar\",\n \"pin_code\": \"126102\",\n \"city\": \"pune\",\n \"state\": \"mumbai\",\n \"coordinates\": \"29.3156909,76.3212837\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/consultations/order/online/create","description":"

Use Create Order API to book an online doctor consultation appointment. MedPay will find a suitable doctor with the requested specialisation in our Connected Care Network and book an appointment.

Request Params:

Param	Description	Type	Format/Values
`partner_order_id` (required)	Partner Order id	String	Unique order ID passed by the Partner. Partner Order ID can only contain letters, numbers, underscores(_) and hyphens(-).
`partner_name` (required)	Name of the partner placing the order	String	Values shared with API access details. Partner name must be more than 3 characters long
`profile_id` (required)	unique profile id of the doctor	String	E.g `1004-8988-5954-3040`
`payment_collection` (required)	Payment collection type reference	String	self, medpay
`speciality` (required)	Doctor speciality	String	Can either be the specialty code or the specialty name as mentioned in the Specialties API. For example: `ENT` or `SP05`
`time_slot` (required)	Preferred timeslot of the patient	String	E.g. `12-05-2022, 03:00 PM`
`customer_details` (required)	Customer meta data	Map[object]
`name` (required)	Customer name	String	Maximum length: 255 char. For e.g, John Doe
`mobile` (required)	10 digits mobile number	String	E.g `880XXXXXXX`
`gender` (optional)	Customer gender	String	Male/Female/Other
`age` (optional)	Customer age	Integer	Age must be between 0 - 99
`alternative_mobile_number` (optional)	10 digits alternate mobile number	String	E.g `880XXXXXXX`
`email` (optional)	Customer valid email id	String	E.g `xyz@email.in`
`address_details` (required)	Customer address meta data	Map[object]
`address` (optional)	Customer full address	String	Minimum length: 2 char
`landmark` (optional)	Customer address landmark	String	Minimum length: 2 char
`pin_code` (optional)	Customer address pincode	String	6 digit pincode. For e.g. 560103
`city` (optional)	Customer address city	String	Minimum length: 2 char
`state` (optional)	Customer address state	String	Minimum length: 2 char
`coordinates` (required)	Comma-separated lat & long	String	e.g `29.3156909,76.3212837`

","urlObject":{"path":["partner","consultations","order","online","create"],"host":["{{host_url}}"],"query":[],"variable":[]}},"response":[{"id":"e85f63e4-53d7-4521-87d7-c90dda760a7b","name":"Success - Order created","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partner_order_id\": \"{{partner_order_id}}\",\n \"specialty\": \"dentist\",\n \"partner_name\": \"{{partner_name}}\",\n \"payment_collection\": \"medpay\",\n \"time_slot\": \"09-04-2022, 05:00 PM\",\n \"customer_details\": {\n \"name\": \"John Doe\",\n \"mobile\": \"8800880088\",\n \"gender\": \"male\",\n \"age\": 29,\n \"alternative_mobile\": \"\",\n \"email\": \"xyz@email.in\",\n \"address_details\": {\n \"address\": \"1/6, Gandhi Nagar, pune\",\n \"landmark\": \"gandhi nagar\",\n \"pin_code\": \"126102\",\n \"city\": \"pune\",\n \"state\": \"mumbai\",\n \"coordinates\": \"29.3156909,76.3212837\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/consultations/order/online/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 02 Apr 2022 06:46:30 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1084"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"aaec15f3-f39f-4cc0-be0c-8229ea73e9ee"},{"key":"x-amz-apigw-id","value":"P8KizHHLBcwFuvA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6247f144-0f67c64e2063d9d82b4618e7"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"order created successfully.\",\n \"response\": {\n \"partner_order_id\": \"02041216\",\n \"payment_collection\": \"medpay\",\n \"partner_name\": \"testpartner\",\n \"specialty\": \"dentist\",\n \"order_status\": \"pending\",\n \"booking_details\": {\n \"time_slot\": \"09-04-2022, 05:00 PM\",\n \"doctor_name\": \"\",\n \"specialties\": \"\",\n \"languages_speak\": \"English\",\n \"status\": \"pending\"\n },\n \"customer_details\": {\n \"name\": \"John Doe\",\n \"mobile\": \"8800880088\",\n \"gender\": \"male\",\n \"age\": 29,\n \"alternative_mobile\": \"\",\n \"email\": \"xyz@email.in\",\n \"address_details\": {\n \"address\": \"1/6, Gandhi Nagar, pune\",\n \"landmark\": \"gandhi nagar\",\n \"pin_code\": \"126102\",\n \"city\": \"pune\",\n \"state\": \"mumbai\"\n }\n },\n \"created_by\": \"testpartner\",\n \"created_at\": \"02/04/2022 12:16:29.907496\"\n }\n}"},{"id":"f8571bbe-1ccd-4bb0-806b-e2c9f9eb6443","name":"Error - Duplicate order ID","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partner_order_id\": \"{{partner_order_id}}\",\n \"specialty\": \"dentist\",\n \"partner_name\": \"{{partner_name}}\",\n \"payment_collection\": \"medpay\",\n \"time_slot\": \"09-04-2022, 05:00 PM\",\n \"customer_details\": {\n \"name\": \"John Doe\",\n \"mobile\": \"8800880088\",\n \"gender\": \"male\",\n \"age\": 29,\n \"alternative_mobile\": \"\",\n \"email\": \"xyz@email.in\",\n \"address_details\": {\n \"address\": \"1/6, Gandhi Nagar, pune\",\n \"landmark\": \"gandhi nagar\",\n \"pin_code\": \"126102\",\n \"city\": \"pune\",\n \"state\": \"mumbai\",\n \"coordinates\": \"29.3156909,76.3212837\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/consultations/order/online/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 02 Apr 2022 06:47:20 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"889"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"748c717d-0617-482a-9f4b-48aaa2f25297"},{"key":"x-amz-apigw-id","value":"P8KqzGXyhcwFpDg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6247f178-13a23efb26894ef635e6fa7e"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"failed\",\n \"message\": \"order with partner_order_id already exist.\",\n \"response\": {\n \"partner_order_id\": \"02041216\",\n \"specialty\": \"dentist\",\n \"partner_name\": \"testpartner\",\n \"payment_collection\": \"medpay\",\n \"time_slot\": \"09-04-2022, 05:00 PM\",\n \"customer_details\": {\n \"name\": \"John Doe\",\n \"mobile\": \"8800880088\",\n \"gender\": \"male\",\n \"age\": 29,\n \"alternative_mobile\": \"\",\n \"email\": \"xyz@email.in\",\n \"address_details\": {\n \"address\": \"1/6, Gandhi Nagar, pune\",\n \"landmark\": \"gandhi nagar\",\n \"pin_code\": \"126102\",\n \"city\": \"pune\",\n \"state\": \"mumbai\",\n \"coordinates\": \"29.3156909,76.3212837\"\n }\n },\n \"consultation_type\": \"online\"\n }\n}"},{"id":"669fe27a-c52e-4538-8d16-91afdf575607","name":"Error - Missing field","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partner_order_id\": \"02041219\",\n \"partner_name\": \"{{partner_name}}\",\n \"payment_collection\": \"medpay\",\n \"time_slot\": \"09-04-2022, 05:00 PM\",\n \"customer_details\": {\n \"name\": \"John Doe\",\n \"mobile\": \"8800880088\",\n \"gender\": \"male\",\n \"age\": 29,\n \"alternative_mobile\": \"\",\n \"email\": \"xyz@email.in\",\n \"address_details\": {\n \"address\": \"1/6, Gandhi Nagar, pune\",\n \"landmark\": \"gandhi nagar\",\n \"pin_code\": \"126102\",\n \"city\": \"pune\",\n \"state\": \"mumbai\",\n \"coordinates\": \"29.3156909,76.3212837\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/consultations/order/online/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 02 Apr 2022 06:49:04 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"134"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"08cd7775-c982-40ea-9a1e-d0c2eb2fe357"},{"key":"x-amz-apigw-id","value":"P8K7GGuShcwFgdg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6247f1e0-4849139d0b7036367cc985ce"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": {\n \"specialty\": \"'specialty' is a required property\"\n },\n \"message\": \"Input payload validation failed\"\n}"}],"_postman_id":"f0fb9eef-f15d-4401-a176-c3970c52ea52"},{"name":"Confirm Order","id":"a996d770-a296-4733-97fb-4b518c537e5c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partner_order_id\": \"{{partner_order_id}}\",\n \"partner_name\": \"{{partner_name}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/consultations/order/confirm","description":"

\n
Note: This API has to be called only if an order is in partner_pending state.
\n

Request Params:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Param	Description	Type	Format/Values
`partner_order_id` (required)	Partner Order id	String	Unique order id passed by the Partner
`partner_name` (required)	Name of the partner placing the order	String	Values shared with API access details

","urlObject":{"path":["partner","consultations","order","confirm"],"host":["{{host_url}}"],"query":[],"variable":[]}},"response":[{"id":"23040885-3719-4718-b92d-0cc696eacb2d","name":"Success - Order confirmed","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partner_order_id\": \"{{partner_order_id}}\",\n \"partner_name\": \"{{partner_name}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/consultations/order/confirm"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 02 Apr 2022 07:00:05 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"318"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"db6c8998-8d38-4a34-bf58-fe6e7a9eff6b"},{"key":"x-amz-apigw-id","value":"P8MiWFPWBcwFSfw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6247f475-1d1eedcb0126836f681fccdf"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"order updated successfully.\",\n \"response\": {\n \"partner_order_id\": \"02041220\",\n \"partner_name\": \"testpartner\",\n \"order_status\": \"accepted\",\n \"created_at\": \"02/04/2022 12:20:10.373207\",\n \"modified_at\": \"02/04/2022 12:30:05.347169\"\n }\n}"},{"id":"70bae228-5bf1-47b6-a43e-4d1e799d1d07","name":"Error - Confirmation failed","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partner_order_id\": \"{{partner_order_id}}\",\n \"partner_name\": \"{{partner_name}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/consultations/order/confirm"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 02 Apr 2022 07:00:35 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"175"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"8ed02492-3a4a-4d9a-92ae-c55cccbbf88a"},{"key":"x-amz-apigw-id","value":"P8MnBFFehcwFdBA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6247f493-2b44de7831103e336a0ac268"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"failed\",\n \"message\": \"order confirmation failed.\",\n \"response\": {\n \"partner_order_id\": \"02041216\",\n \"partner_name\": \"testpartner\"\n }\n}"}],"_postman_id":"a996d770-a296-4733-97fb-4b518c537e5c"},{"name":"Update Payment Status","id":"559783c9-0beb-4fd5-ab4d-68dc4cb28510","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partner_order_id\": \"{{partner_order_id}}\",\n \"invoice_id\":\"inv233075255517148\",\n \"partner_name\": \"{{partner_name}}\",\n \"payment_details\":{\n \"reference_id\": \"3213\",\n \"net_amount\": \"600\",\n \"payment_type\": \"card\",\n \"payment_timestamp\": \"\" ,\n \"notes\" : \"\" \n },\n \"patient_payable\": \"0\",\n \"payer_payable\": \"600\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/consultations/order/payment/confirm","description":"

Use the Update Payment Status API to provide confirmation on the payment status.

Note: Payment confirmation is required from partner before the order status can be updated\nNote: Payment can be made fully or partially, in which case, the patient has to complete the payment to update the order status. The link for patient to complete payment will be provided in the webhook notification and sent directly to the patient via WhatsApp message.

Request Params:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Param	Description	Type	Format/Values
`partner_order_id` (required)	Partner Order id	String	Unique order id passed by the Partner
`partner_name` (required)	Name of the partner placing the order	String	Values shared with API access details
`invoice_id` (required)	Unique invoice id generated by MedPay when order status changes to invoice_generated	String	E.g \"inv187258418906901\"
`payment_details` (required)	Payment meta data	Map[object]	E.g \"inv187258418906901\"
`reference_id` (required)	Unique payment reference ID generated by Partner	String	E.g \"32132323\"
`net_amount` (required)	Amount paid by the patient	String	E.g \"201.50\"
`payment_type` (required)	Payment mode type	String	card, upi, internet_banking, voucher, other
`payment_timestamp` (required)	Payment Timestamp	String
`notes` (optional)	Notes	String	To pass additional notes
`payer_payable` (required)	Amount paid by the payer	String	E.g \"201.50\"
`patient_payable` (required)	Amount paid by the patient	String	E.g \"1.50\"

","urlObject":{"path":["partner","consultations","order","payment","confirm"],"host":["{{host_url}}"],"query":[],"variable":[]}},"response":[{"id":"7a240638-e5f8-4c7c-9a0a-1df1e3a73ff0","name":"Success - Partial payment","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partner_order_id\": \"{{partner_order_id}}\",\n \"invoice_id\":\"inv212672632987734\",\n \"partner_name\": \"{{partner_name}}\",\n \"payment_details\":{\n \"reference_id\": \"3213\",\n \"net_amount\": \"600\",\n \"payment_type\": \"card\",\n \"payment_timestamp\": \"\" ,\n \"notes\" : \"\",\n \"payer_payable\": \"599\",\n \"patient_payable\": \"1\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/consultations/order/payment/confirm"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 02 Apr 2022 07:05:53 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"725"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"06c356cf-9ae5-4e3b-9f31-f64e9c35b2d7"},{"key":"x-amz-apigw-id","value":"P8NYoH0vhcwFd0A="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6247f5d0-4d12f58d53a3092d76cbe53e"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"payment confirmed successfully.\",\n \"response\": {\n \"partner_order_id\": \"02041216\",\n \"partner_name\": \"testpartner\",\n \"invoice_id\": \"inv212672632987734\",\n \"payment_status\": \"success\",\n \"payment_details\": {\n \"reference_id\": \"3213\",\n \"net_amount\": \"600\",\n \"payment_type\": \"card\",\n \"payment_timestamp\": \"\",\n \"notes\": \"\",\n \"payer_payable\": \"599\",\n \"patient_payable\": \"1\",\n \"order_amount\": \"600\"\n },\n \"order_status\": \"payment_collected\",\n \"created_at\": \"02/04/2022 12:16:29.907496\",\n \"modified_at\": \"02/04/2022 12:35:52.942203\"\n }\n}"},{"id":"e1e75708-f719-4a70-96cd-f8da1911d09e","name":"Error - Already confirmed","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partner_order_id\": \"{{partner_order_id}}\",\n \"invoice_id\":\"inv119360298294372\",\n \"partner_name\": \"{{partner_name}}\",\n \"payment_details\":{\n \"reference_id\": \"3213\",\n \"net_amount\": \"500\",\n \"payment_type\": \"card\",\n \"payment_timestamp\": \"\" ,\n \"notes\" : \"\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/consultations/order/payment/confirm"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 02 Apr 2022 08:40:06 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"115"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"4cd847ef-de9f-4846-9ede-f4504ccf324c"},{"key":"x-amz-apigw-id","value":"P8bMDHu9hcwFScw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-62480be6-5aa2d69b1d565d331fbd1d09"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"failed\",\n \"message\": \"payment cannot be confirmed or already confirmed.\",\n \"response\": {}\n}"}],"_postman_id":"559783c9-0beb-4fd5-ab4d-68dc4cb28510"},{"name":"Cancel Order","id":"f44d269e-14ad-4d21-b8eb-26e79d92b2db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"x-api-key","value":"{{API_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partner_order_id\": \"{{partner_order_id}}\",\n \"partner_name\": \"{{partner_name}}\",\n \"cancellation_code\": \"CC08\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host_url}}/partner/consultations/order/cancel","description":"

Use the Cancel Order API to cancel an existing order. An order can be cancelled upto 1 hour before the scheduled appointment time if it is in the following states:

pending
partner_pending
accepted
invoice_generated
payment_pending
payment_collected
booking_confirmed

Request Params:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Param	Description	Type	Format/Values
`partner_order_id` (required)	Partner Order ID	String	Unique order id passed by the Partner
`partner_name` (required)	Name of the partner placing the order	String	Values shared with API access details
`cancellation_code` (required)	Code for cancellation	String	Acceptable cancellation codes are tabulated below.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Cancellation Code	Cancellation Reason
CC01	Payment not done
CC08	Patient not happy with alternate provider / timings
CC09	No confirmation from patient

\n
Note: Currently, the Cancel Order API allows either a free-text cancellation reason or a cancellation code that uniquely identifies a specific cancellation reason. From 28 Febraury 2023, the cancelled_reason field will be deprecated and cancellation_code will be made mandatory.
\n

\n","urlObject":{"path":["partner","consultations","order","cancel"],"host":["{{host_url}}"],"query":[],"variable":[]}},"response":[{"id":"b1832aad-c7c8-4412-97a7-9b90ee28ad76","name":"Success - Order cancelled","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"partner_order_id\": \"{{partner_order_id}}\",\n \"partner_name\": \"{{partner_name}}\",\n \"cancellation_code\": \"CC08\"\n}","options":{"raw":{"language":"json"}}},"url":"http://orders-service-dev.eba-mpw73ras.ap-south-1.elasticbeanstalk.com/partner/consultations/order/cancel"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Wed, 08 Sep 2021 11:21:28 GMT"},{"key":"Server","value":"Apache/2.4.46 (Amazon) mod_wsgi/3.5 Python/3.6.12"},{"key":"Content-Length","value":"349"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"order cancelled successfully.\",\n \"response\": {\n \"partner_order_id\": \"cons1\",\n \"partner_name\": \"testpartner\",\n \"order_status\": \"cancelled\",\n \"cancelled_reason\": \"Patient not happy with alternate provider / timings\",\n \"cancelled_by\": \"testpartner\",\n \"cancelled_at\": \"23/02/2023 12:23:31.778307\"\n }\n}"}],"_postman_id":"f44d269e-14ad-4d21-b8eb-26e79d92b2db"}],"id":"a4ede6e2-ea20-45ea-ac87-319aa713789a","description":"

The Online Consultation APIs have been deprecated. We will be releasing Online Consultation V2 shortly.

Partner Webhooks:

\n
Note: Webhook notifications are not generated for _invoice_generated_ state in case of Online Consultations
Note: Response fields may vary, as per current order states.
\n

Webhook URL: Please share webhook_url to get timely order updates.

Method: POST

Events:
partner_pending
accepted

invoice_generated
payment_pending
payment_collected
booking_confirmed
booking_details_updated
booking_completed
prescription_uploaded

Sample webhook POST Event structure:

partner-pending:

#rescheduled\n{\n  \"partner_order_id\": \"cons1\",\n  \"partner_name\": \"uat_partner\",\n  \"order_status\": \"partner_pending\",\n  \"booking_details\": {\n    \"name\": \"Pradeep Sharma\",\n    \"specialties\": [\n      \"dentist\"\n    ],\n    \"time_slot\": \"29-08-2022, 6:00 PM\",\n    \"change_type\": \"rescheduled\",\n    \"requested_booking_details\": {\n      \"name\": \"Pradeep Sharma\",\n      \"specialties\": [\n        \"dentist\"\n      ],\n      \"time_slot\": \"29-08-2022, 05:00 PM\"\n    }\n  },\n  \"timestamp\": \"20/08/2022 13:58:33.614816\"\n}\n#reassigned\n{\n  \"partner_order_id\": \"cons1\",\n  \"partner_name\": \"uat_partner\",\n  \"order_status\": \"partner_pending\",\n  \"booking_details\": {\n    \"name\": \"Rajalakshmi S\",\n    \"specialties\": [\n      \"dentist\"\n    ],\n    \"time_slot\": \"29-08-2022, 5:00 PM\",\n    \"change_type\": \"reassigned\",\n    \"requested_booking_details\": {\n      \"name\": \"Cosmodentz Gupta Dental Hospital\",\n      \"specialties\": [\n        \"dentist\"\n      ],\n      \"time_slot\": \"29-08-2022, 05:00 PM\"\n    }\n  },\n  \"timestamp\": \"20/08/2022 14:11:49.293285\"\n}\n#reassigned and rescheduled\n{\n  \"partner_order_id\": \"cons1\",\n  \"partner_name\": \"uat_partner\",\n  \"order_status\": \"partner_pending\",\n  \"booking_details\": {\n    \"name\": \"Praveen Jain\",\n    \"specialties\": [\n      \"dentist\"\n    ],\n    \"time_slot\": \"29-08-2022, 6:00 PM\",\n    \"change_type\": \"rescheduled_and_reassigned\",\n    \"requested_booking_details\": {\n      \"name\": \"Cosmodentz Gupta Dental\",\n      \"specialties\": [\n        \"dentist\"\n      ],\n      \"time_slot\": \"29-08-2022, 05:00 PM\"\n    }\n  },\n  \"timestamp\": \"20/08/2022 14:05:54.762606\"\n}\n\n

order-accepted:

{\n  \"partner_order_id\": \"cons1\",\n  \"partner_name\": \"uat_partner\",\n  \"order_status\": \"accepted\",\n  \"timestamp\": \"06/06/2022 18:20:11.068554\"\n}\n\n

invoice-generated

{\n  \"partner_order_id\": \"cons1\",\n  \"partner_name\": \"uat_partner\",\n  \"order_status\": \"invoice_generated\",\n  \"invoice_details\": {\n    \"partner_discount\": \"200.0\",\n    \"tgst\": \"0.0\",\n    \"bill_amount\": \"800.0\",\n    \"invoice_no\": \"\",\n    \"payment_status\": \"pending\",\n    \"invoice_id\": \"inv296495547045439\",\n    \"payment_collection\": \"medpay\",\n    \"net_amount\": \"600.0\",\n    \"invoice_link\": \"https://mdpy.in/p7phmThMc8\"\n  },\n  \"timestamp\": \"20/08/2022 13:51:48.214399\"\n}\n\n

payment-pending:

{\n  \"partner_order_id\": \"appointment1\",\n  \"partner_name\": \"uat_partner\",\n  \"order_status\": \"payment_pending\",\n  \"payment_details\": {\n    \"payment_type\": \"card\",\n    \"delivery_partner\": \"medpay\",\n    \"order_amount\": \"500\",\n    \"payer_payable\": \"400\",\n    \"patient_payable\": \"100\"\n  },\n  \"timestamp\": \"17/01/2022 13:19:18.439609\"\n}\n\n

payment-collected:

{\n  \"partner_order_id\": \"cons1\",\n  \"partner_name\": \"uat_partner\",\n  \"order_status\": \"payment_collected\",\n  \"payment_details\": {\n    \"payment_timestamp\": \"\",\n    \"payment_type\": \"card\",\n    \"net_amount\": \"600\",\n    \"notes\": \"\",\n    \"reference_id\": \"3213\",\n    \"order_amount\": \"600\"\n  },\n  \"timestamp\": \"06/06/2022 18:26:09.935394\"\n}\n\n

booking_confirmed:

{\n  \"partner_order_id\": \"cons1\",\n  \"partner_name\": \"uat_partner\",\n  \"order_status\": \"booking_confirmed\",\n  \"booking_details\": {\n    \"name\": \"Asha Jain\",\n    \"specialties\": [],\n    \"time_slot\": \"09-06-2022, 7:00 PM\",\n    \"gender\": \"female\",\n    \"experience_in_years\": \"\",\n    \"degrees\": [],\n    \"languages_speak\": \"English\",\n    \"connect_link\": \"https://mdpy.in/HYPSRPNKHF\",\n    \"invoice_details\": {\n      \"partner_discount\": \"200.0\",\n      \"tgst\": \"0\",\n      \"bill_amount\": \"800.0\",\n      \"invoice_no\": \"\",\n      \"payment_status\": \"success\",\n      \"invoice_id\": \"inv233075255517148\",\n      \"payment_collection\": \"medpay\",\n      \"net_amount\": \"600.0\",\n      \"invoice_link\": \"https://mdpy.in/ZheWBHHqxg\"\n    }\n  }\n}\n\n

booking_completed:

{\n  \"partner_order_id\": \"cons1\",\n  \"partner_name\": \"uat_partner\",\n  \"order_status\": \"booking_completed\",\n  \"timestamp\": \"06/06/2022 18:39:02.534093\",\n  \"booking_details\": {\n    \"customer_name\": \"John Doe\",\n    \"name\": \"Asha Jain\",\n    \"specialties\": [],\n    \"time_slot\": \"09-06-2022, 7:00 PM\",\n    \"connect_link\": \"https://mdpy.in/HYPSRPNKHF\"\n  }\n}\n\n

prescription-uploaded:

{\n  \"partner_order_id\": \"cons1\",\n  \"partner_name\": \"uat_partner\",\n  \"order_status\": \"prescription_uploaded\",\n  \"timestamp\": \"06/06/2022 18:39:46.618844\",\n  \"rx_details\": {\n    \"links\": [\n      \"https://dev-orders-rx.s3.ap-southeast-1.amazonaws.com/practo_prescription_2_1654520983.pdf\"\n    ]\n  }\n}\n\n

order-cancelled:

{\n  \"partner_order_id\": \"cons1\",\n  \"partner_name\": \"uat_partner\",\n  \"order_status\": \"cancelled\",\n  \"cancelled_reason\": \"No confirmation from patient\",\n  \"timestamp\": \"06/06/2022 18:47:45.545261\"\n}\n\n

","_postman_id":"a4ede6e2-ea20-45ea-ac87-319aa713789a"}],"id":"3e9a0986-f6ec-450f-ba23-7b1fb1208c34","description":"

We have currently deprecated this module in order to rebuild the APIs required to ensure a smooth flow and enhance the overall patient experience.

Developers can use Doctor Consultation APIs to build powerful apps for booking and managing offline/online consultations with doctors in specialised fields of medicine.

\n","_postman_id":"3e9a0986-f6ec-450f-ba23-7b1fb1208c34"}],"event":[{"listen":"prerequest","script":{"id":"cd2fefb1-7322-459a-b1a9-3f8ab6e4d47e","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"90630e9a-f7ef-4e15-bde3-2fe0b91ea6ae","type":"text/javascript","exec":[""]}}]}