Retrieve list of POS equipment for merchant boarding

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

Overview:

The GET /api/v1/equipment/pos API method retrieves a list of Point of Sale (POS) equipment available for merchant boarding within the payment processing system. This endpoint provides ISOs, administrators, or merchants with an updated list of POS terminals and devices that can be selected during the onboarding process, ensuring the right equipment is assigned to merchants for their payment processing needs.

Purpose:

This endpoint is used to fetch a catalog of POS equipment options that merchants can select from when setting up their payment processing systems. The list may include various POS terminal models, devices, and their specifications, assisting merchants in choosing the most appropriate hardware for their business operations.

HTTP Request Method:

• GET

URL:

• /api/v1/equipment/pos

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).

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 POS equipment list.
  • Response body:
    JSON

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

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

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

#### Notes:
- The POS equipment list is specific to the ISO or configuration tied to the API user’s account.
- Merchants can use this information to select the appropriate POS device during the onboarding process.
- The available POS equipment may include details such as features, pricing, and compatibility with different payment methods.