Get the created terminals of the Charge Anywhere

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

Description:

This API endpoint retrieves a list of Charge Anywhere terminals that have been created for a specific merchant. Each terminal represents a physical or virtual device used for payment processing. The endpoint allows the merchant to view all the terminals associated with their account based on the provided id.

Request:

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

Query Parameters:

  • id (required):
    A unique identifier for the merchant or their profile. The id is used to retrieve the terminals associated with the specified merchant.
    • Type: String
    • Example: id=67890

Response:

  • Status Code:

    • 200 OK: If the list of terminals is successfully retrieved.
    • 400 Bad Request: If the id parameter is missing or invalid.
    • 404 Not Found: If no terminals are found for the given id.
    • 500 Internal Server Error: If there is an issue processing the request.
  • Response Body:
    The response includes a list of terminals associated with the merchant, including details such as terminal ID, status, and type.

Example Request:

GET /api/v1/merchant/chargeAnywhere/terminals?id=67890

Use Case:

This API method is used by ISO/ISV or support teams to retrieve a list of all terminals that have been created for a specific merchant account. It provides an overview of the terminals' status and type, helping merchants manage their devices for payment processing.

Language
Authorization
Basic
base64
:
Click Try It! to start a request and see the response here!