{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"480e2bab-1acd-d320-06b0-4ad453001414","name":"SplitIt API","description":"<h2>Welcome</h2>\r\n<p>Welcome to Splitit API reference, this document details the supported services and the parameters required to be sent to each of our services.</p>\r\n<p>Before starting to use this document, it is recommended to read our <a href=\"https://www.splitit.com/for-developers/\">solution overview</a>&nbsp;in order to choose the best solution for your needs.</p>\r\n<p>&nbsp;</p>\r\n<h2>Prerequisite &nbsp;</h2>\r\n<p>&nbsp;</p>\r\n<p>In order to start working you will need the following credentials:</p>\r\n<ul>\r\n<li>UserName -&nbsp;The username of your API user in Splitit system</li>\r\n<li>Password -&nbsp;The password&nbsp;of your API user in Splitit system</li>\r\n<li>ApiKey - Your terminal API key</li>\r\n</ul>\r\n<p>You can receive the credentials from your Splitit onboarding contact. please don't hesitate and shoot us an email at&nbsp;<a href=\"mailto:onboarding@splitit.com\">onboarding@splitit.com</a></p>\r\n<p>&nbsp;</p>\r\n<h2>Sandbox and Production&nbsp;<strong>environments</strong></h2>\r\n<p>Development should be done on our sandbox environment, once&nbsp;development completed,&nbsp;please contact your onboarding reference for approval and credentials to the production&nbsp;environment</p>\r\n<ul>\r\n<li>Sandbox:\r\n<ul>\r\n<li>URL -&nbsp;<a href=\"https://web-api-sandbox.splitit.com\">https://web-api-sandbox.splitit.com</a></li>\r\n<li>Test Cards (any other card will result an error \"Unrecognized card\" ) :\r\n<ul>\r\n<li>Visa:&nbsp;4111 1111 1111 1111</li>\r\n<li>Master Card:&nbsp;5555 5555 5555 4444</li>\r\n</ul>\r\n</li>\r\n</ul>\r\n</li>\r\n<li>Production\r\n<ul>\r\n<li>URL -&nbsp;&nbsp;<a href=\"https://web-api.splitit.com\">https://web-api.splitit.com</a></li>\r\n</ul>\r\n</li>\r\n</ul>\r\n<p>&nbsp;</p>\r\n<h2>API Reference content</h2>\r\n<p>Each service contains the&nbsp;following details:</p>\r\n<ol>\r\n<li>Service rout&nbsp;</li>\r\n<li>General description of the service&nbsp;</li>\r\n<li>Detailed request parameters description</li>\r\n<li>Detailed response parameters&nbsp;description</li>\r\n<li>Data required to be sent in the request header&nbsp;</li>\r\n<li><strong>Example for Json data body</strong> required to be sent in&nbsp;body</li>\r\n<li>Code Example (choose your preferred language on the selection list located in the right bar)</li>\r\n</ol>\r\n<h2>&nbsp;</h2>\r\n<h2>Common overview (for all Requests and Responses)</h2>\r\n<h4>General&nbsp;</h4>\r\n<p>Our services are implemented as simple and standard HTTP POST requests with single header parameter (Content-Type = application/json) and Json body with specific schema for each request.</p>\r\n<p>&nbsp;</p>\r\n<h4>Request</h4>\r\n<p>Each&nbsp;request body (other than login) must contain element called RequestHeader which contain the following&nbsp;parameters:</p>\r\n<ul>\r\n<li>SessionId - the session received by the login request (see request below)</li>\r\n<li>ApiKey&nbsp;- the terminal api key received by your Splitit onboarding contact.</li>\r\n</ul>\r\n<p>&nbsp;</p>\r\n<p>&nbsp;</p>\r\n<h4>Response</h4>\r\n<p>Each response contain element called ResponseHeader which contain the following&nbsp;parameters:</p>\r\n<ul>\r\n<li>Succeeded&nbsp;-&nbsp;boolean parameter indicating if the request succeeded or failed (true - succeeded, false-failed).<br /><br /></li>\r\n<li>Errors - Array of errors, populated whenever response failed (succeeded=false) , each element in the errors contain error code and error description, error description can be displayed to users. <br /><span style=\"text-decoration: underline;\"><strong>Remark</strong></span> - on current version, only first element in error collection is populated. &nbsp;</li>\r\n</ul>\r\n<p>&nbsp;</p>\r\n<p><span style=\"text-decoration: underline;\"><strong>Important:</strong></span>&nbsp;Each response must be verified it succeeded as following:</p>\r\n<p>1) HTTP Status code = 200 -&nbsp;indicating there was no network or infrastructure error</p>\r\n<p>2) ResponseHeader.Succeeded=true - applicative check indicating&nbsp;all business validation succeeded and the operation done successfully.&nbsp;</p>\r\n<p>&nbsp;</p>\r\n<p>&nbsp;</p>\r\n<p><span style=\"text-decoration: underline;\"><strong>********************End of introduction:********************</strong></span></p>\r\n<p><span style=\"text-decoration: underline;\"><strong>Please refer to your specific request after choosing your solution from our&nbsp;<a href=\"https://www.splitit.com/for-developers/\">SDK documentation</a></strong></span></p>\r\n<p>&nbsp;</p>\r\n<hr /><hr />\r\n<p>&nbsp;</p>\r\n<p>&nbsp;</p>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"795699","team":17013,"collectionId":"480e2bab-1acd-d320-06b0-4ad453001414","publishedId":"2Qpqqj","public":true,"publicUrl":"https://documenter-api.postman.tech/view/795699/2Qpqqj","privateUrl":"https://go.postman.co/documentation/795699-480e2bab-1acd-d320-06b0-4ad453001414","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"e542f4"},"documentationLayout":"classic-double-column","version":"8.10.0","publishDate":"2016-12-07T09:52:32.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/e43c269eb4006cd4fbf2327ac8319dfecfc6a8b505ab09eab3d686f75054dfa7","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2Qpqqj"}