Get the created terminals of the Charge Anywhere

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

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

ParameterTypeRequiredDescription
idinteger (int32)YesUnique merchant identifier used to retrieve all associated Charge Anywhere terminals

Response

200 OK

FieldTypeDescription
internalMerchantIdstringInternal merchant ID within the Charge Anywhere system
terminalsarrayList of Charge Anywhere terminal objects for the merchant
terminals[].identificationstringTerminal identification or connection status string
terminals[].licenseKeystringLicense key assigned to this terminal
terminals[].terminalNumberstringThe terminal's assigned number within the merchant's account
terminals[].terminalStoreNumberstringStore number associated with the terminal's physical or logical location
terminals[].terminalVNumberstringVirtual terminal number identifier
requestIdintegerUnique request ID for tracking and debugging
successbooleanTrue if the request completed successfully
errorstringError message on failure; null on success
validationErrorsarrayField-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

CodeWhen it happens
400id parameter is missing or is not a valid integer
401Invalid or missing Basic Auth credentials
403User does not have permission for this operation
404No terminals found for the specified merchant ID
500Internal server error while retrieving terminals

Common Mistakes

  • Passing a string value for id — the parameter must be a valid int32 integer
  • Not checking success before processing the terminals array — an empty or null array is returned on failure
  • Confusing terminalNumber with terminalVNumber — 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/virtualTerminal for detailed credential retrieval

Related Endpoints

  • GET /api/v1/merchant/chargeAnywhere/virtualTerminal — retrieve credentials and connection status for a specific merchant
  • GET /api/v1/merchant/chargeAnywhere/licenses — retrieve license records for all Charge Anywhere devices
  • POST /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"
Query Params
int32
required
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Response

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/json