# Terminal Settings ## Get Terminal Settings > Retrieve configuration settings for a payment terminal associated with a merchant. ```json {"openapi":"3.0.1","info":{"title":"Gateway Settings API","version":"2.0"},"paths":{"/rest/v2/settings/terminal":{"get":{"tags":["Terminal Settings"],"summary":"Get Terminal Settings","description":"Retrieve configuration settings for a payment terminal associated with a merchant.","operationId":"getSettings_1","parameters":[{"name":"api-key","in":"header","description":"An access API key issued to you by Xplor Pay.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TerminalSettingsPayload"}},"application/xml":{"schema":{"$ref":"#/components/schemas/TerminalSettingsPayload"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorPayloadResponsePayload"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorPayloadResponsePayload"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorPayloadResponsePayload"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorPayloadResponsePayload"}}}},"500":{"description":"Server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorPayloadResponsePayload"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorPayloadResponsePayload"}}}}}}}},"components":{"schemas":{"TerminalSettingsPayload":{"type":"object","properties":{"terminal-settings":{"$ref":"#/components/schemas/terminal-settings"},"payloadType":{"type":"string","description":"Indicates the type of payload returned in the response.","xml":{"name":"type","attribute":true}}},"description":"payload","xml":{"name":"payload"}},"terminal-settings":{"type":"object","properties":{"merchant-name":{"type":"string","description":"Name of the merchant associated with the terminal."},"merchant-id":{"type":"string","description":"Unique identifier assigned to the merchant."},"terminal-name":{"type":"string","description":"Name for the terminal location."},"terminal-id":{"type":"string","description":"Unique identifier for the payment terminal."},"commerce-type":{"type":"string","description":"Type of commerce the terminal is used for. For example, ECOMMERCE, RETAIL."},"enable-tip":{"type":"boolean","description":"Indicates whether tipping is enabled on the terminal."},"time-zone":{"type":"string","description":"Time zone setting for the terminal. For example, Central/US."},"batch-time-utc":{"type":"string","description":"Time (in UTC) when the terminal batch is automatically closed. Format: HH:mm."},"enable-auto-close-batch":{"type":"boolean","description":"Indicates whether the terminal automatically closes batches at the set time."},"service-fee":{"type":"string","description":"Service fee applied to transactions (value format may vary)."},"service-fee-type":{"type":"string","description":"Specifies the type of service fee. For example, fixed, percentage."},"service-fee-state":{"type":"string","description":"State where the service fee program is applicable."},"service-fee-program-type":{"type":"string","description":"Type of service fee program the merchant is enrolled in."},"business-phone":{"type":"string","description":"Phone number associated with the merchant's business."},"mcc":{"type":"string","description":"Merchant Category Code (MCC) assigned to the terminal."}},"description":"terminal-settings","xml":{"name":"terminal-settings"}},"ErrorPayloadResponsePayload":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/ErrorPayload"},"payloadType":{"type":"string","description":"Type of payload returned in the response.","xml":{"name":"type","attribute":true}}},"description":"Payload","xml":{"name":"payload"}},"ErrorPayload":{"type":"object","properties":{"error-message":{"type":"string","description":"Describes the reason for the error."},"result-code":{"type":"string","description":"Numeric code that identifies the type of error returned by the request."},"time-stamp":{"type":"string","description":"Date and time when the error occurred, ISO 8601 format (UTC)."}},"xml":{"name":"error"}}}}} ``` ## Update Terminal Settings > Update the configuration settings for a payment terminal. ```json {"openapi":"3.0.1","info":{"title":"Gateway Settings API","version":"2.0"},"paths":{"/rest/v2/settings/terminal":{"put":{"tags":["Terminal Settings"],"summary":"Update Terminal Settings","description":"Update the configuration settings for a payment terminal.","operationId":"updateSettings","parameters":[{"name":"api-key","in":"header","description":"An access API key issued to you by Xplor Pay.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/terminal-settings"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TerminalSettingsPayload"}},"application/xml":{"schema":{"$ref":"#/components/schemas/TerminalSettingsPayload"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorPayloadResponsePayload"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorPayloadResponsePayload"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorPayloadResponsePayload"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorPayloadResponsePayload"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorPayloadResponsePayload"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorPayloadResponsePayload"}}}}}}}},"components":{"schemas":{"terminal-settings":{"type":"object","properties":{"merchant-name":{"type":"string","description":"Name of the merchant associated with the terminal."},"merchant-id":{"type":"string","description":"Unique identifier assigned to the merchant."},"terminal-name":{"type":"string","description":"Name for the terminal location."},"terminal-id":{"type":"string","description":"Unique identifier for the payment terminal."},"commerce-type":{"type":"string","description":"Type of commerce the terminal is used for. For example, ECOMMERCE, RETAIL."},"enable-tip":{"type":"boolean","description":"Indicates whether tipping is enabled on the terminal."},"time-zone":{"type":"string","description":"Time zone setting for the terminal. For example, Central/US."},"batch-time-utc":{"type":"string","description":"Time (in UTC) when the terminal batch is automatically closed. Format: HH:mm."},"enable-auto-close-batch":{"type":"boolean","description":"Indicates whether the terminal automatically closes batches at the set time."},"service-fee":{"type":"string","description":"Service fee applied to transactions (value format may vary)."},"service-fee-type":{"type":"string","description":"Specifies the type of service fee. For example, fixed, percentage."},"service-fee-state":{"type":"string","description":"State where the service fee program is applicable."},"service-fee-program-type":{"type":"string","description":"Type of service fee program the merchant is enrolled in."},"business-phone":{"type":"string","description":"Phone number associated with the merchant's business."},"mcc":{"type":"string","description":"Merchant Category Code (MCC) assigned to the terminal."}},"description":"terminal-settings","xml":{"name":"terminal-settings"}},"TerminalSettingsPayload":{"type":"object","properties":{"terminal-settings":{"$ref":"#/components/schemas/terminal-settings"},"payloadType":{"type":"string","description":"Indicates the type of payload returned in the response.","xml":{"name":"type","attribute":true}}},"description":"payload","xml":{"name":"payload"}},"ErrorPayloadResponsePayload":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/ErrorPayload"},"payloadType":{"type":"string","description":"Type of payload returned in the response.","xml":{"name":"type","attribute":true}}},"description":"Payload","xml":{"name":"payload"}},"ErrorPayload":{"type":"object","properties":{"error-message":{"type":"string","description":"Describes the reason for the error."},"result-code":{"type":"string","description":"Numeric code that identifies the type of error returned by the request."},"time-stamp":{"type":"string","description":"Date and time when the error occurred, ISO 8601 format (UTC)."}},"xml":{"name":"error"}}}}} ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.xplorpay.com/api-reference/api/payments/gateway-settings/terminal-settings.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.