Get merchant's equipment

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

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

ParameterTypeRequiredDescription
idinteger (int32)YesUnique merchant profile identifier whose equipment list is being retrieved

Response

200 OK

FieldTypeDescription
dataarrayArray of purchase response objects representing all equipment for the merchant
data[].merchantProfileIdintegerMerchant profile ID the equipment belongs to
data[].purchaseIdintegerUnique purchase record ID for this equipment entry
data[].equipmentIdintegerCatalog ID of the equipment
data[].equipmentTitlestringDisplay name of the equipment
data[].purchasePricenumberPurchase price recorded for this entry
data[].monthlyPaymentnumberMonthly payment amount, if applicable
data[].fundersIdsarray of integerFunder IDs associated with this purchase
data[].isPosEquipmentbooleantrue for POS terminal equipment; false for non-POS peripherals
requestIdintegerUnique request ID for tracking
successbooleanTrue if the request completed successfully
errorstringError message on failure; null on success
validationErrorsarrayField-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

CodeWhen it happens
400id parameter is missing or is not a valid integer
401Invalid or missing Basic Auth credentials
403User does not have permission for this operation
404No merchant profile found for the given id
500Internal 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 isPosEquipment in the client
  • Confusing this endpoint (which reads merchant-level equipment assignments) with the equipment catalog endpoints (GET /api/v1/equipment/pos and GET /api/v1/equipment/regular), which return available equipment options
  • Not handling an empty data array — a merchant with no equipment will return success: true with an empty array

Related Endpoints

  • POST /api/v1/equipment/equipmentpos — add POS equipment to the merchant application
  • POST /api/v1/equipment/regular — add non-POS equipment to the merchant application
  • GET /api/v1/equipment/pos — browse the POS equipment catalog
  • GET /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"
Query Params
int32
required
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Response

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/json