Get Charge Anywhere Credentials

Retrieves the connection status and terminal credentials for the Charge Anywhere Virtual Terminal associated with a given merchant profile. The response includes the merchant's internal ID, a list of terminal objects each containing an identification string, terminal ID, and secret key. This endpoint is primarily used to verify that a merchant's virtual terminal is connected and operational before processing transactions.

Endpoint

GET /api/v1/merchant/chargeAnywhere/virtualTerminal

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 to check whether a merchant's Charge Anywhere Virtual Terminal is active and retrieve its credentials. This is useful before initiating a transaction session, during troubleshooting, or when verifying that a newly provisioned terminal is properly connected. Support teams can use this to diagnose connectivity issues for a specific merchant account.

Query Parameters

Response

200 OK

{
  "internalMerchantId": "MID-78234",
  "terminals": [
    {
      "identification": "connected",
      "terminalId": "TRM-00142",
      "secret": "s3cr3tK3y!2024xZ"
    },
    {
      "identification": "connected",
      "terminalId": "TRM-00143",
      "secret": "k9mNpQ7rLw3vBx01"
    }
  ],
  "requestId": 40291,
  "success": true,
  "error": null,
  "validationErrors": []
}

Error Codes

Common Mistakes

• Passing a string instead of an integer for merchantProfileId — this parameter must be a valid int32
• Omitting merchantProfileId entirely — the query parameter is required
• Not checking the success field before consuming terminal data — always validate success is true before reading the terminals array
• Expecting the secret to be stable — secrets may rotate; always fetch fresh credentials before starting a session

Related Endpoints

• GET /api/v1/merchant/chargeAnywhere/terminals — list all Charge Anywhere terminals created for a merchant
• GET /api/v1/merchant/chargeAnywhere/licenses — retrieve license information for a merchant's 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/virtualTerminal?merchantProfileId=78234" \
  -H "Authorization: Basic $(echo -n 'username:password' | base64)" \
  -H "Content-Type: application/json"