Returns a list of licenses for the merchant's devices.

API Method: GET /api/v1/merchant/chargeAnywhere/licenses

Description:

This API endpoint is used to retrieve a list of licenses associated with a merchant's Charge Anywhere devices. Each license corresponds to a specific terminal or device used by the merchant for payment processing. The endpoint returns details about the licenses for all devices linked to the merchant, based on the provided merchant id.

Request:

• HTTP Method: GET
• Endpoint: /api/v1/merchant/chargeAnywhere/licenses

Query Parameters:

• id (required):
  A unique identifier for the merchant. The id is used to retrieve all licenses associated with the devices registered under the specified merchant.
  • Type: String
  • Example: id=merchant_12345

Response:

• Status Code:

  • 200 OK: If the list of licenses is successfully retrieved.
  • 400 Bad Request: If the id parameter is missing or invalid.
  • 404 Not Found: If no licenses are found for the given merchant ID.
  • 500 Internal Server Error: If there is an issue processing the request.

• Response Body:
  The response contains a list of licenses for the devices associated with the merchant. Each license includes details such as the device ID, license status, and the terminal type.

Example Request:

GET /api/v1/merchant/chargeAnywhere/licenses?id=merchant_12345

Use Case:

This API method is used by ISO/ISV or administrators to view all licenses associated with their Charge Anywhere devices. It provides a comprehensive list of licensed terminals, allowing for easy monitoring and management of license statuses across both virtual and physical devices.