{"info":{"_postman_id":"d383c8ac-a17e-49e5-af11-efc14dde9414","name":"OpenPath SaaS API","description":"

Server Resources

A server resource is a collection of available functions and objects associated with your organization. If authenticated your application can make calls to these resources over SSL. Each server resource is contained within the result of an OpenPath envelope as described in the next section.

HTTP Verbs and CRUD

The HTTP Verbs are how the HTTP requests are made (e.g. POST, GET, PATCH, PUT and DELETE). These verbs determine how you interact with the resource. The follow is the list of HTTP Verbs OpenPath uses and how they function.

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

HTTP Verb	CRUD Operation	Explanation
POST	Create	Creates a new item.
GET	Read	Reads an item.
PATCH	Update	Updates parts of an item.
DELETE	Delete	Deletes an item.
PUT	Replaces	Replaces an item using the same ID.

HTTPS Response Codes

The SaaS API will return a standard HTTP response code along with the status code wrapped in the JSON envelope for any request made to the system. The following is a list of the response codes the API may generate.

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

Code	Message	Description
200	Ok	Request executed successfully.
201	Created	When an item was successfully created, updated or replaced and the created item URI will be returned in the header.
400	Bad Request	The request could not be understood by the server due to malformed syntax.
401	Unauthorize	The request requires user authentication. The response must include a Authenticate header field with an OpenApth API Key.
404	Not Found	The server has not found anything matching the Request-URI.
500	Internal Server Error	The server encountered an unexpected condition which prevented it from fulfilling the request.

Envelopes

Envelopes return a standardize response from all server resources and inside the result of the envelope is the actual data from the server resource. Each envelope contains information about the returned data record counts, the application, the endpoint, the http status and any errors they may have occurred.

Depending on the requested content type an envelope will return either a JSON or XML output in the body of the response. Regardless of any errors the server resource will alway return and envelope. If the request was successful, then within the result section of the envelope will be the serialized data of the request.

The envelope also has standard actions which work with all resources, which can help limit the amount of requested data by using pages and page sizes.

Response

{\n    \"organization\": \"OpenPath, Incorporated\",\n    \"web_site\": \"https://openpath.io\",\n    \"phone_number\": \"+1 (844) PATH-24/7\",\n    \"email\": \"support@openpath.io\",\n    \"application\": \"OpenPath SaaS API\",\n    \"version\": \"3.xx.xxxx\",\n    \"copyright\": \"Copyright ©2018 OpenPath, Inc.\",\n    \"name\": \"Example-Envelope\",\n    \"description\": \"This is an example envelope response from the OpenPath SaaS API. Unauthorized access is strictly prohibited.\",\n    \"result\": [\n        {\n            \"id\": 1,\n            \"name\": \"Teapot\",\n            \"description\": \"I'm a teapot\"\n        },\n        {\n            \"id\": 2,\n            \"name\": \"Spout\",\n            \"description\": \"I'm a spout\"\n        },\n        {\n            \"id\": 3,\n            \"name\": \"Short\",\n            \"description\": \"I'm short\"\n        },\n        {\n            \"id\": 4,\n            \"name\": \"Stout\",\n            \"description\": \"I'm stout\"\n        }\n    ],\n    \"paging\": {\n        \"count\": 4,\n        \"page\": 1,\n        \"size\": 4\n    },\n    \"filter\": {\n        \"search\": [\n            {\n                \"key\": \"id\",\n                \"method\": \"IsGreaterThan\",\n                \"value\": \"5\"\n            },\n            {\n                \"key\": \"description\",\n                \"method\": \"Contains\",\n                \"value\": \"I'm\"\n            }\n        ],\n        \"sort_by\": \"id\",\n        \"sort_ascending\": true\n    },\n    \"status\": 200,\n    \"status_message\": \"Ok\",\n    \"errors\": [\n        {\n            \"source\": \"Validation\",\n            \"message\": \"ID must be less than or equal to 100\"\n        },\n        {\n            \"source\": \"Database\",\n            \"message\": \"The database is currently unavailable\"\n        }\n    ]\n}\n

Envelope Item

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

Key	Description
Organization	This is the organization that owns the API.
Web Site	The URL of the owner of the API.
Phone Number	The phone number of the owner of the API.
Email	The email adddress of the owner of the API.
Application	This is the name of the API Resource available.
Version	This is the current version of the API. The format is [Version].[Feature].[Build].
Copyright	This is the copyright date and information for the API Resource.
Name	This is the name of the end-point.
Description	A description of what this end-point is and does.
Result	The result data from the end-point which can be a single object or an array.
Paging	[See Paging Item](#Paging Item).
Filter	[See Filter Item](#Filter Item).
Status	The HTTP response status code.
Status Message	The HTTP response status code text.
Errors	An array of Error Items [See Error Item](#Error Item).

Paging Item

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

Key	Description
Count	The total number of items.
Page	The page number of the returned items.
Size	The number or items returned per page.

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

Key	Description
Search	An array of Search Items [See Search Item](#Search Item).
Sort By	The key the items are sorted on.
Sort Assending	Which direction to sort the sort by key.

Search Item

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

Key	Description
Key	Which key to apply this search filter too.
Method	The search method applied to the key and value searching for.
Value	The value of they key to apply the search method too.

Search Item Methods

Equals
DoesNotEqual
IsGreaterThan
IsGreaterThanOrEqual
IsLessThan
IsLessThanOrEqual
StartsWith
EndsWith
Contains
MatchesRegex
DoesNotMatchRegex

Error Item

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

Key	Description
Source	Where the error was generated.
Message	What the error message is about.

","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Server Resources","slug":"server-resources"},{"content":"HTTP Verbs and CRUD","slug":"http-verbs-and-crud"},{"content":"HTTPS Response Codes","slug":"https-response-codes"},{"content":"Envelopes","slug":"envelopes"},{"content":"Response","slug":"response"},{"content":"Envelope Item","slug":"envelope-item"},{"content":"Paging Item","slug":"paging-item"},{"content":"Filter Item","slug":"filter-item"},{"content":"Search Item","slug":"search-item"},{"content":"Error Item","slug":"error-item"}],"owner":"609744","collectionId":"d383c8ac-a17e-49e5-af11-efc14dde9414","publishedId":"RW1eky1F","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"3F51B5"},"publishDate":"2018-05-22T22:28:33.000Z"},"item":[{"name":"API Root","item":[{"name":"V3","item":[{"name":"System","event":[{"listen":"test","script":{"id":"eb6e83ff-4e6f-40c8-8350-71ad59d4b63c","type":"text/javascript","exec":["tests['System'] = responseBody.has('\"status\":\"Healthy\"');","tests[responseBody] = true;"]}}],"id":"e2a0f88e-5d10-4458-af4a-350c92cc91a2","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/v3","description":"

Description

At the root of each version, the system will return a result of the current system the API request is coming from. Since the system is redundant and has systems all over the globe you may receive responses from different system.

\n
NOTE No authorization is required for this endpoint.
\n

\n
NOTE During deployments and updates you may see different version numbers returned from the Envlope item, since deployments and updates are not done all at once to ensure the system stays up.
\n

System Item

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

Key	Description
Environment	The current environment of the system (Production/Staging/Development).
Name	The name of the system.
Database	The current environment of the database (Production/Staging/Development).
Time	The current UTC time of the system.
Status	The current status of the system accessed. (Healthly/Degraded/Failed)

","urlObject":{"path":["v3"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"9fa1d440-9328-4823-92f1-454d9ccb25c5","name":"System","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"http://localhost:55875/v3"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Thu, 17 May 2018 21:03:16 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Kestrel","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcVXNlcnNcSmFzb24gTWFydGluXHNvdXJjZVxyZXBvc1xvcGVuLnBhdGhcQXBpXEFwaS5BcHBsaWNhdGlvblx2Mw==?=","name":"X-SourceFiles","description":"Custom header"}],"cookie":[],"responseTime":null,"body":"{\n \"name\": \"System\",\n \"description\": \"The root of Version 3 returns the details of the system handling the request. Unauthorized access is strictly prohibited.\",\n \"result\": {\n \"environment\": \"Staging\",\n \"name\": \"DESKTOP-LABDI8E\",\n \"database\": \"Staging\",\n \"time\": \"2018-05-17T21:03:16.3687081Z\",\n \"status\": \"Healthy\"\n }\n}"}],"_postman_id":"e2a0f88e-5d10-4458-af4a-350c92cc91a2"},{"name":"Example Envelope","event":[{"listen":"test","script":{"id":"32607885-0e57-48f1-b068-aa323c7ade4a","type":"text/javascript","exec":["tests['Example-Endpoint'] = responseBody.has('{\"id\":1,\"name\":\"Teapot\",\"description\":\"I\\'m a teapot\"}');","tests[responseBody] = true;"]}}],"id":"2a531d5f-01c0-414c-8361-0780084355b4","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/v3/example","description":"

Description

The example envelope does not pull real data and can be used to get an example template of how the JSON envelope looks.

\n
NOTE No authorization is required for this endpoint.
\n

\n","urlObject":{"path":["v3","example"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"52b5bdda-650f-4b51-985d-8d58a75d9c49","name":"Example Envelope","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"http://localhost:55875/v3/example"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Thu, 17 May 2018 21:04:58 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Kestrel","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcVXNlcnNcSmFzb24gTWFydGluXHNvdXJjZVxyZXBvc1xvcGVuLnBhdGhcQXBpXEFwaS5BcHBsaWNhdGlvblx2M1xleGFtcGxl?=","name":"X-SourceFiles","description":"Custom header"}],"cookie":[],"responseTime":null,"body":"{\"organization\":\"OpenPath, Incorporated\",\"web_site\":\"https://openpath.io\",\"phone_number\":\"+1 (844) PATH-24/7\",\"email\":\"support@openpath.io\",\"application\":\"OpenPath SaaS API\",\"version\":\"3.4.509\",\"copyright\":\"Copyright ©2018 OpenPath, Inc.\",\"name\":\"Example-Envelope\",\"description\":\"This is an example envelope response from the OpenPath SaaS API. Unauthorized access is strictly prohibited.\",\"result\":[{\"id\":1,\"name\":\"Teapot\",\"description\":\"I'm a teapot\"},{\"id\":2,\"name\":\"Spout\",\"description\":\"I'm a spout\"},{\"id\":3,\"name\":\"Short\",\"description\":\"I'm short\"},{\"id\":4,\"name\":\"Stout\",\"description\":\"I'm stout\"}],\"paging\":{\"count\":4,\"page\":1,\"size\":4},\"filter\":{\"search\":[{\"key\":\"id\",\"method\":\"IsGreaterThan\",\"value\":\"5\"},{\"key\":\"description\",\"method\":\"Contains\",\"value\":\"I'm\"}],\"sort_by\":\"id\",\"sort_ascending\":true},\"status\":200,\"status_message\":\"Ok\",\"errors\":[{\"source\":\"Validation\",\"message\":\"ID must be less than or equal to 100\"},{\"source\":\"Database\",\"message\":\"The database is currently unavailable\"}]}"}],"_postman_id":"2a531d5f-01c0-414c-8361-0780084355b4"}],"id":"e14a46b3-d911-486b-97be-aea7799a8b75","description":"

This is the Version 3.xxx.xxxx of the OpenPath SaaS API. Version 1 and 2 have been depreciated and Version 3 is the current stable version. All endpoint calls should begin with https://api-saas.openpath.io/v3.

\n
VERSION 3 URL https://api-saas.openpath.io/v3
\n

\n","event":[{"listen":"prerequest","script":{"id":"6efe836a-6c4c-4a61-9bb5-c58fa9cbde79","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c7331ed7-c288-485f-bbfd-1fd016a9ace2","type":"text/javascript","exec":[""]}}],"_postman_id":"e14a46b3-d911-486b-97be-aea7799a8b75"},{"name":"Unknown Endpoint","event":[{"listen":"test","script":{"id":"a631d1c0-059d-42df-996a-f469de58f1b2","type":"text/javascript","exec":["tests['Unknown-Endpoint'] = responseBody.has('\"errors\":[{\"source\":\"API Request\",\"message\":\"API Endpoint not found.\"}]');","tests[responseBody] = true;"]}}],"id":"a437b957-bb3b-494d-844c-b4d4100c8eb6","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}","description":"

Unknown Endpoint

When you try to access an end point that does not exist within the API you will receive a 404 HTTP response code and an JSON envelope containing that error.

\n
NOTE You do not need to be authenticated to receive an Unknown Endpoint\nerror.
\n

\n","urlObject":{"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"11f2658d-4cf9-46b1-a791-93a22e459b4c","name":"Unknown Endpoint","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"http://localhost:55875"},"status":"Not Found","code":404,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Thu, 17 May 2018 21:19:25 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Kestrel","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcVXNlcnNcSmFzb24gTWFydGluXHNvdXJjZVxyZXBvc1xvcGVuLnBhdGhcQXBpXEFwaS5BcHBsaWNhdGlvbg==?=","name":"X-SourceFiles","description":"Custom header"}],"cookie":[],"responseTime":null,"body":"{\"organization\":\"OpenPath, Incorporated\",\"web_site\":\"https://openpath.io\",\"phone_number\":\"+1 (844) PATH-24/7\",\"email\":\"support@openpath.io\",\"application\":\"OpenPath SaaS API\",\"version\":\"n/a\",\"copyright\":\"Copyright ©2018 OpenPath, Inc.\",\"name\":\"Unknown-Endpoint\",\"description\":\"This is unknown endpoint in the application programming interface for the OpenPath SaaS API. Unauthorized access is strictly prohibited.\",\"result\":null,\"paging\":null,\"filter\":null,\"status\":404,\"status_message\":\"Not Found\",\"errors\":[{\"source\":\"API Request\",\"message\":\"API Endpoint not found.\"}]}"},{"id":"add75868-88df-4e5e-a1af-fc718918969f","name":"Unknown Endpoint","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"http://localhost:55875"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 17 May 2018 16:28:22 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Kestrel","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcVXNlcnNcSmFzb24gTWFydGluXHNvdXJjZVxyZXBvc1xvcGVuLnBhdGhcQXBpXEFwaS5BcHBsaWNhdGlvbg==?=","name":"X-SourceFiles","description":"Custom header"}],"cookie":[],"responseTime":null,"body":"{\"organization\":\"OpenPath, Incorporated\",\"web_site\":\"https://openpath.io\",\"phone_number\":\"+1 (844) PATH-24/7\",\"email\":\"support@openpath.io\",\"application\":\"OpenPath SaaS API\",\"version\":\"n/a\",\"copyright\":\"Copyright ©2018 OpenPath, Inc.\",\"name\":\"Unknown-Endpoint\",\"description\":\"This is unknown endpoint in the application programming interface for the OpenPath SaaS API. Unauthorized access is strictly prohibited.\",\"result\":null,\"paging\":null,\"filter\":null,\"status\":404,\"status_message\":\"Not Found\",\"errors\":[{\"source\":\"API Request\",\"message\":\"API Endpoint not found.\"}]}"}],"_postman_id":"a437b957-bb3b-494d-844c-b4d4100c8eb6"},{"name":"Unknown Endpoint","event":[{"listen":"test","script":{"id":"df1221b8-84bb-40be-ba97-f0396f90b32d","type":"text/javascript","exec":["tests['Unknown-Endpoint'] = responseBody.has('\"errors\":[{\"source\":\"API Request\",\"message\":\"API Endpoint not found.\"}]');","tests[responseBody] = true;"]}}],"id":"8058c8ae-7f4b-4277-92de-6759d89891e0","request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}","description":"

Unknown Endpoint

When you try to access an end point that does not exist within the API you will receive a 404 HTTP response code and an JSON envelope containing that error.

\n
NOTE You do not need to be authenticated to receive an Unknown Endpoint\nerror.
\n

\n","urlObject":{"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"4ff7d8d8-5cf2-4ae4-8277-3a37e380a414","name":"Unknown Endpoint","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":"http://localhost:55875"},"status":"Not Found","code":404,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Thu, 17 May 2018 21:19:44 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Kestrel","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcVXNlcnNcSmFzb24gTWFydGluXHNvdXJjZVxyZXBvc1xvcGVuLnBhdGhcQXBpXEFwaS5BcHBsaWNhdGlvbg==?=","name":"X-SourceFiles","description":"Custom header"}],"cookie":[],"responseTime":null,"body":"{\"organization\":\"OpenPath, Incorporated\",\"web_site\":\"https://openpath.io\",\"phone_number\":\"+1 (844) PATH-24/7\",\"email\":\"support@openpath.io\",\"application\":\"OpenPath SaaS API\",\"version\":\"n/a\",\"copyright\":\"Copyright ©2018 OpenPath, Inc.\",\"name\":\"Unknown-Endpoint\",\"description\":\"This is unknown endpoint in the application programming interface for the OpenPath SaaS API. Unauthorized access is strictly prohibited.\",\"result\":null,\"paging\":null,\"filter\":null,\"status\":404,\"status_message\":\"Not Found\",\"errors\":[{\"source\":\"API Request\",\"message\":\"API Endpoint not found.\"}]}"},{"id":"d896e6ad-38a1-4ff7-88d2-6381462e2e3d","name":"Unknown Endpoint","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":"http://localhost:55875"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 17 May 2018 16:31:43 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Kestrel","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcVXNlcnNcSmFzb24gTWFydGluXHNvdXJjZVxyZXBvc1xvcGVuLnBhdGhcQXBpXEFwaS5BcHBsaWNhdGlvbg==?=","name":"X-SourceFiles","description":"Custom header"}],"cookie":[],"responseTime":null,"body":"{\"organization\":\"OpenPath, Incorporated\",\"web_site\":\"https://openpath.io\",\"phone_number\":\"+1 (844) PATH-24/7\",\"email\":\"support@openpath.io\",\"application\":\"OpenPath SaaS API\",\"version\":\"n/a\",\"copyright\":\"Copyright ©2018 OpenPath, Inc.\",\"name\":\"Unknown-Endpoint\",\"description\":\"This is unknown endpoint in the application programming interface for the OpenPath SaaS API. Unauthorized access is strictly prohibited.\",\"result\":null,\"paging\":null,\"filter\":null,\"status\":404,\"status_message\":\"Not Found\",\"errors\":[{\"source\":\"API Request\",\"message\":\"API Endpoint not found.\"}]}"}],"_postman_id":"8058c8ae-7f4b-4277-92de-6759d89891e0"},{"name":"Unknown Endpoint","event":[{"listen":"test","script":{"id":"84bf46d8-38ed-4ecd-bdf1-0bcc3720d874","type":"text/javascript","exec":["tests['Unknown-Endpoint'] = responseBody.has('\"errors\":[{\"source\":\"API Request\",\"message\":\"API Endpoint not found.\"}]');","tests[responseBody] = true;"]}}],"id":"05647ced-17de-461c-adf7-89d17e21990a","request":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}","description":"

Unknown Endpoint

When you try to access an end point that does not exist within the API you will receive a 404 HTTP response code and an JSON envelope containing that error.

\n
NOTE You do not need to be authenticated to receive an Unknown Endpoint\nerror.
\n

\n","urlObject":{"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"6fa2226f-f791-481e-8a88-67f688980d43","name":"Unknown Endpoint","originalRequest":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[]},"url":"http://localhost:55875"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 17 May 2018 21:20:11 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Kestrel","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcVXNlcnNcSmFzb24gTWFydGluXHNvdXJjZVxyZXBvc1xvcGVuLnBhdGhcQXBpXEFwaS5BcHBsaWNhdGlvbg==?=","name":"X-SourceFiles","description":"Custom header"}],"cookie":[],"responseTime":null,"body":"{\"organization\":\"OpenPath, Incorporated\",\"web_site\":\"https://openpath.io\",\"phone_number\":\"+1 (844) PATH-24/7\",\"email\":\"support@openpath.io\",\"application\":\"OpenPath SaaS API\",\"version\":\"n/a\",\"copyright\":\"Copyright ©2018 OpenPath, Inc.\",\"name\":\"Unknown-Endpoint\",\"description\":\"This is unknown endpoint in the application programming interface for the OpenPath SaaS API. Unauthorized access is strictly prohibited.\",\"result\":null,\"paging\":null,\"filter\":null,\"status\":404,\"status_message\":\"Not Found\",\"errors\":[{\"source\":\"API Request\",\"message\":\"API Endpoint not found.\"}]}"}],"_postman_id":"05647ced-17de-461c-adf7-89d17e21990a"},{"name":"Unknown Endpoint","event":[{"listen":"test","script":{"id":"62bab401-acf8-4cbb-a61e-5547e7a13214","type":"text/javascript","exec":["tests['Unknown-Endpoint'] = responseBody.has('\"errors\":[{\"source\":\"API Request\",\"message\":\"API Endpoint not found.\"}]');","tests[responseBody] = true;"]}}],"id":"9b43ba56-c628-4b42-a0f1-9458fae3edc3","request":{"method":"PATCH","header":[],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}","description":"

Unknown Endpoint

When you try to access an end point that does not exist within the API you will receive a 404 HTTP response code and an JSON envelope containing that error.

\n
NOTE You do not need to be authenticated to receive an Unknown Endpoint\nerror.
\n

\n","urlObject":{"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"18c9829c-f319-4e78-b1f4-090a999e6b6d","name":"Unknown Endpoint","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"formdata","formdata":[]},"url":"http://localhost:55875"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 17 May 2018 21:20:33 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Kestrel","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcVXNlcnNcSmFzb24gTWFydGluXHNvdXJjZVxyZXBvc1xvcGVuLnBhdGhcQXBpXEFwaS5BcHBsaWNhdGlvbg==?=","name":"X-SourceFiles","description":"Custom header"}],"cookie":[],"responseTime":null,"body":"{\"organization\":\"OpenPath, Incorporated\",\"web_site\":\"https://openpath.io\",\"phone_number\":\"+1 (844) PATH-24/7\",\"email\":\"support@openpath.io\",\"application\":\"OpenPath SaaS API\",\"version\":\"n/a\",\"copyright\":\"Copyright ©2018 OpenPath, Inc.\",\"name\":\"Unknown-Endpoint\",\"description\":\"This is unknown endpoint in the application programming interface for the OpenPath SaaS API. Unauthorized access is strictly prohibited.\",\"result\":null,\"paging\":null,\"filter\":null,\"status\":404,\"status_message\":\"Not Found\",\"errors\":[{\"source\":\"API Request\",\"message\":\"API Endpoint not found.\"}]}"}],"_postman_id":"9b43ba56-c628-4b42-a0f1-9458fae3edc3"},{"name":"Unknown Endpoint","event":[{"listen":"test","script":{"id":"0adb9488-741d-4727-b6e3-0ca5491973a2","type":"text/javascript","exec":["tests['Unknown-Endpoint'] = responseBody.has('\"errors\":[{\"source\":\"API Request\",\"message\":\"API Endpoint not found.\"}]');","tests[responseBody] = true;"]}}],"id":"9dafb2e6-7192-4c1b-b9d1-4b1b1ff62731","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}","description":"

Unknown Endpoint

When you try to access an end point that does not exist within the API you will receive a 404 HTTP response code and an JSON envelope containing that error.

\n
NOTE You do not need to be authenticated to receive an Unknown Endpoint\nerror.
\n

\n","urlObject":{"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"e53f5f16-c4d2-464f-832a-d4416bd0a4eb","name":"Unknown Endpoint","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[]},"url":"http://localhost:55875"},"status":"Not Found","code":404,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Thu, 17 May 2018 21:20:53 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Kestrel","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcVXNlcnNcSmFzb24gTWFydGluXHNvdXJjZVxyZXBvc1xvcGVuLnBhdGhcQXBpXEFwaS5BcHBsaWNhdGlvbg==?=","name":"X-SourceFiles","description":"Custom header"}],"cookie":[],"responseTime":null,"body":"{\"organization\":\"OpenPath, Incorporated\",\"web_site\":\"https://openpath.io\",\"phone_number\":\"+1 (844) PATH-24/7\",\"email\":\"support@openpath.io\",\"application\":\"OpenPath SaaS API\",\"version\":\"n/a\",\"copyright\":\"Copyright ©2018 OpenPath, Inc.\",\"name\":\"Unknown-Endpoint\",\"description\":\"This is unknown endpoint in the application programming interface for the OpenPath SaaS API. Unauthorized access is strictly prohibited.\",\"result\":null,\"paging\":null,\"filter\":null,\"status\":404,\"status_message\":\"Not Found\",\"errors\":[{\"source\":\"API Request\",\"message\":\"API Endpoint not found.\"}]}"}],"_postman_id":"9dafb2e6-7192-4c1b-b9d1-4b1b1ff62731"}],"id":"4faf11e3-8479-4747-91fb-34eafa4152ff","description":"

The root represents the base address of the SaaS API with is https://api-saas.openpath.io.

\n
ROOT URL https://api-saas.openpath.io
\n

\n","event":[{"listen":"prerequest","script":{"id":"a36690c7-ea40-481f-a98e-5817b4769d88","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"12b9da0d-606a-436f-857d-fc690b710f64","type":"text/javascript","exec":[""]}}],"_postman_id":"4faf11e3-8479-4747-91fb-34eafa4152ff"},{"name":"Authentication","item":[{"name":"Get API Keys","event":[{"listen":"test","script":{"id":"7c66b3e9-0c5d-498a-afb1-eeeb5a6bea93","type":"text/javascript","exec":["tests['Authentication-Get-API-Keys'] = responseBody.has('\"name\":\"Authentication-Get-API-Keys\"');","tests[responseBody] = true;"]}}],"id":"e2dd4596-05a9-4a2a-81fa-741830cd7d3c","request":{"method":"GET","header":[{"key":"Authorization","value":"{{API-Key}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/v3/authentication","description":"

Description

This request will get all the API keys and allowed IP addresses associated with the organizations account.

API Key Item

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

Key	Description
API Key ID	The unique id.
Name	The name assigned, this is for reference purposes only.
Description	The description of what this API Key is for, this is for reference purposes only.
Tags	This allows you to tag an API Key for your own internal purposes.
API Key	This is the unique API Key used for accessing the SaaS API, keep this key very sucure.
Created On	The date this API Key was created.
Updated On	The last time this API Key was updated, this also includes the last time this API Key was used to access an endpoint.
Role	The security role that this API Key belongs to. This will determine what this key has access to in the system.
IP Addresses	This is an array of v4 and v6 IP ranges that the endpoints will accept requests from. See [IP Address Item](#IP Address Item) for more details.

IP Address Item

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

Key	Description
API Key IP ID	The unique id.
Name	The name assigned, this is for reference purposes only.
IP Start Address	The start of the IP address range accepted.
IP End Address	Then end of the IP address range accepted.

","urlObject":{"path":["v3","authentication"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"80174942-24ee-437e-8378-2b3b4609ae5d","name":"Get All Organization Keys","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{API-Key}}","disabled":false},{"key":"Accept","value":"application/json","disabled":false}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/v3/authentication"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Thu, 17 May 2018 21:33:34 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Kestrel","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcVXNlcnNcSmFzb24gTWFydGluXHNvdXJjZVxyZXBvc1xvcGVuLnBhdGhcQXBpXEFwaS5BcHBsaWNhdGlvblx2M1xhdXRoZW50aWNhdGlvbg==?=","name":"X-SourceFiles","description":"Custom header"}],"cookie":[],"responseTime":null,"body":"{\n \"name\": \"Authentication-Get-API-Keys\",\n \"description\": \"Returns all Authentication API Keys associated with the authenticated organization.\",\n \"result\": [\n {\n \"api_key_id\": 3,\n \"name\": \"Acme Application Requests\",\n \"description\": \"Takes requests from the website for high level API operations.\",\n \"tags\": \"Acme,Internal\",\n \"api_key\": \"client_rdk333N94r4rANX2rpfp21T4M972Rhz7rL2y23dPHCWLNkXq\",\n \"created_on\": \"2018-01-01T03:37:13.8493823\",\n \"updated_on\": \"2018-05-17T21:33:32.0825571\",\n \"role\": \"Client\",\n \"ip_addresses\": [\n {\n \"api_key_ip_id\": 2,\n \"name\": \"IP4 Allow All\",\n \"ip_start_address\": \"1.1.1.1\",\n \"ip_end_address\": \"255.255.255.255\"\n },\n {\n \"api_key_ip_id\": 6,\n \"name\": \"IP6 Local Host\",\n \"ip_start_address\": \"::1\",\n \"ip_end_address\": \"::1\"\n }\n ]\n }\n ]\n}"}],"_postman_id":"e2dd4596-05a9-4a2a-81fa-741830cd7d3c"},{"name":"Get API Key","event":[{"listen":"test","script":{"id":"483b8e50-c24c-41c2-92b5-2df60dd4e57a","type":"text/javascript","exec":["tests['Authentication-Get-API-Key'] = responseBody.has('\"name\":\"Authentication-Get-API-Key\"');","tests[responseBody] = true;","","","pm.test(\"Got 1 Result\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.paging.count).to.eql(1);","});"]}}],"id":"4db9c637-5228-469b-9290-dfc11626ed09","request":{"method":"GET","header":[{"key":"Authorization","value":"{{API-Key}}"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/v3/authentication/3","description":"

Description

This request will get the API key and allowed IP addresses associated with API Key ID in the endpoint.

API Key Item

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

Key	Description
API Key ID	The unique id.
Name	The name assigned, this is for reference purposes only.
Description	The description of what this API Key is for, this is for reference purposes only.
Tags	This allows you to tag an API Key for your own internal purposes.
API Key	This is the unique API Key used for accessing the SaaS API, keep this key very sucure.
Created On	The date this API Key was created.
Updated On	The last time this API Key was updated, this also includes the last time this API Key was used to access an endpoint.
Role	The security role that this API Key belongs to. This will determine what this key has access to in the system.
IP Addresses	This is an array of v4 and v6 IP ranges that the endpoints will accept requests from. See [IP Address Item](#IP Address Item) for more details.

IP Address Item

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

Key	Description
API Key IP ID	The unique id.
Name	The name assigned, this is for reference purposes only.
IP Start Address	The start of the IP address range accepted.
IP End Address	Then end of the IP address range accepted.

","urlObject":{"path":["v3","authentication","3"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"0b4b5b86-d82b-4861-b591-433045fd253b","name":"Get Organization Key","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{API-Key}}"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/v3/authentication/3"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Thu, 17 May 2018 21:53:31 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Kestrel","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcVXNlcnNcSmFzb24gTWFydGluXHNvdXJjZVxyZXBvc1xvcGVuLnBhdGhcQXBpXEFwaS5BcHBsaWNhdGlvblx2M1xhdXRoZW50aWNhdGlvblwz?=","name":"X-SourceFiles","description":"Custom header"}],"cookie":[],"responseTime":null,"body":"{\n \"name\": \"Authentication-Get-API-Key\",\n \"description\": \"Returns the requested Authentication API Key associated with the API Key ID.\",\n \"result\": {\n \"api_key_id\": 3,\n \"name\": \"Acme Client Application Requests\",\n \"description\": \"Takes requests from the website for high level API operations.\",\n \"tags\": \"Acme,Internal\",\n \"api_key\": \"client_rdk333N94r4rANX2rpfp21T4M972Rhz7rL2y23dPHCWLNkXq\",\n \"created_on\": \"2018-01-01T03:37:13.8493823\",\n \"updated_on\": \"2018-05-17T21:33:32.0825571\",\n \"role\": \"Client\",\n \"ip_addresses\": [\n {\n \"api_key_ip_id\": 2,\n \"name\": \"IP4 Allow All\",\n \"ip_start_address\": \"1.1.1.1\",\n \"ip_end_address\": \"255.255.255.255\"\n },\n {\n \"api_key_ip_id\": 6,\n \"name\": \"IP6 Local Host\",\n \"ip_start_address\": \"::1\",\n \"ip_end_address\": \"::1\"\n }\n ]\n }\n}"}],"_postman_id":"4db9c637-5228-469b-9290-dfc11626ed09"},{"name":"Renew API Key","event":[{"listen":"test","script":{"id":"aa44e805-21a9-49a4-8656-abd809b1f90a","type":"text/javascript","exec":["tests['Authentication-Renew-API-Key'] = responseBody.has('\"name\":\"Authentication-Renew-API-Key\"');","tests[responseBody] = true;","","if(responseBody.has('\"name\":\"Authentication-Renew-API-Key\"')) {"," pm.environment.set(\"API-Key\", pm.response.json().result.api_key);","}",""]}}],"id":"903b7da2-6314-43b7-8691-3d54f72c05a9","request":{"method":"PATCH","header":[{"key":"Authorization","value":"{{API-Key}}"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/v3/authentication/3/renewapikey","description":"

Description

This request will renew the API Key for the given API Key ID. You can renew the API Key as many times as you want.

\n
NOTE If you renewed the API Key that you used to authenticate to this endpoint that key will no longer be valid.
\n

API Key Item

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

Key	Description
API Key ID	The unique id.
Name	The name assigned, this is for reference purposes only.
Description	The description of what this API Key is for, this is for reference purposes only.
Tags	This allows you to tag an API Key for your own internal purposes.
API Key	This is the unique API Key used for accessing the SaaS API, keep this key very sucure.
Created On	The date this API Key was created.
Updated On	The last time this API Key was updated, this also includes the last time this API Key was used to access an endpoint.
Role	The security role that this API Key belongs to. This will determine what this key has access to in the system.
IP Addresses	This is an array of v4 and v6 IP ranges that the endpoints will accept requests from. See [IP Address Item](#IP Address Item) for more details.

IP Address Item

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

Key	Description
API Key IP ID	The unique id.
Name	The name assigned, this is for reference purposes only.
IP Start Address	The start of the IP address range accepted.
IP End Address	Then end of the IP address range accepted.

","urlObject":{"path":["v3","authentication","3","renewapikey"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"e988febe-5967-4f1f-9a10-0ccdef0353f0","name":"Renew an API Key","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"{{API-Key}}","disabled":false}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/v3/authentication/3/renewapikey"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Thu, 17 May 2018 23:02:10 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Kestrel","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcVXNlcnNcSmFzb24gTWFydGluXHNvdXJjZVxyZXBvc1xvcGVuLnBhdGhcQXBpXEFwaS5BcHBsaWNhdGlvblx2M1xhdXRoZW50aWNhdGlvblwzXHJlbmV3YXBpa2V5?=","name":"X-SourceFiles","description":"Custom header"}],"cookie":[],"responseTime":null,"body":"{\n \"name\": \"Authentication-Renew-API-Key\",\n \"description\": \"Returns a renewed Authentication API Key associated with the API Key ID requested.\",\n \"result\": {\n \"api_key_id\": 3,\n \"name\": \"Acme Client Application Requests\",\n \"description\": \"Takes requests from the website for high level API operations.\",\n \"tags\": \"Acme,Internal\",\n \"api_key\": \"client_3R22haqaNhe7e2xE3FxcK32xJ9949tcJnJMck7yJPcy99W9w\",\n \"created_on\": \"2018-05-01T00:00:00\",\n \"updated_on\": \"2018-05-17T23:02:08.5531044\",\n \"role\": \"Client\",\n \"ip_addresses\": [\n {\n \"api_key_ip_id\": 2,\n \"name\": \"IP4 Allow All\",\n \"ip_start_address\": \"1.1.1.1\",\n \"ip_end_address\": \"255.255.255.255\"\n },\n {\n \"api_key_ip_id\": 6,\n \"name\": \"IP6 Local Host\",\n \"ip_start_address\": \"::1\",\n \"ip_end_address\": \"::1\"\n }\n ]\n }\n}"}],"_postman_id":"903b7da2-6314-43b7-8691-3d54f72c05a9"},{"name":"Update API Key","event":[{"listen":"test","script":{"id":"9c782f8a-58c1-4d18-a1af-0f3508fc4a36","type":"text/javascript","exec":["tests['Authentication-Update-API-Key'] = responseBody.has('\"name\":\"Authentication-Update-API-Key\"');","tests[responseBody] = true;"]}}],"id":"1e603766-c0d1-42f9-b8cf-4d1f9182bca1","request":{"method":"PATCH","header":[{"key":"Authorization","value":"{{API-Key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Acme Application Requests\",\n \"description\": \"Takes requests from the Acme CRM for API operations.\",\n \"tags\": \"Acme,Internal\"\n}"},"url":"{{URL}}/v3/authentication/3","description":"

Description

This patch allows you to update the API Key information.

\n
NOTE You only have to include the fields you want to update, if a key is not included, then the original value will be maintained.
\n

Updatable Keys

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

Key	Description
Name	The name assigned, this is for reference purposes only.
Description	The description of what this API Key is for, this is for reference purposes only.
Tags	This allows you to tag an API Key for your own internal purposes.

API Key Item

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

Key	Description
API Key ID	The unique id.
Name	The name assigned, this is for reference purposes only.
Description	The description of what this API Key is for, this is for reference purposes only.
Tags	This allows you to tag an API Key for your own internal purposes.
API Key	This is the unique API Key used for accessing the SaaS API, keep this key very sucure.
Created On	The date this API Key was created.
Updated On	The last time this API Key was updated, this also includes the last time this API Key was used to access an endpoint.
Role	The security role that this API Key belongs to. This will determine what this key has access to in the system.
IP Addresses	This is an array of v4 and v6 IP ranges that the endpoints will accept requests from. See [IP Address Item](#IP Address Item) for more details.

IP Address Item

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

Key	Description
API Key IP ID	The unique id.
Name	The name assigned, this is for reference purposes only.
IP Start Address	The start of the IP address range accepted.
IP End Address	Then end of the IP address range accepted.

","urlObject":{"path":["v3","authentication","3"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"1e603766-c0d1-42f9-b8cf-4d1f9182bca1"},{"name":"Create API Key IP Address","event":[{"listen":"test","script":{"id":"7593401c-c93c-43ea-9b80-68588a7469f4","type":"text/javascript","exec":["tests['Authentication-Create-API-Key-IP-Address'] = responseBody.has('\"name\":\"Authentication-Create-API-Key-IP-Address\"');","tests[responseBody] = true;","","if(responseBody.has('\"name\":\"Authentication-Create-API-Key-IP-Address\"')) {"," pm.environment.set(\"api_key_ip_id\", pm.response.json().result.api_key_ip_id);","}"]}}],"id":"6393a844-c152-440a-bd5f-ac0bdebe428f","request":{"method":"POST","header":[{"key":"Authorization","value":"{{API-Key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Local Host\",\n \"ip_start_address\": \"127.0.0.1\",\n \"ip_end_address\": \"127.0.0.1\"\n}"},"url":"{{URL}}/v3/authentication/3/ipaddress","description":"

Description

This post allows you to add new IP address ranges that this API Key will accept requests from

IP Address Item

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

Key	Description
API Key IP ID	The unique id.
Name	The name assigned, this is for reference purposes only.
IP Start Address	The start of the IP address range accepted.
IP End Address	Then end of the IP address range accepted.

","urlObject":{"path":["v3","authentication","3","ipaddress"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"a210407d-1842-4b81-a2de-680f01377fb1","name":"Create API Key IP Address","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{API-Key}}","disabled":false},{"key":"Content-Type","value":"application/json","disabled":false}],"body":{"mode":"raw","raw":"{\n \"name\": \"Local Host\",\n \"ip_start_address\": \"127.0.0.1\",\n \"ip_end_address\": \"127.0.0.1\"\n}"},"url":"{{URL}}/v3/authentication/3/ipaddress"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 18 May 2018 00:04:30 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Location","value":"http://localhost:55875/v3/Authentication/3/ipaddress/23","name":"Location","description":"Used in redirection, or when a new resource has been created."},{"key":"Server","value":"Kestrel","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcVXNlcnNcSmFzb24gTWFydGluXHNvdXJjZVxyZXBvc1xvcGVuLnBhdGhcQXBpXEFwaS5BcHBsaWNhdGlvblx2M1xhdXRoZW50aWNhdGlvblwzXGlwYWRkcmVzcw==?=","name":"X-SourceFiles","description":"Custom header"}],"cookie":[],"responseTime":null,"body":"{\n \"name\": \"Authentication-Create-API-Key-IP-Address\",\n \"description\": \"Creates a new allowed IP address range.\",\n \"result\": {\n \"api_key_ip_id\": 23,\n \"name\": \"Local Host\",\n \"ip_start_address\": \"127.0.0.1\",\n \"ip_end_address\": \"127.0.0.1\"\n }\n}"}],"_postman_id":"6393a844-c152-440a-bd5f-ac0bdebe428f"},{"name":"Get API Key IP Addresses","event":[{"listen":"test","script":{"id":"84e32a1c-9ae8-4af2-84db-efb427df881e","type":"text/javascript","exec":["tests['Authentication-Get-API-Key-IP-Addresses'] = responseBody.has('\"name\":\"Authentication-Get-API-Key-IP-Addresses\"');","tests[responseBody] = true;"]}}],"id":"b8238a86-1864-4af3-9c92-ed9391106b74","request":{"method":"GET","header":[{"key":"Authorization","value":"{{API-Key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Acme Application Requests\",\n \"description\": \"Takes requests from the Acme CRM for API operations.\",\n \"tags\": \"Acme,Internal\"\n}"},"url":"{{URL}}/v3/authentication/3/ipaddress","description":"

Description

This request will return all the IP address ranges associated with a single API Key.

IP Address Item

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

Key	Description
API Key IP ID	The unique id.
Name	The name assigned, this is for reference purposes only.
IP Start Address	The start of the IP address range accepted.
IP End Address	Then end of the IP address range accepted.

","urlObject":{"path":["v3","authentication","3","ipaddress"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b8238a86-1864-4af3-9c92-ed9391106b74"},{"name":"Get API Key IP Address","event":[{"listen":"test","script":{"id":"664eb7ea-0fe3-42ef-86c7-3995c6b50239","type":"text/javascript","exec":["tests['Authentication-Get-API-Key-IP-Address'] = responseBody.has('\"name\":\"Authentication-Get-API-Key-IP-Address\"');","tests[responseBody] = true;"]}}],"id":"ed7925c5-a46e-4940-bce5-07af3eea3bd7","request":{"method":"GET","header":[{"key":"Authorization","value":"{{API-Key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Acme Application Requests\",\n \"description\": \"Takes requests from the Acme CRM for API operations.\",\n \"tags\": \"Acme,Internal\"\n}"},"url":"{{URL}}/v3/authentication/3/ipaddress/2","description":"

Description

This request will return the IP address range associated with a single API Key.

IP Address Item

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

Key	Description
API Key IP ID	The unique id.
Name	The name assigned, this is for reference purposes only.
IP Start Address	The start of the IP address range accepted.
IP End Address	Then end of the IP address range accepted.

","urlObject":{"path":["v3","authentication","3","ipaddress","2"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"9d7a7f58-f6a7-46bd-8bf0-4b136136ebcd","name":"Get API Key IP Address","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{API-Key}}","disabled":false},{"key":"Content-Type","value":"application/json","disabled":false}],"body":{"mode":"raw","raw":"{\n \"name\": \"Acme Application Requests\",\n \"description\": \"Takes requests from the Acme CRM for API operations.\",\n \"tags\": \"Acme,Internal\"\n}"},"url":"{{URL}}/v3/authentication/3/ipaddress/2"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 18 May 2018 01:21:39 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Kestrel","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcVXNlcnNcSmFzb24gTWFydGluXHNvdXJjZVxyZXBvc1xvcGVuLnBhdGhcQXBpXEFwaS5BcHBsaWNhdGlvblx2M1xhdXRoZW50aWNhdGlvblwzXGlwYWRkcmVzc1wy?=","name":"X-SourceFiles","description":"Custom header"}],"cookie":[],"responseTime":null,"body":"{\n \"name\": \"Authentication-Get-API-Key-IP-Address\",\n \"description\": \"Gets the IP Address range by the associated with an API Key IP ID.\",\n \"result\": {\n \"api_key_ip_id\": 2,\n \"name\": \"IP4 Allow All\",\n \"ip_start_address\": \"1.1.1.1\",\n \"ip_end_address\": \"255.255.255.255\"\n }\n}"}],"_postman_id":"ed7925c5-a46e-4940-bce5-07af3eea3bd7"},{"name":"Update API Key IP Address","event":[{"listen":"test","script":{"id":"05c45b2c-d537-46b0-b7ca-246da94f7172","type":"text/javascript","exec":["tests['Authentication-Update-API-Key-IP-Address'] = responseBody.has('\"name\":\"Authentication-Update-API-Key-IP-Address\"');","tests[responseBody] = true;"]}}],"id":"6a2f6f61-b374-4fe0-b5d8-e43cb4d93af8","request":{"method":"PATCH","header":[{"key":"Authorization","value":"{{API-Key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Allow All\",\n \"ip_start_address\": \"1.1.1.1\",\n \"ip_end_address\": \"255.255.255.255\"\n}"},"url":"{{URL}}/v3/authentication/3/ipaddress/2","description":"

Description

This patch allows you to update the API Key IP address range information.

\n
NOTE You only have to include the fields you want to update, if a key is not included, then the original value will be maintained.
\n

Updatable Keys

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

Key	Description
Name	The name assigned, this is for reference purposes only.
IP Start Address	The start of the IP address range accepted.
IP End Address	Then end of the IP address range accepted.

IP Address Item

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

Key	Description
API Key IP ID	The unique id.
Name	The name assigned, this is for reference purposes only.
IP Start Address	The start of the IP address range accepted.
IP End Address	Then end of the IP address range accepted.

","urlObject":{"path":["v3","authentication","3","ipaddress","2"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"da3ccfa7-cd9a-48c1-aa3a-430cafc86574","name":"Update API Key IP Address","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"{{API-Key}}","disabled":false},{"key":"Content-Type","value":"application/json","disabled":false}],"body":{"mode":"raw","raw":"{\n \"name\": \"Allow All\",\n \"ip_start_address\": \"1.1.1.1\",\n \"ip_end_address\": \"255.255.255.255\"\n}"},"url":"{{URL}}/v3/authentication/3/ipaddress/2"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 18 May 2018 03:08:39 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Kestrel","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcVXNlcnNcSmFzb24gTWFydGluXHNvdXJjZVxyZXBvc1xvcGVuLnBhdGhcQXBpXEFwaS5BcHBsaWNhdGlvblx2M1xhdXRoZW50aWNhdGlvblwzXGlwYWRkcmVzc1wy?=","name":"X-SourceFiles","description":"Custom header"}],"cookie":[],"responseTime":null,"body":"{\n \"name\": \"Authentication-Update-API-Key-IP-Address\",\n \"description\": \"Gets the IP Address range by the associated with an API Key IP ID.\",\n \"result\": {\n \"api_key_ip_id\": 2,\n \"name\": \"Allow All\",\n \"ip_start_address\": \"1.1.1.1\",\n \"ip_end_address\": \"255.255.255.255\"\n }\n}"}],"_postman_id":"6a2f6f61-b374-4fe0-b5d8-e43cb4d93af8"},{"name":"Delete API Key IP Address","event":[{"listen":"test","script":{"id":"44f74df7-1c03-4016-a29c-bb935797f816","type":"text/javascript","exec":["tests['Authentication-Delete-API-Key-IP-Address'] = responseBody.has('\"name\":\"Authentication-Delete-API-Key-IP-Address\"');","tests[responseBody] = true;",""]}}],"id":"131e15f3-3454-490e-9e6b-bb92bdd9e59c","request":{"method":"DELETE","header":[{"key":"Authorization","value":"{{API-Key}}"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/v3/authentication/3/ipaddress/{{api_key_ip_id}}","description":"

Description

Deletes the specified API Key IP address range by ID.

\n
NOTE Once this endpoint is called successfully, it cannot be undone.
\n

\n","urlObject":{"path":["v3","authentication","3","ipaddress","{{api_key_ip_id}}"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"dae23ae2-dd5b-4070-a44d-6bd850fb393a","name":"Delete API Key IP Address","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"{{API-Key}}","disabled":false}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/v3/authentication/3/ipaddress/23"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 18 May 2018 03:15:11 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Kestrel","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcVXNlcnNcSmFzb24gTWFydGluXHNvdXJjZVxyZXBvc1xvcGVuLnBhdGhcQXBpXEFwaS5BcHBsaWNhdGlvblx2M1xhdXRoZW50aWNhdGlvblwzXGlwYWRkcmVzc1wyMw==?=","name":"X-SourceFiles","description":"Custom header"}],"cookie":[],"responseTime":null,"body":"{\n \"name\": \"Authentication-Delete-API-Key-IP-Address\",\n \"description\": \"Gets the IP Address range by the associated with an API Key IP ID.\",\n \"result\": null,\n \"status\": 200,\n \"status_message\": \"Ok\"\n}"}],"_postman_id":"131e15f3-3454-490e-9e6b-bb92bdd9e59c"}],"id":"922fcc6c-fe60-4600-8b3f-25e293f1352e","description":"

Description

Since when it comes down to transaction processing most customers expect the fastest response times possible. Therefor the OpenPath SaaS API does not require that you first request a token and then make an endpoint request because this requires two round trips increasing the time it takes to process a request.

Instead through the OpenPath portal you must first create an API Key and restrict this API Key for use by IPv4 or IPv6 ranges. Once a key has been generated, you can refresh this key via the API as offen as you want.

\n
NOTE You can create a key in the API Keys section of the OpenPath portal.
\n

Once you have your API Key, the key must be passed in the header of your request using the header key Authroization and the value as your API Key.

\n","event":[{"listen":"prerequest","script":{"id":"c251488f-45cc-4ea5-892a-b90f3287a48d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"1e45d383-a463-427b-8762-18997b22dcd3","type":"text/javascript","exec":[""]}}],"_postman_id":"922fcc6c-fe60-4600-8b3f-25e293f1352e"},{"name":"Midigator","item":[{"name":"Create Chargeback","event":[{"listen":"test","script":{"id":"851f6ad0-cd06-46d0-86a3-7d4d78a3e339","type":"text/javascript","exec":["tests['Midigator-Post-Chargeback'] = responseBody.has('\"name\":\"Midigator-Post-Chargeback\"');","tests[responseBody] = true;",""]}}],"id":"e4659322-584f-429a-9500-cd05729111f6","request":{"method":"POST","header":[{"key":"Authorization","value":"partner_wg9A3942r37kRL7WX2hyzAgY7rFHZ3NTC4C9aEg2Cy7Lw2cc"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"id\": \"32532DGGR235SEE\", \r\n \"chargeback_id\": 3636633,\r\n \"order_id\": \"MID-847\",\r\n \"mid\": \"56842241052602\",\r\n \"mid_alias\": \"MY_CAMPAIGN_USD\", \r\n \"arn\": \"93843897294837209847323\", \r\n \"case_number\": \"20170101010\",\r\n \"card_type\": \"visa\",\r\n \"card_bin\" : \"481588\",\r\n \"last_four\": \"0373\", \r\n \"amount\": 29.95,\r\n \"currency\" : \"USD\", \r\n \"date_received\": \"2018-05-10\",\r\n \"transaction_date\": \"2018-05-23\", \r\n \"reason_code\": \"4837\",\r\n \"reason_text\": \"No Cardholder Authorization\"\r\n}"},"url":"{{URL}}/v3/partners/midigator/chargeback","description":"

Description

The Midigator Chargeback endpoint accepts chargeback data and finds and returns the associated transaction. Once the transaction has been found a new chargeback transaction will be created and the events defined in the Midigator Integration will be fired.

Request Body Item

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

Key	Description
Order ID	The order id generated by the Point of Sale or CRM.
Case Number	The chargeback case number from the processor.
ARN	The Acquirer Reference Number.
Card Number	The first 6 numbers of the credit card (aka BIN) followed by to asterisks '' and the last 4 numbers (format: xxxxxxxxxx)
Card Type	The brand of the credit card (e.g. visa, mastercard).
Amount	The total amount of the transaction.
Reason Code	The chargeback reason code.
Reason	The chargeback reason message.
Date Received	The date the chargeback was received.

Packet Item

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

Key	Description
IP Address	The IP Address the transaction was received from, this is typically the Point of Sale or CRM and is not the credit card holders IP Address.
Packet ID	The unique ID of this transaction packet.
Responded	The UTC time the transaction was returned to the Point of Sale or Transaction.
Transaction	[See Transaction Item]

Transaction Item

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

Key	Description
Approved	Represents the response from the processor (Processing, Declined, Approved, Rejected, Error, Queued, Pending).
Attributes	An array of attributes [See Attribute Item].
Authorization Code	The autorization code returned from the processor.
Credit Card	[See Credit Card Item].
Currency	The country currency code (ISO 4217).
Description	The description of the transaction.
Device Type	The type of device the transaction was performed on (Unknown, UnattendedTerminal, SelfServiceTerminal, ElectronicCashRegister, AirPay, WirelessPOS, Website, DialTerminal, VirtualTerminal).
Employee Number	The employee number that took the credit card transaction.
Order Number	The order number generated from the Point of Sale or CRM.
IP Address	The IP address where the transaction originated from, typically the customer or if card present the terminal the card was swiped on.
Line Items	An array of the items purchased [See Line Item Item].
Market Type	The sale market type (Unknown, Retail, ECommerce, MailOrder, Telephone, MailOrderTelephone).
Paths	An array of the OpenPath paths that the packet went through before being passed on to the processor.
Transaction ID	The transaction ID returned from the Processor.
PO Number	The PO Number from the Point of Sale or CRM.
Processing System	The name of the processing system.
Recurring	[See Recurring Item]
Results	[See Results]
Tax Excempt	Was this order tax exempt?
Total	The total amount billed to the transaction.
OpenPath ID	The unique OpenPath ID assigned to this transaction.
Type	The type of credit card transaction this was (Sale, Authorization, Capture, Void, Refund, Credit, Chargeback, Validate, Offline, Cancel, Update).

Attribute Item

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

Key	Description
Attribute ID	The unique Attribute ID.
Key	The Key name that represents the value.
Value	The value of the key.

Credit Card Item

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

Key	Description
Addresses	An array of known addresses associated to this credit card [See Address Item].
Bank	The name of the issue bank of the credit card.
BIN IIN Number	The first 6 digits of the credit card number.
Brand	The brand of the credit card (e.g. Visa, Master Card).
Card Token	A unique token associated with this credit card.
Category	The category this credit card belongs to (e.g. Platnum, Signature, Business)
Country	The name of the country of origin for this credit card.
Country Code	The country code associated to this credit card.
Created	When this credit card was first added to the OpenPath system.
Credit Card ID	A unique ID representing this credit card in the OpenPath system.
Customer	[See Customer Item]
Expiration Date	The expiration date of this credit card.
Latitude	The latitude of the issuing bank.
Longitude	The longitude of the issuing bank.
Masked Card Number	A masked representation of this credit card (format: xxxx-xx-**-xxxx)
Sub-Brand	The sub-brand associated with the band if one is associated.
Track 1	The information contained on the first track of the magnetic strip.
Track 2	The information contained on the second track of the magnetic strip.
Type	The type of credit card this is (e.g. Credit, Debit, Gift Card).
Updated	The last time this credit card was updated by OpenPath.

Line Item Item

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

Key	Description
Line Item Id	OpenPaths Unique ID for this Line Item.
SKU	SKU of the item being purchased.
Name	Name of the product.
Description	Description of the product.
Quantity	Total order number for this product.
Total	The total cost of the product.
Tax	The tax on this product.
Tax Rate	The tax rate applied to this product.
Commodity Code	International description code of the individual good or service being supplied. The acquirer or processor will provide a list of current codes.
Unit of Measure	The unit used to measure this time (e.g. Pounds, Hours, Litters).
Unit of Cost	The cost per unit of measure.
Tax Name	The name of the tax applied.
Tax Description	A description of the the tax being applied.
Duty	The duty that may be applied to this item.
Discount	Any discount applied to this item.
Duty Name	The name of the duty being applied to this item.
Shipping	Shipping cost for this item.
Ship from Zip	Shipping from what Postal or Zipcode.
Shipping Name	Name of the shipping method.
Shipping Description	Description of the shipping method.

Path Item

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

Key	Description
To	The destination path type (e.g. Site, Filter, Route, Load Balancer, Queue, Connector).
Destination Key	The unique key of the next destination path for a transaction packet.
Destination Name	The name of of this destination path.
Path ID	The unique ID of this logged path.
Reason	The reason for choosing this next path.
From	The source path type (e.g. Site, Filter, Route, Load Balancer, Queue, Connector).
Source Key	The unique key of the source path for a transaction packet.
Source Name	The name of of the source path.
Timestamp	The timestamp when the packet was processed by this path.

Recurring Item

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

Key	Description
Recurring ID	The unique ID of this recurring item.
Recurring Type	Where the recurring charges are triggered from (AtGateway, AtCRM, AtGateway).
Initial	Was this the inital payment?
Payments	How many payment are scheduled.
Amount	The amount of the recurring payment.
Frequency Unit	The unit of frequency the recurring payment is made (Days, Months, Years).
Frequency	The frequency of the recurring payments.
Billing Day	The billilng day.
Start Date	Start the recurring billing on this date.
Source ID	The ID of the source of this recurring billing.

Result Item

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

Key	Description
Method	The payment method used for this transaction (e.g. CreditCard, AutomatedClearingHouse, Check, Paypal, MobilePay, Bitcoin, Ticket).
Response	The response type of this payment method (Approved, Declined, Rejected, Error, Pending, Information).
Result ID	The unique ID of this result.
Result Type	What was this response generated from (e.g. Transaction, Address, SecurityCode, Gateway, Procesor, Response, Information, Checkback).
Specific	The exact specific response details.
Value	The un-translated response from the system returning the response.
Variety	What type of response this was (e.g. Soft, Action, Hard, NotApplicable).

Address Item

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

Key	Description
Address 1	The street Address
Address 2	Additional address information
City	The city.
Country	The country.
County Region	The county or region depanding on the county.
Latitude	The latitude of the of the address.
Longitude	The longitude of the address.
Phones	An array of phone numbers associated to this address [See Phone Item].
Postal Zip Code	The postal or zipcode of the address.
Provence State	The provence or state of the address.
Updated	The last time this address was updated.

Customer Item

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

Key	Description
Addresses	An array of addresses associated with this customer [See Address Item].
Created	The date this customer was added.
Customer ID	The unique customer ID associated to this customer.
Email	The customers primary email address.
First Name	The customers first name.
Last Name	The customers last name.
Type	The type of customer this is (e.g. Business, Individual).
Updated	The last time this customers information was updated.

Phone Item

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

Key	Description
Created	The date this phone number was created.
Number	The numerical referrence to this number with no extra characters.
Text	The phone number as originally entered.
Type	The type of phone number this is (e.g. Fax, Cell, LandLine)
Updated	The last time this phone number was updated.

","urlObject":{"path":["v3","partners","midigator","chargeback"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"f8aab1da-b112-44e8-bde9-5f79bca5fdb5","name":"Create Chargeback","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{API-Key}}","disabled":false},{"key":"Accept","value":"application/json","disabled":false},{"key":"Content-Type","value":"application/json","disabled":false}],"body":{"mode":"raw","raw":"{\r\n\t\"order_id\": \"45542\",\r\n\t\"case_number\": \"11111111\",\r\n\t\"arn\": \"48333602117017243750101\",\r\n\t\"card_number\": \"555555**4444\",\r\n\t\"card_type\": \"mastercard\",\r\n\t\"amount\": \"997.00\",\r\n\t\"reason_code\": \"4837\",\r\n\t\"reason\": \"No Cardholder Authorization\",\r\n\t\"date_received\": \"2018-04-06 22:49:24\"\r\n}"},"url":"{{URL}}/v1/partners/midigator/chargeback"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 18 May 2018 04:54:02 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Kestrel","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcVXNlcnNcSmFzb24gTWFydGluXHNvdXJjZVxyZXBvc1xvcGVuLnBhdGhcQXBpXEFwaS5BcHBsaWNhdGlvblx2MVxwYXJ0bmVyc1xtaWRpZ2F0b3JcY2hhcmdlYmFjaw==?=","name":"X-SourceFiles","description":"Custom header"}],"cookie":[],"responseTime":null,"body":"{\n \"name\": \"Midigator-Post-Chargeback\",\n \"description\": \"Finds the transaction from the posted chargeback information and adds that chargeback to the system to trigger associated events.\",\n \"result\": {\n \"ip_address\": \"127.0.0.1\",\n \"packet_id\": 10210,\n \"responded\": \"2018-04-06T22:49:40.2969985\",\n \"transaction\": {\n \"approved\": \"Approved\",\n \"attributes\": [],\n \"authorization_code\": \"\",\n \"credit_card\": {\n \"addresses\": [\n {\n \"address_1\": \"Petersgasse 46A\",\n \"address_2\": \"\",\n \"city\": \"Basel\",\n \"country\": \"CH\",\n \"county_region\": null,\n \"created\": \"2018-01-22T01:54:38.0937865\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"organization\": \"\",\n \"phones\": [\n {\n \"created\": \"2018-01-22T01:54:38.0937955\",\n \"credit_card_address_phone_id\": 5394,\n \"number\": \"0041796673085\",\n \"text\": \"0041796673085\",\n \"type\": \"Phone\",\n \"updated\": \"2018-01-22T01:54:38.0937964\"\n },\n {\n \"created\": \"2018-03-30T01:21:54.4521123\",\n \"credit_card_address_phone_id\": 5459,\n \"number\": \"0041796673085\",\n \"text\": \"0041796673085\",\n \"type\": \"Phone\",\n \"updated\": \"2018-03-30T01:21:54.4521128\"\n },\n {\n \"created\": \"2018-04-06T22:49:28.0264688\",\n \"credit_card_address_phone_id\": 5493,\n \"number\": \"0041796673085\",\n \"text\": \"0041796673085\",\n \"type\": \"Phone\",\n \"updated\": \"2018-04-06T22:49:28.0264693\"\n }\n ],\n \"postal_zip_code\": \"4051\",\n \"provence_state\": \"BS\",\n \"updated\": \"2018-04-06T22:49:28.0264717\"\n }\n ],\n \"bank\": \"\",\n \"bin_iin_number\": \"555555\",\n \"brand\": \"MASTERCARD\",\n \"card_token\": null,\n \"category\": null,\n \"country\": \"UNITED STATES\",\n \"country_code\": \"US\",\n \"created\": \"2018-01-22T01:54:37.6042602\",\n \"credit_card_id\": 4780,\n \"customer\": {\n \"addresses\": [\n {\n \"address_1\": \"Petersgasse 46A\",\n \"address_2\": \"\",\n \"city\": \"Basel\",\n \"country\": \"CH\",\n \"county_region\": null,\n \"created\": \"2018-01-22T01:47:00.3897632\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"organization\": \"\",\n \"phones\": [\n {\n \"created\": \"2018-01-22T01:47:00.3936499\",\n \"customer_address_phone_id\": 5317,\n \"number\": \"0041796673085\",\n \"text\": \"0041796673085\",\n \"type\": \"Phone\",\n \"updated\": \"2018-01-22T01:47:00.3942507\"\n }\n ],\n \"postal_zip_code\": \"4051\",\n \"provence_state\": \"BS\",\n \"updated\": \"2018-04-06T22:49:27.5933116\"\n }\n ],\n \"created\": \"2018-01-22T01:47:02.3558033\",\n \"customer_id\": 6778,\n \"email\": \"throm@yahoo.com\",\n \"first_name\": \"Alexander\",\n \"last_name\": \"Throm\",\n \"type\": \"Business\",\n \"updated\": \"2018-04-06T22:49:28.0265362\"\n },\n \"expiration_date\": \"2018-12-31T23:59:59\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"masked_card_number\": \"555555XXXXXX54444\",\n \"sub_brand\": \"\",\n \"track_1\": \"\",\n \"track_2\": \"\",\n \"type\": \"CREDIT\",\n \"updated\": \"2018-01-22T01:54:37.6654937\"\n },\n \"currency\": \"USD\",\n \"description\": \"\",\n \"device_type\": \"Unknown\",\n \"employeeNumber\": null,\n \"invoiceNumber\": \"45542\",\n \"ipAddress\": \"208.76.26.4\",\n \"line_items\": [],\n \"market_type\": \"Unknown\",\n \"paths\": [\n {\n \"destination_key\": 0,\n \"destination_name\": \"127.0.0.1\",\n \"from\": \"Site\",\n \"path_id\": 52881,\n \"reason\": \"Returned to requester.\",\n \"source_key\": 5,\n \"source_name\": \"Trading Company\",\n \"time_stamp\": \"2018-04-06T22:49:40.2969927\",\n \"to\": \"External\"\n },\n {\n \"destination_key\": 0,\n \"destination_name\": \"WorldPay\",\n \"from\": \"Gateway\",\n \"path_id\": 52882,\n \"reason\": \"Transaction was passed externally to 52.51.208.191 to be processed.\",\n \"source_key\": 61,\n \"source_name\": \"WorldPay Online (UK)\",\n \"time_stamp\": \"2018-04-06T22:49:36.4492612\",\n \"to\": \"External\"\n },\n {\n \"destination_key\": 61,\n \"destination_name\": \"WorldPay Online (UK)\",\n \"from\": \"Load Balancer\",\n \"path_id\": 52883,\n \"reason\": \"Transaction is valid for this connector and passed externally to WorldPayOnline for processing.\",\n \"source_key\": 27,\n \"source_name\": \"Trading Company - Overflow\",\n \"time_stamp\": \"2018-04-06T22:49:36.4492583\",\n \"to\": \"Gateway\"\n },\n {\n \"destination_key\": 30,\n \"destination_name\": \"Trading Company - Card Brand\",\n \"from\": \"Load Balancer\",\n \"path_id\": 52884,\n \"reason\": \"No Route rule was matched and transaction was passed to the Trading Company - Overflow Load Balancer Path by the Default Path.\",\n \"source_key\": 1,\n \"source_name\": \"Trading Company - Trickle\",\n \"time_stamp\": \"2018-04-06T22:49:33.8592039\",\n \"to\": \"Route\"\n },\n {\n \"destination_key\": 27,\n \"destination_name\": \"Trading Company - Overflow\",\n \"from\": \"Route\",\n \"path_id\": 52885,\n \"reason\": \"Transaction load balanced to WorldPay Online (UK) Gateway path making it a Ratio of 41/10000.\",\n \"source_key\": 30,\n \"source_name\": \"Trading Company - Card Brand\",\n \"time_stamp\": \"2018-04-06T22:49:36.4491279\",\n \"to\": \"Load Balancer\"\n },\n {\n \"destination_key\": 4,\n \"destination_name\": \"Trading Company - Validation\",\n \"from\": \"Site\",\n \"path_id\": 52886,\n \"reason\": \"Transaction passed all filter rules.\",\n \"source_key\": 5,\n \"source_name\": \"Trading Company\",\n \"time_stamp\": \"2018-04-06T22:49:31.1872197\",\n \"to\": \"Filter\"\n },\n {\n \"destination_key\": 5,\n \"destination_name\": \"Trading Company\",\n \"from\": \"External\",\n \"path_id\": 52887,\n \"reason\": \"Transaction authenticated and passed to the Trading Company - Validation Filter Path.\",\n \"source_key\": 0,\n \"source_name\": \"127.0.0.1\",\n \"time_stamp\": \"2018-04-06T22:49:30.5721489\",\n \"to\": \"Site\"\n },\n {\n \"destination_key\": 1,\n \"destination_name\": \"Trading Company - Trickle\",\n \"from\": \"Filter\",\n \"path_id\": 52888,\n \"reason\": \"Transaction load balanced to Trading Company - Card Brand Router path making it a Ratio of 3/4.\",\n \"source_key\": 4,\n \"source_name\": \"Trading Company - Validation\",\n \"time_stamp\": \"2018-04-06T22:49:33.4790697\",\n \"to\": \"Load Balancer\"\n }\n ],\n \"transaction_id\": \"7adbe250-b155-4f45-9c73-5852d20070ab\",\n \"po_number\": null,\n \"processing_system\": null,\n \"recurring\": null,\n \"results\": [\n {\n \"method\": \"Multiple\",\n \"response\": \"Information\",\n \"result_id\": 19812,\n \"result_type\": \"Gateway\",\n \"specific\": \"WorldPayRequest\",\n \"value\": \"{\\\"name\\\":\\\"Alexander Throm\\\",\\\"billingAddress\\\":{\\\"address1\\\":\\\"Petersgasse 46A\\\",\\\"address2\\\":\\\"\\\",\\\"address3\\\":null,\\\"postalCode\\\":\\\"4051\\\",\\\"city\\\":\\\"Basel\\\",\\\"state\\\":\\\"BS\\\",\\\"countryCode\\\":\\\"CH\\\",\\\"telephoneNumber\\\":\\\"0041796673085\\\"},\\\"deliveryAddress\\\":{\\\"firstName\\\":\\\"Alexander\\\",\\\"lastName\\\":\\\"Throm\\\",\\\"address1\\\":\\\"Petersgasse 46A\\\",\\\"address2\\\":\\\"\\\",\\\"address3\\\":null,\\\"postalCode\\\":\\\"4051\\\",\\\"city\\\":\\\"Basel\\\",\\\"state\\\":\\\"BS\\\",\\\"countryCode\\\":\\\"CH\\\",\\\"telephoneNumber\\\":\\\"0041796673085\\\"},\\\"customerIdentifiers\\\":null,\\\"customerOrderCode\\\":\\\"45542\\\",\\\"orderCodeSuffix\\\":null,\\\"orderCodePrefix\\\":null,\\\"shopperLanguageCode\\\":null,\\\"reusable\\\":false,\\\"paymentMethod\\\":{\\\"cardNumber\\\":\\\"XXXXXXXXXXXX4444\\\",\\\"cvc\\\":\\\"321\\\",\\\"name\\\":\\\"Alexander Throm\\\",\\\"expiryMonth\\\":12,\\\"expiryYear\\\":2018,\\\"issueNumber\\\":null,\\\"startMonth\\\":null,\\\"startYear\\\":null,\\\"type\\\":\\\"Card\\\"},\\\"orderType\\\":\\\"ECOM\\\",\\\"threeDSecureInfo\\\":{\\\"shopperIpAddress\\\":null,\\\"shopperSessionId\\\":null,\\\"shopperAcceptHeader\\\":null,\\\"shopperUserAgent\\\":null},\\\"shopperIpAddress\\\":null,\\\"shopperSessionId\\\":null,\\\"shopperUserAgent\\\":null,\\\"shopperAcceptHeader\\\":null,\\\"authoriseOnly\\\":false,\\\"is3DSOrder\\\":false,\\\"successUrl\\\":null,\\\"failureUrl\\\":null,\\\"cancelUrl\\\":null,\\\"pendingUrl\\\":null,\\\"shopperEmailAddress\\\":\\\"throm@yahoo.com\\\",\\\"statementNarrative\\\":null,\\\"token\\\":null,\\\"orderDescription\\\":\\\"Product purchase by credit card\\\",\\\"amount\\\":99700,\\\"currencyCode\\\":\\\"USD\\\",\\\"settlementCurrency\\\":null,\\\"siteCode\\\":null,\\\"authorizeOnly\\\":false,\\\"authorizedAmount\\\":99700}\",\n \"variety\": \"NotApplicable\"\n },\n {\n \"method\": \"CreditCard\",\n \"response\": \"Approved\",\n \"result_id\": 19813,\n \"result_type\": \"Transaction\",\n \"specific\": \"Approved\",\n \"value\": null,\n \"variety\": \"Soft\"\n },\n {\n \"method\": \"CreditCard\",\n \"response\": \"Approved\",\n \"result_id\": 19814,\n \"result_type\": \"SecurityCode\",\n \"specific\": \"Match\",\n \"value\": \"APPROVED\",\n \"variety\": \"Soft\"\n },\n {\n \"method\": \"CreditCard\",\n \"response\": \"Approved\",\n \"result_id\": 19815,\n \"result_type\": \"Address\",\n \"specific\": \"FullPostalCodeMatch\",\n \"value\": \"APPROVED\",\n \"variety\": \"Soft\"\n },\n {\n \"method\": \"Multiple\",\n \"response\": \"Information\",\n \"result_id\": 19816,\n \"result_type\": \"Gateway\",\n \"specific\": \"WorldPayResponse\",\n \"value\": \"{\\\"orderCode\\\":\\\"7adbe250-b155-4f45-9c73-5852d20070ab\\\",\\\"paymentStatus\\\":0,\\\"paymentStatusReason\\\":null,\\\"paymentResponse\\\":{\\\"cardType\\\":\\\"MASTERCARD_CREDIT\\\",\\\"maskedCardNumber\\\":\\\"**** **** **** 4444\\\",\\\"billingAddress\\\":{\\\"address1\\\":\\\"Petersgasse 46A\\\",\\\"address2\\\":null,\\\"address3\\\":null,\\\"postalCode\\\":\\\"4051\\\",\\\"city\\\":\\\"Basel\\\",\\\"state\\\":\\\"BS\\\",\\\"countryCode\\\":\\\"CH\\\",\\\"telephoneNumber\\\":\\\"0041796673085\\\"},\\\"apmFields\\\":null,\\\"name\\\":\\\"Alexander Throm\\\",\\\"expiryMonth\\\":12,\\\"expiryYear\\\":2018,\\\"issueNumber\\\":null,\\\"startMonth\\\":null,\\\"startYear\\\":null,\\\"type\\\":\\\"ObfuscatedCard\\\"},\\\"customerOrderCode\\\":\\\"45542\\\",\\\"is3DSOrder\\\":false,\\\"oneTime3DsToken\\\":null,\\\"redirectURL\\\":null,\\\"customerIdentifiers\\\":null,\\\"environment\\\":0,\\\"shopperEmailAddress\\\":\\\"throm@yahoo.com\\\",\\\"deliveryAddress\\\":{\\\"firstName\\\":\\\"Alexander\\\",\\\"lastName\\\":\\\"Throm\\\",\\\"address1\\\":\\\"Petersgasse 46A\\\",\\\"address2\\\":null,\\\"address3\\\":null,\\\"postalCode\\\":\\\"4051\\\",\\\"city\\\":\\\"Basel\\\",\\\"state\\\":\\\"BS\\\",\\\"countryCode\\\":\\\"CH\\\",\\\"telephoneNumber\\\":\\\"0041796673085\\\"},\\\"statementNarrative\\\":null,\\\"riskScore\\\":{\\\"value\\\":\\\"1\\\"},\\\"resultCodes\\\":{\\\"avsResultCode\\\":\\\"APPROVED\\\",\\\"cvcResultCode\\\":\\\"APPROVED\\\"},\\\"token\\\":\\\"TEST_SU_2acdf1f4-67f9-46e3-be17-e58a69633a4d\\\",\\\"orderDescription\\\":\\\"Product purchase by credit card\\\",\\\"amount\\\":99700,\\\"currencyCode\\\":\\\"USD\\\",\\\"settlementCurrency\\\":null,\\\"siteCode\\\":null,\\\"authorizeOnly\\\":false,\\\"authoriseOnly\\\":false,\\\"authorizedAmount\\\":null}\",\n \"variety\": \"NotApplicable\"\n }\n ],\n \"tax_exempt\": false,\n \"total\": 997,\n \"open_path_id\": 10277,\n \"type\": \"Sale\"\n }\n }\n}"}],"_postman_id":"e4659322-584f-429a-9500-cd05729111f6"},{"name":"Create Alert","event":[{"listen":"test","script":{"id":"851f6ad0-cd06-46d0-86a3-7d4d78a3e339","type":"text/javascript","exec":["tests['Midigator-Post-Chargeback'] = responseBody.has('\"name\":\"Midigator-Post-Chargeback\"');","tests[responseBody] = true;",""]}}],"id":"9b37a38f-db14-4319-b21b-9b92e6f79fcf","request":{"method":"POST","header":[{"key":"Authorization","value":"{{API-Key}}"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"id\": \"2352SETRE3435ERT\",\r\n \"alert_id\": \"0RWRIKQLNE4GBGIE2FWH1V4J1\",\r\n \"order_id\": \"45542\",\r\n \"arn\": \"52236076286816009657108\",\r\n \"mid\": \"987654321987\",\r\n \"merchant_descriptor\": \"ACME Digital UK MID\",\r\n \"source_partner\": \"ethoca\",\r\n \"amount\": 997.00,\r\n \"currency\": \"USD\",\r\n \"bin\" : \"555555\",\r\n \"last_four\": \"4444\",\r\n \"date_received\": \"2017-06-28 09:20:11\",\r\n \"transaction_date\": \"2018-04-06 22:49:24\"\r\n}"},"url":"{{URL}}/v3/partners/midigator/alert","description":"

Description

The Midigator Alert endpoint accepts alerts from Midigator generated by Ethica or Verifi and finds the associated transaction. Once the transaction has been found a refund will be processed and the transaction will be created and the events defined in the Midigator Integration will be fired.

Request Body Item

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

Key	Description
Order ID	The order id generated by the Point of Sale or CRM.
Case Number	The chargeback case number from the processor.
ARN	The Acquirer Reference Number.
Card Number	The first 6 numbers of the credit card (aka BIN) followed by to asterisks '' and the last 4 numbers (format: xxxxxxxxxx)
Card Type	The brand of the credit card (e.g. visa, mastercard).
Amount	The total amount of the transaction.
Reason Code	The chargeback reason code.
Reason	The chargeback reason message.
Date Received	The date the chargeback was received.

Packet Item

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

Key	Description
IP Address	The IP Address the transaction was received from, this is typically the Point of Sale or CRM and is not the credit card holders IP Address.
Packet ID	The unique ID of this transaction packet.
Responded	The UTC time the transaction was returned to the Point of Sale or Transaction.
Transaction	[See Transaction Item]

Transaction Item

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

Key	Description
Approved	Represents the response from the processor (Processing, Declined, Approved, Rejected, Error, Queued, Pending).
Attributes	An array of attributes [See Attribute Item].
Authorization Code	The autorization code returned from the processor.
Credit Card	[See Credit Card Item].
Currency	The country currency code (ISO 4217).
Description	The description of the transaction.
Device Type	The type of device the transaction was performed on (Unknown, UnattendedTerminal, SelfServiceTerminal, ElectronicCashRegister, AirPay, WirelessPOS, Website, DialTerminal, VirtualTerminal).
Employee Number	The employee number that took the credit card transaction.
Order Number	The order number generated from the Point of Sale or CRM.
IP Address	The IP address where the transaction originated from, typically the customer or if card present the terminal the card was swiped on.
Line Items	An array of the items purchased [See Line Item Item].
Market Type	The sale market type (Unknown, Retail, ECommerce, MailOrder, Telephone, MailOrderTelephone).
Paths	An array of the OpenPath paths that the packet went through before being passed on to the processor.
Transaction ID	The transaction ID returned from the Processor.
PO Number	The PO Number from the Point of Sale or CRM.
Processing System	The name of the processing system.
Recurring	[See Recurring Item]
Results	[See Results]
Tax Excempt	Was this order tax exempt?
Total	The total amount billed to the transaction.
OpenPath ID	The unique OpenPath ID assigned to this transaction.
Type	The type of credit card transaction this was (Sale, Authorization, Capture, Void, Refund, Credit, Chargeback, Validate, Offline, Cancel, Update).

Attribute Item

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

Key	Description
Attribute ID	The unique Attribute ID.
Key	The Key name that represents the value.
Value	The value of the key.

Credit Card Item

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

Key	Description
Addresses	An array of known addresses associated to this credit card [See Address Item].
Bank	The name of the issue bank of the credit card.
BIN IIN Number	The first 6 digits of the credit card number.
Brand	The brand of the credit card (e.g. Visa, Master Card).
Card Token	A unique token associated with this credit card.
Category	The category this credit card belongs to (e.g. Platnum, Signature, Business)
Country	The name of the country of origin for this credit card.
Country Code	The country code associated to this credit card.
Created	When this credit card was first added to the OpenPath system.
Credit Card ID	A unique ID representing this credit card in the OpenPath system.
Customer	[See Customer Item]
Expiration Date	The expiration date of this credit card.
Latitude	The latitude of the issuing bank.
Longitude	The longitude of the issuing bank.
Masked Card Number	A masked representation of this credit card (format: xxxx-xx-**-xxxx)
Sub-Brand	The sub-brand associated with the band if one is associated.
Track 1	The information contained on the first track of the magnetic strip.
Track 2	The information contained on the second track of the magnetic strip.
Type	The type of credit card this is (e.g. Credit, Debit, Gift Card).
Updated	The last time this credit card was updated by OpenPath.

Line Item Item

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

Key	Description
Line Item Id	OpenPaths Unique ID for this Line Item.
SKU	SKU of the item being purchased.
Name	Name of the product.
Description	Description of the product.
Quantity	Total order number for this product.
Total	The total cost of the product.
Tax	The tax on this product.
Tax Rate	The tax rate applied to this product.
Commodity Code	International description code of the individual good or service being supplied. The acquirer or processor will provide a list of current codes.
Unit of Measure	The unit used to measure this time (e.g. Pounds, Hours, Litters).
Unit of Cost	The cost per unit of measure.
Tax Name	The name of the tax applied.
Tax Description	A description of the the tax being applied.
Duty	The duty that may be applied to this item.
Discount	Any discount applied to this item.
Duty Name	The name of the duty being applied to this item.
Shipping	Shipping cost for this item.
Ship from Zip	Shipping from what Postal or Zipcode.
Shipping Name	Name of the shipping method.
Shipping Description	Description of the shipping method.

Path Item

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

Key	Description
To	The destination path type (e.g. Site, Filter, Route, Load Balancer, Queue, Connector).
Destination Key	The unique key of the next destination path for a transaction packet.
Destination Name	The name of of this destination path.
Path ID	The unique ID of this logged path.
Reason	The reason for choosing this next path.
From	The source path type (e.g. Site, Filter, Route, Load Balancer, Queue, Connector).
Source Key	The unique key of the source path for a transaction packet.
Source Name	The name of of the source path.
Timestamp	The timestamp when the packet was processed by this path.

Recurring Item

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

Key	Description
Recurring ID	The unique ID of this recurring item.
Recurring Type	Where the recurring charges are triggered from (AtGateway, AtCRM, AtGateway).
Initial	Was this the inital payment?
Payments	How many payment are scheduled.
Amount	The amount of the recurring payment.
Frequency Unit	The unit of frequency the recurring payment is made (Days, Months, Years).
Frequency	The frequency of the recurring payments.
Billing Day	The billilng day.
Start Date	Start the recurring billing on this date.
Source ID	The ID of the source of this recurring billing.

Result Item

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

Key	Description
Method	The payment method used for this transaction (e.g. CreditCard, AutomatedClearingHouse, Check, Paypal, MobilePay, Bitcoin, Ticket).
Response	The response type of this payment method (Approved, Declined, Rejected, Error, Pending, Information).
Result ID	The unique ID of this result.
Result Type	What was this response generated from (e.g. Transaction, Address, SecurityCode, Gateway, Procesor, Response, Information, Checkback).
Specific	The exact specific response details.
Value	The un-translated response from the system returning the response.
Variety	What type of response this was (e.g. Soft, Action, Hard, NotApplicable).

Address Item

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

Key	Description
Address 1	The street Address
Address 2	Additional address information
City	The city.
Country	The country.
County Region	The county or region depanding on the county.
Latitude	The latitude of the of the address.
Longitude	The longitude of the address.
Phones	An array of phone numbers associated to this address [See Phone Item].
Postal Zip Code	The postal or zipcode of the address.
Provence State	The provence or state of the address.
Updated	The last time this address was updated.

Customer Item

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

Key	Description
Addresses	An array of addresses associated with this customer [See Address Item].
Created	The date this customer was added.
Customer ID	The unique customer ID associated to this customer.
Email	The customers primary email address.
First Name	The customers first name.
Last Name	The customers last name.
Type	The type of customer this is (e.g. Business, Individual).
Updated	The last time this customers information was updated.

Phone Item

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

Key	Description
Created	The date this phone number was created.
Number	The numerical referrence to this number with no extra characters.
Text	The phone number as originally entered.
Type	The type of phone number this is (e.g. Fax, Cell, LandLine)
Updated	The last time this phone number was updated.

","urlObject":{"path":["v3","partners","midigator","alert"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"d6e64ae9-9623-4cee-ba34-10027360d17f","name":"Create Alert","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{API-Key}}","disabled":false},{"key":"Accept","value":"application/json","disabled":false},{"key":"Content-Type","value":"application/json","disabled":false}],"body":{"mode":"raw","raw":"{\r\n \"id\": \"2352SETRE3435ERT\",\r\n \"alert_id\": \"0RWRIKQLNE4GBGIE2FWH1V4J1\",\r\n \"order_id\": \"45542\",\r\n \"arn\": \"52236076286816009657108\",\r\n \"mid\": \"987654321987\",\r\n \"merchant_descriptor\": \"ACME Digital UK MID\",\r\n \"source_partner\": \"ethoca\",\r\n \"amount\": 997.00,\r\n \"currency\": \"USD\",\r\n \"bin\" : \"555555\",\r\n \"last_four\": \"4444\",\r\n \"date_received\": \"2017-06-28 09:20:11\",\r\n \"transaction_date\": \"2018-04-06 22:49:24\"\r\n}"},"url":"{{URL}}/v3/partners/midigator/alert"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Tue, 22 May 2018 21:38:02 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Kestrel","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcVXNlcnNcSmFzb24gTWFydGluXHNvdXJjZVxyZXBvc1xvcGVuLnBhdGhcQXBpXEFwaS5BcHBsaWNhdGlvblx2M1xwYXJ0bmVyc1xtaWRpZ2F0b3JcYWxlcnQ=?=","name":"X-SourceFiles","description":"Custom header"}],"cookie":[],"responseTime":null,"body":"{\n \"name\": \"Midigator-Post-Alert\",\n \"description\": \"Finds the transaction from the posted alert information and informs the system to trigger the associated events.\",\n \"result\": {\n \"ip_address\": \"127.0.0.1\",\n \"packet_id\": 10251,\n \"responded\": \"0001-01-01T00:00:00\",\n \"transaction\": {\n \"approved\": \"Error\",\n \"attributes\": [],\n \"authorization_code\": null,\n \"credit_card\": {\n \"addresses\": [\n {\n \"address_1\": \"Petersgasse 46A\",\n \"address_2\": \"\",\n \"city\": \"Basel\",\n \"country\": \"CH\",\n \"county_region\": null,\n \"created\": \"2018-01-22T01:54:38.0937865\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"organization\": \"\",\n \"phones\": [\n {\n \"created\": \"2018-01-22T01:54:38.0937955\",\n \"credit_card_address_phone_id\": 5394,\n \"number\": \"0041796673085\",\n \"text\": \"0041796673085\",\n \"type\": \"Phone\",\n \"updated\": \"2018-01-22T01:54:38.0937964\"\n },\n {\n \"created\": \"2018-03-30T01:21:54.4521123\",\n \"credit_card_address_phone_id\": 5459,\n \"number\": \"0041796673085\",\n \"text\": \"0041796673085\",\n \"type\": \"Phone\",\n \"updated\": \"2018-03-30T01:21:54.4521128\"\n },\n {\n \"created\": \"2018-04-06T22:49:28.0264688\",\n \"credit_card_address_phone_id\": 5493,\n \"number\": \"0041796673085\",\n \"text\": \"0041796673085\",\n \"type\": \"Phone\",\n \"updated\": \"2018-04-06T22:49:28.0264693\"\n }\n ],\n \"postal_zip_code\": \"4051\",\n \"provence_state\": \"BS\",\n \"updated\": \"2018-04-06T22:49:28.0264717\"\n }\n ],\n \"bank\": \"\",\n \"bin_iin_number\": \"555555\",\n \"brand\": \"MASTERCARD\",\n \"card_token\": null,\n \"category\": null,\n \"country\": \"UNITED STATES\",\n \"country_code\": \"US\",\n \"created\": \"2018-01-22T01:54:37.6042602\",\n \"credit_card_id\": 4780,\n \"customer\": {\n \"addresses\": [\n {\n \"address_1\": \"Petersgasse 46A\",\n \"address_2\": \"\",\n \"city\": \"Basel\",\n \"country\": \"CH\",\n \"county_region\": null,\n \"created\": \"2018-01-22T01:47:00.3897632\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"organization\": \"\",\n \"phones\": [\n {\n \"created\": \"2018-01-22T01:47:00.3936499\",\n \"customer_address_phone_id\": 5317,\n \"number\": \"0041796673085\",\n \"text\": \"0041796673085\",\n \"type\": \"Phone\",\n \"updated\": \"2018-01-22T01:47:00.3942507\"\n }\n ],\n \"postal_zip_code\": \"4051\",\n \"provence_state\": \"BS\",\n \"updated\": \"2018-04-06T22:49:27.5933116\"\n }\n ],\n \"created\": \"2018-01-22T01:47:02.3558033\",\n \"customer_id\": 6778,\n \"email\": \"throm@yahoo.com\",\n \"first_name\": \"Alexander\",\n \"last_name\": \"Throm\",\n \"type\": \"Business\",\n \"updated\": \"2018-04-06T22:49:28.0265362\"\n },\n \"expiration_date\": \"2018-12-31T23:59:59\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"masked_card_number\": \"555555XXXXXX54444\",\n \"sub_brand\": \"\",\n \"track_1\": \"\",\n \"track_2\": \"\",\n \"type\": \"CREDIT\",\n \"updated\": \"2018-01-22T01:54:37.6654937\"\n },\n \"currency\": \"USD\",\n \"description\": \"\",\n \"device_type\": \"Unknown\",\n \"employeeNumber\": null,\n \"invoiceNumber\": \"45542\",\n \"ipAddress\": \"208.76.26.4\",\n \"line_items\": [],\n \"market_type\": \"Unknown\",\n \"paths\": [\n {\n \"destination_key\": 61,\n \"destination_name\": \"WorldPay Online (UK)\",\n \"from\": \"External\",\n \"path_id\": 53094,\n \"reason\": \"Transaction is valid for this connector and passed externally to WorldPayOnline for processing.\",\n \"source_key\": 0,\n \"source_name\": \"Midigator Incoming\",\n \"time_stamp\": \"2018-05-22T21:37:44.8305607\",\n \"to\": \"Gateway\"\n },\n {\n \"destination_key\": 0,\n \"destination_name\": \"WorldPay\",\n \"from\": \"Gateway\",\n \"path_id\": 53095,\n \"reason\": \"Transaction was passed externally to 52.51.208.191 to be processed.\",\n \"source_key\": 61,\n \"source_name\": \"WorldPay Online (UK)\",\n \"time_stamp\": \"2018-05-22T21:37:44.8332443\",\n \"to\": \"External\"\n }\n ],\n \"transaction_id\": \"7adbe250-b155-4f45-9c73-5852d20070ab\",\n \"po_number\": null,\n \"processing_system\": null,\n \"recurring\": null,\n \"results\": [\n {\n \"method\": \"CreditCard\",\n \"response\": \"Error\",\n \"result_id\": 19917,\n \"result_type\": \"Transaction\",\n \"specific\": \"Unknown\",\n \"value\": \"Some of request parameters are invalid, please check your request. For more information please refer to Json schema.\",\n \"variety\": \"Action\"\n },\n {\n \"method\": \"Multiple\",\n \"response\": \"Information\",\n \"result_id\": 19918,\n \"result_type\": \"Gateway\",\n \"specific\": \"WorldPayRequest\",\n \"value\": \"https://api.worldpay.com/v1/orders/7adbe250-b155-4f45-9c73-5852d20070ab/refund\",\n \"variety\": \"NotApplicable\"\n },\n {\n \"method\": \"Multiple\",\n \"response\": \"Information\",\n \"result_id\": 19919,\n \"result_type\": \"Gateway\",\n \"specific\": \"WorldPayResponse\",\n \"value\": \"{\\\"httpStatusCode\\\":400,\\\"customCode\\\":\\\"BAD_REQUEST\\\",\\\"message\\\":\\\"TEST Order: 7adbe250-b155-4f45-9c73-5852d20070ab cannot be refunded while in status: REFUNDED - try again later.\\\",\\\"description\\\":\\\"Some of request parameters are invalid, please check your request. For more information please refer to Json schema.\\\",\\\"errorHelpUrl\\\":null,\\\"originalRequest\\\":\\\"{'refundAmount':99700}\\\"}\",\n \"variety\": \"NotApplicable\"\n }\n ],\n \"tax_exempt\": false,\n \"total\": 997,\n \"open_path_id\": 10318,\n \"type\": \"Refund\"\n }\n }\n}"}],"_postman_id":"9b37a38f-db14-4319-b21b-9b92e6f79fcf"}],"id":"b5c3136d-0fed-417d-ac95-473359276e18","description":"

What is Midigator?

Midigator is a chargeback and fraud technology platform that mitigates risk and recovers lost revenue. It provides real-time merchant account monitoring and fights chargebacks to win revenue back. Its comprehensive, user-friendly analytics enables businesses to take preemptive action against chargebacks and keep their merchant accounts healthy and profitable. Midigator's unparalleled reporting and patented management technology saves valuable time, allowing companies big and small to focus on what's important: growing their business.

Description

The Midigator endpoints are specifically designed for receiving data directly from your Midigator Account. These endpoints will only accept API Keys that are in the partner role, but can be used for other purposes as well.

\n
MIDIGATOR PARTNER URL https://api-saas.openpath.io/v1/partners/midigator
\n

\n","event":[{"listen":"prerequest","script":{"id":"ea88ca90-ec3f-4e81-8647-f6c5eb4c20cd","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7f2bc523-b527-4cde-b936-73236639369e","type":"text/javascript","exec":[""]}}],"_postman_id":"b5c3136d-0fed-417d-ac95-473359276e18"}],"event":[{"listen":"prerequest","script":{"id":"59707503-e339-401f-bef7-25e5a7eba403","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"19ca4125-b5ba-4648-9494-8b5a3fc7ae8a","type":"text/javascript","exec":[""]}}]}