| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Get Charge Anywhere Terminals
Returns the full list of Charge Anywhere terminals provisioned for a given merchant account. Each terminal entry contains its identification string, associated license key, terminal number, store number, and virtual terminal number. This endpoint is used to get a complete view of a merchant's Charge Anywhere terminal inventory.
Endpoint
GET /api/v1/merchant/chargeAnywhere/terminals
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 an ISO or support agent needs to view all Charge Anywhere terminals associated with a merchant — for example, before adding a new terminal, during a review of active devices, or when troubleshooting a specific terminal by its number. The terminal list helps confirm which device types have already been provisioned so duplicate entries can be avoided.
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer (int32) | Yes | Unique merchant identifier used to retrieve all associated Charge Anywhere terminals |
Response
200 OK
| Field | Type | Description |
|---|---|---|
| internalMerchantId | string | Internal merchant ID within the Charge Anywhere system |
| terminals | array | List of Charge Anywhere terminal objects for the merchant |
| terminals[].identification | string | Terminal identification or connection status string |
| terminals[].licenseKey | string | License key assigned to this terminal |
| terminals[].terminalNumber | string | The terminal's assigned number within the merchant's account |
| terminals[].terminalStoreNumber | string | Store number associated with the terminal's physical or logical location |
| terminals[].terminalVNumber | string | Virtual terminal number identifier |
| requestId | integer | Unique request ID for tracking and debugging |
| success | boolean | True if the request completed successfully |
| error | string | Error message on failure; null on success |
| validationErrors | array | Field-level validation errors, if any |
{
"internalMerchantId": "MID-78234",
"terminals": [
{
"identification": "connected",
"licenseKey": "CA-LIC-A1B2C3D4E5F6",
"terminalNumber": "T001",
"terminalStoreNumber": "STORE-01",
"terminalVNumber": "VT-0091"
},
{
"identification": "connected",
"licenseKey": "CA-LIC-G7H8I9J0K1L2",
"terminalNumber": "T002",
"terminalStoreNumber": "STORE-01",
"terminalVNumber": "VT-0092"
}
],
"requestId": 93015,
"success": true,
"error": null,
"validationErrors": []
}Error Codes
| Code | When it happens |
|---|---|
| 400 | id parameter is missing or is not a valid integer |
| 401 | Invalid or missing Basic Auth credentials |
| 403 | User does not have permission for this operation |
| 404 | No terminals found for the specified merchant ID |
| 500 | Internal server error while retrieving terminals |
Common Mistakes
- Passing a string value for
id— the parameter must be a valid int32 integer - Not checking
successbefore processing theterminalsarray — an empty or null array is returned on failure - Confusing
terminalNumberwithterminalVNumber— the terminal number is a merchant-facing label, while the V-number identifies the virtual terminal slot - Using this endpoint to check individual terminal status rather than fetching the credential details — use
GET /api/v1/merchant/chargeAnywhere/virtualTerminalfor detailed credential retrieval
Related Endpoints
GET /api/v1/merchant/chargeAnywhere/virtualTerminal— retrieve credentials and connection status for a specific merchantGET /api/v1/merchant/chargeAnywhere/licenses— retrieve license records for all Charge Anywhere devicesPOST /api/v1/merchant/chargeAnywhere/terminal— create a new Charge Anywhere terminal for a merchant
Example
curl -X GET "https://hq.staging.netevia.dev/api/v1/merchant/chargeAnywhere/terminals?id=78234" \
-H "Authorization: Basic $(echo -n 'username:password' | base64)" \
-H "Content-Type: application/json"