Get the connection status of the Charge Anywhere

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

Description:

This API endpoint is used to retrieve the connection status of the Charge Anywhere Virtual Terminal for a specific merchant. The virtual terminal is an online platform that allows merchants to process payments manually. This endpoint checks whether the terminal is connected and functional for the merchant associated with the given merchantProfileId.

Request:

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

Query Parameters:

• merchantProfileId (required):
  A unique identifier for the merchant’s profile. The merchantProfileId is used to query the connection status of the Charge Anywhere virtual terminal associated with that merchant.
  • Type: String
  • Example: merchantProfileId=12345

Response:

• Status Code:

  • 200 OK: If the connection status of the virtual terminal is successfully retrieved.
  • 400 Bad Request: If the merchantProfileId is missing or invalid.
  • 404 Not Found: If no connection data is found for the specified merchantProfileId.
  • 500 Internal Server Error: If there is an issue processing the request.

• Response Body:
  The response includes the connection status of the Charge Anywhere Virtual Terminal, indicating whether the terminal is connected or disconnected for the specified merchant profile.

Response Fields:

• InternalmerchantID: The unique identifier for the merchant profile.
  • Type: String
  • Example: "merchantProfileId": "12345"
• identification: The status of the connection to the Charge Anywhere Virtual Terminal.
  • Type: String
  • Accepted Values:
    • connected: The virtual terminal is connected and operational.
    • disconnected: The virtual terminal is not connected or offline.
  • Example: "identification": "connected"

Example Request:

GET /api/v1/merchant/chargeAnywhere/virtualTerminal?merchantProfileId=12345

Use Case:

This API method is used by merchants or support teams to check the connection status of the Charge Anywhere Virtual Terminal. Ensuring that the virtual terminal is connected is critical for merchants to process manual payments and manage their transactions.