Update License Keep Active Option

Controls the keep-active setting for a specific Charge Anywhere device license. When keepActive is set to true, the license will be maintained in an active state to ensure uninterrupted payment processing on that device. Setting it to false signals that the license can be deactivated — for example, when a device is retired or reassigned. The response returns a boolean confirming whether the update was applied.

Endpoint

POST /api/v1/merchant/chargeAnywhere/keepLicenseActive

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 change the lifecycle state of a specific device license without fully deleting it. This is common when temporarily disabling a terminal (e.g., during equipment maintenance or suspension), or when re-activating a device after a period of inactivity. It is also used as part of the device decommissioning workflow.

Query Parameters

Response

200 OK

{
  "data": true,
  "requestId": 55781,
  "success": true,
  "error": null,
  "validationErrors": []
}

Error Codes

Common Mistakes

• Passing string values for id or deviceId — both must be valid int32 integers
• Omitting keepActive from the query string — it is required and must be explicitly true or false
• Confusing id (the merchant/record identifier) with deviceId — these are two distinct identifiers; id scopes the request to the correct merchant account, while deviceId targets the specific device
• Calling this endpoint on an already-active license expecting a different behavior — the endpoint is idempotent; setting keepActive: true on an already-active license is a no-op

Related Endpoints

• GET /api/v1/merchant/chargeAnywhere/licenses — retrieve all licenses for a merchant to find the correct deviceId
• GET /api/v1/merchant/chargeAnywhere/terminals — list all terminals and their identification details
• POST /api/v1/merchant/chargeAnywhere/terminal — create a new Charge Anywhere terminal

Example

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