{ "info": { "_postman_id": "24d87ad4-66f4-4218-8f54-fb6deb1f3f6b", "name": "NexHealth Adjustment Types Payment Types API", "description": "v3.0.0 and v20240412 are two names for the same API version; the Nex-Api-Version header accepts either value. Welcome to the developer hub and documentation for NexHealth API. This section of guide describes the operations, response parameters, request parameters, and parameter constraints related to User API. The term Operations refer to functions or methods. The operations are included in requests and send to the web server. Each operation performs a different action or a query on database.\n\nContact Support:\n Name: NexHealth\n Email: info@nexhealth.com", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T02:20:30.000Z", "updatedAt": "2026-07-28T02:20:31.000Z", "lastUpdatedBy": "35240", "uid": "35240-24d87ad4-66f4-4218-8f54-fb6deb1f3f6b" }, "item": [ { "name": "payment_types", "item": [ { "name": "{id}", "item": [ { "name": "View payment type", "id": "20231772-9b73-4d13-bea6-bb1604ffcf15", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) The NexHealth API version", "key": "Nex-Api-Version", "value": "v3.0.0" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/payment_types/:id?subdomain=", "host": [ "{{baseUrl}}" ], "path": [ "payment_types", ":id" ], "query": [ { "description": "(Required) Used to scope the request to the specified institution", "key": "subdomain", "value": "" } ], "variable": [ { "id": "e9a66507-3dfb-48d4-9ecd-69677cb8341a", "key": "id", "value": "", "description": "(Required) " } ] }, "description": "This endpoint returns a single payment type" }, "response": [ { "id": "f53ed77f-1016-4d8c-96c6-8574b6513373", "name": "Successful", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The NexHealth API version", "key": "Nex-Api-Version", "value": "v3.0.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/payment_types/:id?subdomain=", "host": [ "{{baseUrl}}" ], "path": [ "payment_types", ":id" ], "query": [ { "description": "(Required) Used to scope the request to the specified institution", "key": "subdomain", "value": "" } ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"description\": \"\",\n \"error\": [\n \"\",\n \"\"\n ],\n \"data\": {\n \"id\": \"\",\n \"name\": \"\",\n \"active\": \"\",\n \"updated_at\": \"\"\n },\n \"count\": \"\"\n}", "createdAt": "2026-07-28T02:20:31.000Z", "updatedAt": "2026-07-28T02:20:31.000Z", "uid": "35240-f53ed77f-1016-4d8c-96c6-8574b6513373" }, { "id": "744757c9-3857-4ae1-8a3e-f75de59d0afc", "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The NexHealth API version", "key": "Nex-Api-Version", "value": "v3.0.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/payment_types/:id?subdomain=", "host": [ "{{baseUrl}}" ], "path": [ "payment_types", ":id" ], "query": [ { "description": "(Required) Used to scope the request to the specified institution", "key": "subdomain", "value": "" } ], "variable": [ { "key": "id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"description\": \"\",\n \"data\": {},\n \"error\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T02:20:31.000Z", "updatedAt": "2026-07-28T02:20:31.000Z", "uid": "35240-744757c9-3857-4ae1-8a3e-f75de59d0afc" }, { "id": "8e5d3a0f-67a7-4a78-aa67-410f177b8467", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The NexHealth API version", "key": "Nex-Api-Version", "value": "v3.0.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/payment_types/:id?subdomain=", "host": [ "{{baseUrl}}" ], "path": [ "payment_types", ":id" ], "query": [ { "description": "(Required) Used to scope the request to the specified institution", "key": "subdomain", "value": "" } ], "variable": [ { "key": "id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"description\": \"\",\n \"data\": {},\n \"error\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T02:20:31.000Z", "updatedAt": "2026-07-28T02:20:31.000Z", "uid": "35240-8e5d3a0f-67a7-4a78-aa67-410f177b8467" }, { "id": "f4a2a199-4955-4813-a664-4a2a63caa5de", "name": "Forbidden", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The NexHealth API version", "key": "Nex-Api-Version", "value": "v3.0.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/payment_types/:id?subdomain=", "host": [ "{{baseUrl}}" ], "path": [ "payment_types", ":id" ], "query": [ { "description": "(Required) Used to scope the request to the specified institution", "key": "subdomain", "value": "" } ], "variable": [ { "key": "id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"description\": \"\",\n \"data\": {},\n \"error\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T02:20:31.000Z", "updatedAt": "2026-07-28T02:20:31.000Z", "uid": "35240-f4a2a199-4955-4813-a664-4a2a63caa5de" }, { "id": "064e776f-d6b5-4058-90d9-504ec2992333", "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The NexHealth API version", "key": "Nex-Api-Version", "value": "v3.0.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/payment_types/:id?subdomain=", "host": [ "{{baseUrl}}" ], "path": [ "payment_types", ":id" ], "query": [ { "description": "(Required) Used to scope the request to the specified institution", "key": "subdomain", "value": "" } ], "variable": [ { "key": "id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"description\": \"\",\n \"data\": {},\n \"error\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T02:20:31.000Z", "updatedAt": "2026-07-28T02:20:31.000Z", "uid": "35240-064e776f-d6b5-4058-90d9-504ec2992333" } ], "createdAt": "2026-07-28T02:20:31.000Z", "updatedAt": "2026-07-28T02:20:31.000Z", "uid": "35240-20231772-9b73-4d13-bea6-bb1604ffcf15" } ], "id": "eef7d110-56a8-40a9-a67d-7d1cc6620f65", "createdAt": "2026-07-28T02:20:31.000Z", "updatedAt": "2026-07-28T02:20:31.000Z", "uid": "35240-eef7d110-56a8-40a9-a67d-7d1cc6620f65" }, { "name": "View payment types", "id": "f4551121-cc03-4cfb-a84a-e8238d40d092", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) The NexHealth API version", "key": "Nex-Api-Version", "value": "v3.0.0" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/payment_types?subdomain=&location_id=&updated_since=&active=true&start_cursor=&end_cursor=&per_page=5", "host": [ "{{baseUrl}}" ], "path": [ "payment_types" ], "query": [ { "description": "(Required) Used to scope the request to the specified institution", "key": "subdomain", "value": "" }, { "description": "(Required) Used to scope the request to the specified location", "key": "location_id", "value": "" }, { "description": "Payment types updated after the specified time (UTC)", "key": "updated_since", "value": "" }, { "description": "Filter active/not active", "key": "active", "value": "true" }, { "description": "First item of the current page. Starts empty", "key": "start_cursor", "value": "" }, { "description": "Last item of the current page. Starts empty", "key": "end_cursor", "value": "" }, { "description": "Number of results to return per page. Maximum allowed amount is 1000.", "key": "per_page", "value": "5" } ] }, "description": "This endpoint returns the payment types configured in the integrated system for the specified location" }, "response": [ { "id": "a935f5a5-5930-4c2c-9009-019fe6372573", "name": "Successful", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The NexHealth API version", "key": "Nex-Api-Version", "value": "v3.0.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/payment_types?subdomain=&location_id=&updated_since=&active=true&start_cursor=&end_cursor=&per_page=5", "host": [ "{{baseUrl}}" ], "path": [ "payment_types" ], "query": [ { "description": "(Required) Used to scope the request to the specified institution", "key": "subdomain", "value": "" }, { "description": "(Required) Used to scope the request to the specified location", "key": "location_id", "value": "" }, { "description": "Payment types updated after the specified time (UTC)", "key": "updated_since", "value": "" }, { "description": "Filter active/not active", "key": "active", "value": "true" }, { "description": "First item of the current page. Starts empty", "key": "start_cursor", "value": "" }, { "description": "Last item of the current page. Starts empty", "key": "end_cursor", "value": "" }, { "description": "Number of results to return per page. Maximum allowed amount is 1000.", "key": "per_page", "value": "5" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"description\": \"\",\n \"error\": [\n \"\",\n \"\"\n ],\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"active\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"active\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"page_info\": {}\n}", "createdAt": "2026-07-28T02:20:31.000Z", "updatedAt": "2026-07-28T02:20:31.000Z", "uid": "35240-a935f5a5-5930-4c2c-9009-019fe6372573" }, { "id": "61f39824-8732-4583-a97e-4d2e7491caa8", "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The NexHealth API version", "key": "Nex-Api-Version", "value": "v3.0.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/payment_types?subdomain=&location_id=&updated_since=&active=true&start_cursor=&end_cursor=&per_page=5", "host": [ "{{baseUrl}}" ], "path": [ "payment_types" ], "query": [ { "description": "(Required) Used to scope the request to the specified institution", "key": "subdomain", "value": "" }, { "description": "(Required) Used to scope the request to the specified location", "key": "location_id", "value": "" }, { "description": "Payment types updated after the specified time (UTC)", "key": "updated_since", "value": "" }, { "description": "Filter active/not active", "key": "active", "value": "true" }, { "description": "First item of the current page. Starts empty", "key": "start_cursor", "value": "" }, { "description": "Last item of the current page. Starts empty", "key": "end_cursor", "value": "" }, { "description": "Number of results to return per page. Maximum allowed amount is 1000.", "key": "per_page", "value": "5" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"description\": \"\",\n \"data\": {},\n \"error\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T02:20:31.000Z", "updatedAt": "2026-07-28T02:20:31.000Z", "uid": "35240-61f39824-8732-4583-a97e-4d2e7491caa8" }, { "id": "e47ce0a2-c82f-451a-8f52-5ac74f9c7e05", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The NexHealth API version", "key": "Nex-Api-Version", "value": "v3.0.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/payment_types?subdomain=&location_id=&updated_since=&active=true&start_cursor=&end_cursor=&per_page=5", "host": [ "{{baseUrl}}" ], "path": [ "payment_types" ], "query": [ { "description": "(Required) Used to scope the request to the specified institution", "key": "subdomain", "value": "" }, { "description": "(Required) Used to scope the request to the specified location", "key": "location_id", "value": "" }, { "description": "Payment types updated after the specified time (UTC)", "key": "updated_since", "value": "" }, { "description": "Filter active/not active", "key": "active", "value": "true" }, { "description": "First item of the current page. Starts empty", "key": "start_cursor", "value": "" }, { "description": "Last item of the current page. Starts empty", "key": "end_cursor", "value": "" }, { "description": "Number of results to return per page. Maximum allowed amount is 1000.", "key": "per_page", "value": "5" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"description\": \"\",\n \"data\": {},\n \"error\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T02:20:31.000Z", "updatedAt": "2026-07-28T02:20:31.000Z", "uid": "35240-e47ce0a2-c82f-451a-8f52-5ac74f9c7e05" }, { "id": "2b1dff09-e63b-401a-9ed3-2b97b3fa2c90", "name": "Forbidden", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The NexHealth API version", "key": "Nex-Api-Version", "value": "v3.0.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/payment_types?subdomain=&location_id=&updated_since=&active=true&start_cursor=&end_cursor=&per_page=5", "host": [ "{{baseUrl}}" ], "path": [ "payment_types" ], "query": [ { "description": "(Required) Used to scope the request to the specified institution", "key": "subdomain", "value": "" }, { "description": "(Required) Used to scope the request to the specified location", "key": "location_id", "value": "" }, { "description": "Payment types updated after the specified time (UTC)", "key": "updated_since", "value": "" }, { "description": "Filter active/not active", "key": "active", "value": "true" }, { "description": "First item of the current page. Starts empty", "key": "start_cursor", "value": "" }, { "description": "Last item of the current page. Starts empty", "key": "end_cursor", "value": "" }, { "description": "Number of results to return per page. Maximum allowed amount is 1000.", "key": "per_page", "value": "5" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"description\": \"\",\n \"data\": {},\n \"error\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T02:20:31.000Z", "updatedAt": "2026-07-28T02:20:31.000Z", "uid": "35240-2b1dff09-e63b-401a-9ed3-2b97b3fa2c90" }, { "id": "8fc4776e-791b-4ef3-ab44-6c91b6e5c4e9", "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) The NexHealth API version", "key": "Nex-Api-Version", "value": "v3.0.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/payment_types?subdomain=&location_id=&updated_since=&active=true&start_cursor=&end_cursor=&per_page=5", "host": [ "{{baseUrl}}" ], "path": [ "payment_types" ], "query": [ { "description": "(Required) Used to scope the request to the specified institution", "key": "subdomain", "value": "" }, { "description": "(Required) Used to scope the request to the specified location", "key": "location_id", "value": "" }, { "description": "Payment types updated after the specified time (UTC)", "key": "updated_since", "value": "" }, { "description": "Filter active/not active", "key": "active", "value": "true" }, { "description": "First item of the current page. Starts empty", "key": "start_cursor", "value": "" }, { "description": "Last item of the current page. Starts empty", "key": "end_cursor", "value": "" }, { "description": "Number of results to return per page. Maximum allowed amount is 1000.", "key": "per_page", "value": "5" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"description\": \"\",\n \"data\": {},\n \"error\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T02:20:31.000Z", "updatedAt": "2026-07-28T02:20:31.000Z", "uid": "35240-8fc4776e-791b-4ef3-ab44-6c91b6e5c4e9" } ], "createdAt": "2026-07-28T02:20:31.000Z", "updatedAt": "2026-07-28T02:20:31.000Z", "uid": "35240-f4551121-cc03-4cfb-a84a-e8238d40d092" } ], "id": "99c64d22-ebfa-4c57-90e8-1d9a12a0449d", "createdAt": "2026-07-28T02:20:31.000Z", "updatedAt": "2026-07-28T02:20:31.000Z", "uid": "35240-99c64d22-ebfa-4c57-90e8-1d9a12a0449d" } ], "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://nexhealth.info" } ] }