Retrieve list of Non-POS equipment available for merchant boarding

API Endpoint: GET /api/v1/equipment/regular

Overview:

The GET /api/v1/equipment/regular API method retrieves a list of non-POS (non-Point of Sale) equipment available for merchant boarding within the payment processing system. Non-POS equipment includes peripherals and other devices that are not standalone POS terminals but are necessary for a merchant's payment processing setup, such as card readers, printers, and PIN pads.

Purpose:

This endpoint is used to fetch a catalog of non-POS equipment options that merchants can select from when setting up their payment processing infrastructure. The list may include additional equipment that complements the primary POS terminal, enhancing a merchant's ability to accept and process payments efficiently.

HTTP Request Method:

• GET

URL:

• /api/v1/equipment/regular

Authentication:

• Required: Yes
• Authentication Method: Basic Token or API Key provided in the request header.

Request Headers:

• Authorization: Basic <token> (required) - Used to authenticate the API call.
• Content-Type: application/json (optional).

Query Parameters:

• None (the list of non-POS equipment is returned based on the authenticated user's ISO or system configuration).

Error Responses:

• 401 Unauthorized:
  • Occurs if the request lacks valid authentication credentials.
  • Response body:
    JSON

    {
      "error": "Unauthorized",
      "message": "Invalid or missing token"
    }
    

• 403 Forbidden:
  • Occurs if the API user does not have permission to access the non-POS equipment list.
  • Response body:
    JSON

    {
      "error": "Forbidden",
      "message": "You do not have permission to access this resource"
    }
    

• 404 Not Found:
  • Occurs if no non-POS equipment is available for merchant boarding.
  • Response body:
    JSON

    {
      "error": "Not Found",
      "message": "No non-POS equipment found"
    }
    

Notes:

• The non-POS equipment list provides additional devices that merchants may need to complete their payment setup, including PIN pads, receipt printers, and card readers.
• The available non-POS equipment may vary depending on the ISO and merchant type, and this list ensures that the merchant has access to the required peripherals for seamless transaction processing.