/api/v1/merchant/chargeAnywhere/keepLicenseActive

API Method: POST /api/v1/merchant/chargeAnywhere/keepLicenseActive

Description:

This API endpoint is used to manage the license status of a Charge Anywhere terminal by specifying whether the license should be kept active. It is primarily used to maintain or update the activation status of a terminal's license, ensuring the terminal remains functional or is deactivated based on the provided parameters.

Request:

• HTTP Method: POST
• Endpoint: /api/v1/merchant/chargeAnywhere/keepLicenseActive
• Content-Type: application/json

Request Body Parameters:

The request body must be in JSON format and include the following fields:

• id (required):
  A unique identifier for the merchant or the specific license record that is being managed.

  • Type: int32
  • Example: "id": 12345

• deviceId (required):
  A unique identifier for the terminal device whose license is being managed.

  • Type: int32
  • Example: "deviceId": 67890

• keepActive (required):
  A boolean flag indicating whether the terminal's license should be kept active. Setting this to true ensures the terminal remains licensed and operational; setting it to false will deactivate the license.

  • Type: boolean
  • Example: "keepActive": true

Response:

• Status Code:

  • 200 OK: If the license status is successfully updated.
  • 400 Bad Request: If required fields are missing or invalid.
  • 500 Internal Server Error: If there is an issue processing the request.

• Response Body:
  The response will confirm whether the license has been successfully kept active or deactivated.

Example Request:

POST /api/v1/merchant/chargeAnywhere/keepLicenseActive
Content-Type: application/json

{
  "id": 12345,
  "deviceId": 67890,
  "keepActive": true
}

Use Case:

This API method is used by ISO/ISV or system administrators to manage the license status of a Charge Anywhere terminal. It is useful for keeping a terminal's license active, ensuring uninterrupted operation, or deactivating the license when the terminal is no longer in use. This feature helps maintain control over terminal functionality based on licensing requirements.