Get Terminal

Retrieve the current configuration and metadata for one terminal.

Purpose

• Display device details in an admin UI.

• Verify a terminal’s webhook URL, tender types, or enabled status before updating.

• Troubleshoot by confirming whether the terminal is enabled or disabled.

Endpoint

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

Required header

Name	Example	Notes
Authorization	Bearer eyJhbGciOiJS…	Same access token used for other Terminal Management calls.

Path parameter

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

Request example

curl -X GET \
  "https://api.test.devs.beadpay.io/Terminals/122131" \
  -H "accept: */*" \
  -H "Authorization: Bearer <YOUR_ACCESS_TOKEN>"

(No request body.)

Response example

{
  "id": "122131",
  "name": "Main POS",
  "description": "Front-counter terminal",
  "merchantId": "mrc_7f4a2d3e4b",
  "merchantLocationId": "loc_c1a2eb",
  "displayLogo": true,
  "webhookUrl": "https://example.com/webhooks/terminal/122131",
  "isEnabled": true,
  "tenderTypes": [ "ethereum" ],
  "created": "2025-04-24T22:53:07.474Z",
  "updated": "2025-04-24T23:04:11.219Z"
}

Field descriptions

Field	Type	Meaning
id	string	Terminal identifier.
name	string	Friendly display name.
description	string	Additional text shown in dashboards.
merchantId	string	Merchant that owns this terminal.
merchantLocationId	string	Optional sub-location (e.g., store number).
displayLogo	boolean	Show the Bead logo on hosted pages for this terminal.
webhookUrl	string | null	Device-level webhook URL.
isEnabled	boolean	false = terminal is disabled and cannot create new payments.
tenderTypes	array	Payment methods accepted by this device.
created	string	UTC ISO-8601 timestamp when the terminal was created.
updated	string	UTC ISO-8601 timestamp of the last modification.

Response codes

HTTP status	Meaning	Body
200 OK	Terminal found	JSON as above
404 Not Found	Terminal id unknown	{ "code": "TerminalNotFound", "message": "Terminal {id} does not exist." }
401 / 403	Invalid or expired token	Standard auth error payload

Usage tips

• Pre-update check – Load the terminal first to confirm its current webhookUrl or tenderTypes before calling Set Webhook or Update Terminal.

• Status dashboards – Display isEnabled, tenderTypes, and updated to help ops teams spot mis-configured devices.

• Audit trails – Store the response externally when doing compliance audits; the timestamps provide proof of device creation and edits.

Related pages

Operation	Description
Create Terminal	Add a new device.
List Terminals	Retrieve all devices (optionally filtered by merchant).
Delete Terminal	Remove a device that is no longer needed.