Get Charge Anywhere Licenses

Returns a list of licenses associated with a merchant's Charge Anywhere devices. Each license object includes a license key, the device ID it is assigned to, and a flag indicating whether the license should be kept active. This endpoint is essential for ISOs and administrators who need to audit or manage licensing across a merchant's portfolio of payment devices.

Endpoint

GET /api/v1/merchant/chargeAnywhere/licenses

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 you need to view the current license state for all Charge Anywhere devices belonging to a specific merchant. This is particularly useful during device audits, before decommissioning hardware, or when verifying that all active devices have valid licenses. Administrators can use the keepActive flag in each license record to determine which devices are slated for continued use.

Query Parameters

Response

200 OK

{
  "userId": 5821,
  "licenses": [
    {
      "licenseKey": "CA-LIC-A1B2C3D4E5F6",
      "deviceId": "DEV-00391",
      "keepActive": true
    },
    {
      "licenseKey": "CA-LIC-G7H8I9J0K1L2",
      "deviceId": "DEV-00392",
      "keepActive": false
    },
    {
      "licenseKey": "CA-LIC-M3N4O5P6Q7R8",
      "deviceId": "DEV-00394",
      "keepActive": true
    }
  ],
  "requestId": 80442,
  "success": true,
  "error": null,
  "validationErrors": []
}

Error Codes

Common Mistakes

• Passing a non-integer value for id — the parameter must be a valid int32
• Omitting the id query parameter — the endpoint requires it to scope the license lookup to a specific merchant
• Misinterpreting keepActive: false as a license being invalid — it simply means the license will not be renewed automatically
• Not paginating results for merchants with many devices — review if a merchant has a large number of devices before displaying the full list

Related Endpoints

• GET /api/v1/merchant/chargeAnywhere/virtualTerminal — retrieve Charge Anywhere credentials for a merchant
• GET /api/v1/merchant/chargeAnywhere/terminals — list all created Charge Anywhere terminals for a merchant
• POST /api/v1/merchant/chargeAnywhere/keepLicenseActive — update the keep-active option for a specific device license

Example

curl -X GET "https://hq.staging.netevia.dev/api/v1/merchant/chargeAnywhere/licenses?id=5821" \
  -H "Authorization: Basic $(echo -n 'username:password' | base64)" \
  -H "Content-Type: application/json"