Ordering and Setting Up Equipment

The 'Equipment Ordering' API facilitates the submission of completed equipment surveys for selected products. Clearent simplifies hardware provisioning, ensuring seamless integration for transaction processing.

• Equipment Surveys: Merchants select the equipment they need, such as POS systems or card readers. For each product, Clearent provides a tailored survey with specific questions.

• Hardware Provisioning: After completing the survey, merchants submit the details to Clearent, which prepares the devices.

All hardware is configured and linked to the MID for seamless integration with Clearent’s payment systems. This process ensures a streamlined approach to configuring and ordering equipment efficiently.

Utilizing the POST method, it allows users to submit their equipment orders after retrieving and completing a dynamic survey tailored to the chosen product.

• POST /api/merchant/{merchantNumber}/equipment

{
  "merchantNumber": "9876543210123456",
  "metadata": {
    "exchangeId": "EX123456",
    "timestamp": "2025-02-17T17:57:49.203Z"
  },
  "orderCreateTime": {
    "calendarType": "ISO8601",
    "fieldsComputed": 0,
    "fieldsNormalized": 0,
    "firstDayOfWeek": 1,
    "lenient": true,
    "minimalDaysInFirstWeek": 4,
    "time": "2025-02-17T17:57:49.203Z",
    "timeInMillis": 1708186669203,
    "timeZone": {
      "displayName": "Eastern Standard Time",
      "dstsavings": 3600,
      "id": "EST",
      "rawOffset": -18000
    },
    "weekDateSupported": true,
    "weekYear": 2025,
    "weeksInWeekYear": 52,
    "zoneShared": true
  },
  "orderId": "ORD-20250217-001",
  "orderItems": [
    {
      "completionDate": "02/17/2025 05:57 PM",
      "errors": [],
      "manufacturer": "Verifone",
      "orderItemId": 1001,
      "orderItemMetadata": [
        {
          "apiKey": "API-KEY-123",
          "orderStatus": "Shipped",
          "productManufacturer": "Verifone",
          "productModel": "VX520",
          "publicKey": "PUBLIC-KEY-456",
          "salesforceCaseNumber": "SF-789654",
          "serialNumber": "SN-00123456789",
          "storeNumber": 101,
          "tcn": "TCN-ABC123",
          "terminalId": 56789,
          "trackingNumber": "1Z999AA10123456784",
          "vNumber": "VNUM-98765"
        }
      ],
      "productName": "Verifone VX520 Terminal",
      "productType": "Hardware",
      "quantity": 2,
      "surveyValid": true,
      "trackingNumber": "1Z999AA10123456784",
      "validFrontends": ["POS System"]
    }
  ],
  "orderModifyTime": {
    "calendarType": "ISO8601",
    "fieldsComputed": 0,
    "fieldsNormalized": 0,
    "firstDayOfWeek": 1,
    "lenient": true,
    "minimalDaysInFirstWeek": 4,
    "time": "2025-02-18T10:00:00.000Z",
    "timeInMillis": 1708260000000,
    "timeZone": {
      "displayName": "Eastern Standard Time",
      "dstsavings": 3600,
      "id": "EST",
      "rawOffset": -18000
    },
    "weekDateSupported": true,
    "weekYear": 2025,
    "weeksInWeekYear": 52,
    "zoneShared": true
  },
  "resubmit": false,
  "status": "Active",
  "validFrontends": ["POS System", "E-commerce"]
}

For a detailed breakdown of the request and response fields and their descriptions, refer to the reference documentation of Equipment Boarding API.