---
title: "Get terminal settings"
method: GET
path: "/rest/v2/settings/terminal"
tags: ["Terminal Settings"]
---

# Get terminal settings

`GET /rest/v2/settings/terminal`

Retrieve configuration settings for a payment terminal associated with a merchant.

## Headers

- `api-key` string, required

## Response `200`

OK

- TerminalSettingsPayload — payload
  - `terminal-settings` TerminalSettings — terminal-settings
    - `merchant-name` string — Name of the merchant associated with the terminal.
    - `merchant-id` string — Unique identifier assigned to the merchant.
    - `terminal-name` string — Name for the terminal location.
    - `terminal-id` string — Unique identifier for the payment terminal.
    - `commerce-type` string — Type of commerce the terminal is used for. For example, ECOMMERCE, RETAIL.
    - `enable-tip` boolean — Indicates whether tipping is enabled on the terminal.
    - `time-zone` string — Time zone setting for the terminal. For example, Central/US.
    - `batch-time-utc` string — Time (in UTC) when the terminal batch is automatically closed. Format: HH:mm.
    - `enable-auto-close-batch` boolean — Indicates whether the terminal automatically closes batches at the set time.
    - `service-fee` string — Service fee applied to transactions (value format may vary).
    - `service-fee-type` string — Specifies the type of service fee. For example, fixed, percentage.
    - `service-fee-state` string — State where the service fee program is applicable.
    - `service-fee-program-type` string — Type of service fee program the merchant is enrolled in.
    - `business-phone` string — Phone number associated with the merchant's business.
    - `mcc` string — Merchant Category Code (MCC) assigned to the terminal.
  - `payloadType` string — Indicates the type of payload returned in the response.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `500` — Server error

---

[API](https://skmtc.net/xplorpay/apis/external-us-onboarding-workflow.md) · [All operations](https://skmtc.net/xplorpay/apis/external-us-onboarding-workflow/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/xplorpay/external-us-onboarding-workflow/revisions/f37077c24b66/schema)