Add Non-POS equipment to the merchant application

Time	Status	User Agent
Retrieving recent requests…

Add Non-POS Equipment

Adds a non-POS peripheral device to a merchant's equipment application in Netevia HQ. Non-POS equipment includes accessories and peripherals such as receipt printers, cash drawers, external PIN pads, and other ancillary devices that complement a merchant's primary POS terminal. The request accepts the same schema as the POS equipment endpoint and returns an array of purchase response records.

Endpoint

POST /api/v1/equipment/regular

Authentication

Basic HTTP Authentication required.
Encode username:password in Base64 and pass in the Authorization header:

Authorization: Basic {base64(username:password)}

When to use

Use this endpoint when setting up or expanding a merchant's peripheral equipment alongside their POS terminals. Non-POS equipment does not process payments independently but is required for a complete payment setup. Call GET /api/v1/equipment/regular first to retrieve valid non-POS equipment catalog IDs, and GET /api/v1/equipment/funders for funder IDs if financing is involved.

Request Body

Field	Type	Required	Description
id	integer (int32)	Yes	Merchant profile ID to which the non-POS equipment is being added
purchaseId	integer (int32)	No	Existing purchase record ID if updating an existing purchase line
equipmentId	integer (int32)	Yes	Catalog ID of the non-POS equipment (obtain from `GET /api/v1/equipment/regular`)
quantity	integer (int32)	Yes	Number of units to add; must be between 1 and 10
purchasePrice	number (double)	No	Purchase price per unit for the equipment
monthlyPayment	number (double)	No	Monthly lease or financing payment amount per unit
paymentType	string (enum)	Yes	Payment acquisition method. One of: `Purchase`, `Reprogram`, `PurchaseByIso`, `SmartMembershipProgram`, `LoanerProgram`
note	string	No	Free-text notes or special instructions for this equipment entry
fundersIds	array of integer	No	Array of funder IDs backing the equipment acquisition

{
  "id": 78234,
  "purchaseId": null,
  "equipmentId": 31,
  "quantity": 1,
  "purchasePrice": 129.00,
  "monthlyPayment": null,
  "paymentType": "Purchase",
  "note": "Thermal receipt printer for front-of-house register",
  "fundersIds": [3]
}

Response

200 OK

Field	Type	Description
data	array	Array of purchase response objects for each equipment item added
data[].merchantProfileId	integer	Merchant profile ID the equipment was assigned to
data[].purchaseId	integer	Unique ID of the resulting purchase record
data[].equipmentId	integer	Catalog ID of the equipment added
data[].equipmentTitle	string	Display name of the equipment from the catalog
data[].purchasePrice	number	Purchase price recorded for this entry
data[].monthlyPayment	number	Monthly payment amount recorded, if applicable
data[].fundersIds	array of integer	Funder IDs associated with this purchase
data[].isPosEquipment	boolean	Always `false` for non-POS equipment
status	string	HTTP status string (e.g., `OK`)
error	string	Error message on failure; null on success
warning	string	Non-fatal warning message, if any
validationResults	array	Validation result objects with member names and error messages
requestId	integer	Unique request ID for tracking

{
  "data": [
    {
      "merchantProfileId": 78234,
      "purchaseId": 20055,
      "equipmentId": 31,
      "equipmentTitle": "Epson TM-T88VI Thermal Printer",
      "purchasePrice": 129.00,
      "monthlyPayment": null,
      "fundersIds": [3],
      "isPosEquipment": false
    }
  ],
  "status": "OK",
  "error": null,
  "warning": null,
  "validationResults": [],
  "requestId": 66399
}

Error Codes

Code	When it happens
400	Required fields missing; `quantity` is outside the 1–10 range; `paymentType` is not a valid enum; `equipmentId` is not in the non-POS catalog
401	Invalid or missing Basic Auth credentials
403	User does not have permission for this operation
404	Merchant profile not found for the given `id`
500	Internal server error while adding the non-POS equipment

Common Mistakes

Using a POS equipment catalog ID (equipmentId from the /pos catalog) for this endpoint — each endpoint uses its own catalog; retrieve non-POS IDs from GET /api/v1/equipment/regular
Setting quantity to 0 or above 10 — the allowed range is 1 to 10 inclusive
Using a free-text string for paymentType — only the exact enum values are accepted: Purchase, Reprogram, PurchaseByIso, SmartMembershipProgram, LoanerProgram
Providing fundersIds as a bare integer instead of a JSON array

Related Endpoints

GET /api/v1/equipment/regular — retrieve the non-POS equipment catalog to get valid equipmentId values
GET /api/v1/equipment/funders — retrieve available funder IDs
GET /api/v1/merchant/equipment — view all equipment currently assigned to a merchant
POST /api/v1/equipment/equipmentpos — add POS equipment to a merchant application

Example

curl -X POST "https://hq.staging.netevia.dev/api/v1/equipment/regular" \
  -H "Authorization: Basic $(echo -n 'username:password' | base64)" \
  -H "Content-Type: application/json" \
  -d '{
    "id": 78234,
    "equipmentId": 31,
    "quantity": 1,
    "paymentType": "Purchase",
    "purchasePrice": 129.00,
    "note": "Thermal receipt printer for front-of-house register",
    "fundersIds": [3]
  }'