| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Get Merchant Equipment
Returns the complete list of equipment associated with a merchant's application in Netevia HQ, including both POS and non-POS devices. Each item in the response array is a purchase record containing the equipment catalog ID, title, pricing details, funder assignments, and a flag indicating whether it is POS equipment. This endpoint provides the authoritative view of a merchant's current equipment inventory.
Endpoint
GET /api/v1/merchant/equipment
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 to audit or display the equipment assigned to a merchant application — for example, before adding additional equipment, when generating a merchant equipment report, or when verifying that equipment changes from previous POST /api/v1/equipment/equipmentpos or POST /api/v1/equipment/regular calls have been applied. The isPosEquipment flag in each record makes it easy to separate terminal hardware from peripherals.
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer (int32) | Yes | Unique merchant profile identifier whose equipment list is being retrieved |
Response
200 OK
| Field | Type | Description |
|---|---|---|
| data | array | Array of purchase response objects representing all equipment for the merchant |
| data[].merchantProfileId | integer | Merchant profile ID the equipment belongs to |
| data[].purchaseId | integer | Unique purchase record ID for this equipment entry |
| data[].equipmentId | integer | Catalog ID of the equipment |
| data[].equipmentTitle | string | Display name of the equipment |
| data[].purchasePrice | number | Purchase price recorded for this entry |
| data[].monthlyPayment | number | Monthly payment amount, if applicable |
| data[].fundersIds | array of integer | Funder IDs associated with this purchase |
| data[].isPosEquipment | boolean | true for POS terminal equipment; false for non-POS peripherals |
| requestId | integer | Unique request ID for tracking |
| success | boolean | True if the request completed successfully |
| error | string | Error message on failure; null on success |
| validationErrors | array | Field-level validation errors, if any |
{
"data": [
{
"merchantProfileId": 78234,
"purchaseId": 20051,
"equipmentId": 14,
"equipmentTitle": "PAX S300 PIN Pad",
"purchasePrice": 549.00,
"monthlyPayment": null,
"fundersIds": [3, 5],
"isPosEquipment": true
},
{
"merchantProfileId": 78234,
"purchaseId": 20055,
"equipmentId": 31,
"equipmentTitle": "Epson TM-T88VI Thermal Printer",
"purchasePrice": 129.00,
"monthlyPayment": null,
"fundersIds": [3],
"isPosEquipment": false
}
],
"requestId": 71208,
"success": true,
"error": null,
"validationErrors": []
}Error Codes
| Code | When it happens |
|---|---|
| 400 | id parameter is missing or is not a valid integer |
| 401 | Invalid or missing Basic Auth credentials |
| 403 | User does not have permission for this operation |
| 404 | No merchant profile found for the given id |
| 500 | Internal server error while retrieving equipment |
Common Mistakes
- Passing a non-integer value for
id— this must be a valid int32 - Expecting the response to automatically separate POS from non-POS items — both types are returned together; filter by
isPosEquipmentin the client - Confusing this endpoint (which reads merchant-level equipment assignments) with the equipment catalog endpoints (
GET /api/v1/equipment/posandGET /api/v1/equipment/regular), which return available equipment options - Not handling an empty
dataarray — a merchant with no equipment will returnsuccess: truewith an empty array
Related Endpoints
POST /api/v1/equipment/equipmentpos— add POS equipment to the merchant applicationPOST /api/v1/equipment/regular— add non-POS equipment to the merchant applicationGET /api/v1/equipment/pos— browse the POS equipment catalogGET /api/v1/equipment/regular— browse the non-POS equipment catalog
Example
curl -X GET "https://hq.staging.netevia.dev/api/v1/merchant/equipment?id=78234" \
-H "Authorization: Basic $(echo -n 'username:password' | base64)" \
-H "Content-Type: application/json"