Get Terminal

Retrieves the current configuration and metadata for a specific terminal.

Endpoint

GET https://api.test.devs.beadpay.io/Terminals/{id}

Authentication

Use your admin API key in the request header for terminal management operations.

Request headers

Header	Value
X-Api-Key	{adminApiKey}
Accept	application/json

Path parameter

Name	Type	Description
id	string	Terminal identifier returned by Create Terminal or List Terminals.

Request example

curl --request GET "https://api.test.devs.beadpay.io/Terminals/67f10123456789abcdef0456" \
  --header "X-Api-Key: {adminApiKey}" \
  --header "Accept: application/json"

Example response

{
  "id": "67f10123456789abcdef0456",
  "name": "Front Counter 1",
  "description": "Primary checkout terminal",
  "merchantId": "67e90123456789abcdef0001",
  "merchantStatus": "active",
  "type": "virtual",
  "merchantLocationId": "67f00123456789abcdef0123",
  "merchantLocation": {
    "id": "67f00123456789abcdef0123",
    "name": "Main Store",
    "address": {
      "address1": "123 Main St",
      "city": "Boston",
      "region": "MA",
      "country": "US",
      "postalCode": "02110"
    },
    "isEnabled": true
  },
  "displayLogo": true,
  "webhookUrl": "https://example.com/webhooks/terminal/67f10123456789abcdef0456",
  "isEnabled": true,
  "extendRedirectUrl": false,
  "tenderTypes": ["ethereum", "usdcBase"],
  "created": "2026-04-02T15:00:00Z",
  "updated": "2026-04-02T15:10:00Z",
  "maxTransactionAmount": 5000,
  "apiKey": {
    "secret": "pk_test_terminal_secret_value",
    "maskedSecret": "pk_****_value"
  },
  "useSandboxSharedWallet": true
}

Field descriptions

Field	Type	Description
id	string	Terminal identifier.
name	string	Friendly name for the terminal.
description	string	Optional description for the terminal.
merchantId	string	Merchant that owns the terminal.
merchantStatus	string	Current status of the owning merchant.
type	string	Terminal type, such as virtual or physical.
merchantLocationId	string	ID of the location that owns the terminal.
merchantLocation	object	Summary of the owning location.
displayLogo	boolean	Indicates whether terminal branding is enabled where supported.
webhookUrl	string | null	Terminal webhook URL, if configured.
isEnabled	boolean	Indicates whether the terminal can create new payments.
extendRedirectUrl	boolean	Redirect behavior setting for supported payment flows.
tenderTypes	array	Tender types enabled for the terminal.
created	string	UTC ISO-8601 timestamp when the terminal was created.
updated	string	UTC ISO-8601 timestamp when the terminal was last updated.
maxTransactionAmount	number | null	Optional maximum transaction amount for the terminal.
apiKey	object	Terminal payments API key object. Treat apiKey.secret as sensitive.
useSandboxSharedWallet	boolean	Sandbox wallet behavior setting for the terminal.

Notes

• Use this endpoint to review the current terminal configuration before making updates.

• Use the terminal id from this response for follow-on terminal operations such as update, delete, webhook configuration, or cloning.

• Use your admin API key for terminal management operations.

• Treat apiKey.secret as sensitive and do not expose it in logs or client-side code.

Response codes

Code	Meaning
200	Terminal returned successfully.
401	The admin API key is missing or invalid.
403	The caller is authenticated but not permitted to access the specified terminal.
404	No terminal was found for the supplied id.

Related operations

• Create Terminal

• List Terminals

• Update Terminal

• Delete Terminal

• Webhook Management