{"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.

Test Environment Details

Base URL: https://api.preciseai.ai/test
\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
Batch IDs for Testing:
\n
- Completed Batch: 8cda5023-fef6-4164-990b-cf4981732666
  \n
- Processing Batch: ed08b37d-36e7-4512-8fd2-4e6eaf023471
  \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.

Example API Requests

1. Submit a New Batch

curl -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

2. Check Batch Status

curl -X GET 'https://api.preciseai.ai/test/batches/8cda5023-fef6-4164-990b-cf4981732666/status' \\\n-H \"X-API-KEY: {api_key}\"\n\n

3. Retrieve Batch Results (JSON)

curl -X GET 'https://api.preciseai.ai/test/batches/8cda5023-fef6-4164-990b-cf4981732666/result/json' \\\n-H \"X-API-KEY: {api_key}\"\n\n

4. Retrieve Batch Results (CSV on S3)

curl -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","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Test Environment Details","slug":"test-environment-details"},{"content":"Example API Requests","slug":"example-api-requests"}],"owner":"39791068","collectionId":"e24ac6d8-5fcf-4f16-8867-b2c020651a21","publishedId":"2sAYBPmZz7","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"142cb5"},"publishDate":"2024-11-18T05:46:27.000Z"},"item":[]}