{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"e24ac6d8-5fcf-4f16-8867-b2c020651a21","name":"Onboarding Test Environment","description":"- The PreciseAI MCC Classification API enables efficient, automated classification of Merchant Category Codes (MCC) for batch submissions. This documentation provides a quick guide for using the test/sandbox environment. Full API documentation is available [here](https://docs.api.preciseai.ai).\n    \n\n# Test Environment Details\n\n- **Base URL**: `https://api.preciseai.ai/test`\n    \n- **Authentication**: Use the `X-API-KEY` header in each request with the provided API key. A client ID will also be included in the API URL path.\n    \n- **Batch IDs for Testing**:\n    \n    - **Completed Batch**: `8cda5023-fef6-4164-990b-cf4981732666`\n        \n    - **Processing Batch**: `ed08b37d-36e7-4512-8fd2-4e6eaf023471`\n        \n\n**Note**: The test environment provides mock responses, simulating the behavior of the production API without actual processing. A unique client ID, API key, and OAuth 2.0 credentials will be provided before transitioning to production.\n\n---\n\n# Example API Requests\n\n## 1\\. Submit a New Batch\n\n``` bash\ncurl -X POST https://api.preciseai.ai/test/submitBatch \\\n  -H \"Content-Type: application/json\" \\\n  -H \"X-API-KEY: {api_key}\" \\\n  -d '{\n    \"clientBatchMetadata\": {\n      \"batchName\": \"Batch for November 1\",\n      \"description\": \"Monthly batch submission\"\n    },\n    \"webhookUrl\": \"http://www.example.com/webhook-endpoint\",\n    \"merchants\": [\n      {\n        \"merchantId\": \"m001\",\n        \"url\": \"http://www.cafeunique.com\",\n        \"dba\": \"Cafe Unique\",\n        \"legalName\": \"Cafe Unique Ltd\",\n        \"mcc\": \"5812\",\n        \"address\": \"5 Sunset Blvd\",\n        \"city\": \"Cape Town\",\n        \"region\": \"Western Cape\",\n        \"country\": \"ZA\",\n        \"postalCode\": \"8001\",\n        \"phoneNumber\": \"+27 21 123 4567\",\n        \"emailAddress\": \"info@cafeunique.com\",\n        \"eCommercePlatform\": \"WooCommerce\"\n      }\n    ]\n  }'\n\n ```\n\n## 2\\. Check Batch Status\n\n``` bash\ncurl -X GET 'https://api.preciseai.ai/test/batches/8cda5023-fef6-4164-990b-cf4981732666/status' \\\n-H \"X-API-KEY: {api_key}\"\n\n ```\n\n## 3\\. Retrieve Batch Results (JSON)\n\n``` bash\ncurl -X GET 'https://api.preciseai.ai/test/batches/8cda5023-fef6-4164-990b-cf4981732666/result/json' \\\n-H \"X-API-KEY: {api_key}\"\n\n ```\n\n## 4\\. Retrieve Batch Results (CSV on S3)\n\n``` bash\ncurl -X GET 'https://api.preciseai.ai/test/batches/8cda5023-fef6-4164-990b-cf4981732666/result/storage' \\\n-H \"X-API-KEY: {api_key}\"\n\n ```\n\n---","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"39791068","team":6556200,"collectionId":"e24ac6d8-5fcf-4f16-8867-b2c020651a21","publishedId":"2sAYBPmZz7","public":true,"publicUrl":"https://sandbox.docs.preciseai.ai","privateUrl":"https://go.postman.co/documentation/39791068-e24ac6d8-5fcf-4f16-8867-b2c020651a21","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"142cb5"},"documentationLayout":"classic-single-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/33e3232f-11a0-4b93-8b11-3d233235ecb4/UHJlY2lzZS5wbmc=","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"99cbff"}},{"name":"light","logo":"https://content.pstmn.io/44240abc-45c1-422d-8c93-2ff0b5f0a483/UHJlY2lzZS5wbmc=","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"142cb5"}}]}},"version":"8.11.11","publishDate":"2024-11-18T05:46:27.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/44240abc-45c1-422d-8c93-2ff0b5f0a483/UHJlY2lzZS5wbmc=","logoDark":"https://content.pstmn.io/33e3232f-11a0-4b93-8b11-3d233235ecb4/UHJlY2lzZS5wbmc="}},"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/606df882a165ecb8e835b119d7f860c20b9504bca00478d005283ee8d36d53b7","favicon":"https://res.cloudinary.com/postman/image/upload/v1731899459/team/b530649b91bcf0f38a2e1c7ba1f5f11b.ico"},"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://sandbox.docs.preciseai.ai/view/metadata/2sAYBPmZz7"}