Terminal Settings

Get Terminal Settings

get

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

Header parameters

api-keystringRequired

An access API key issued to you by Xplor Pay.

Responses

200

OK

application/jsonapplication/xml

payload

payloadTypestringOptional

Indicates the type of payload returned in the response.

400

Bad Request

application/jsonapplication/xml

401

Unauthorized

application/jsonapplication/xml

500

Server error

application/jsonapplication/xml

get

/rest/v2/settings/terminal

HTTPcURLJavaScriptPython

GET /rest/v2/settings/terminal HTTP/1.1
api-key: text
Accept: */*

{
  "terminal-settings": {
    "merchant-name": "Test Merchant",
    "merchant-id": "000000843334",
    "terminal-name": "Waterloo location 1",
    "terminal-id": "10018001",
    "commerce-type": "ECOMMERCE",
    "enable-tip": true,
    "time-zone": "Central/US",
    "batch-time-utc": "09:30",
    "enable-auto-close-batch": true,
    "service-fee": "String",
    "service-fee-type": "String",
    "service-fee-state": "String",
    "service-fee-program-type": "String",
    "business-phone": "String",
    "mcc": "7997"
  },
  "payloadType": "text"
}

Update Terminal Settings

put

Update the configuration settings for a payment terminal.

Header parameters

api-keystringRequired

An access API key issued to you by Xplor Pay.

Body

application/json

terminal-settings

merchant-namestringOptional

Name of the merchant associated with the terminal.

Example: Test Merchant

merchant-idstringOptional

Unique identifier assigned to the merchant.

Example: 000000843334

terminal-namestringOptional

Name for the terminal location.

Example: Waterloo location 1

terminal-idstringOptional

Unique identifier for the payment terminal.

Example: 10018001

commerce-typestringOptional

Type of commerce the terminal is used for. For example, ECOMMERCE, RETAIL.

Example: ECOMMERCE

enable-tipbooleanOptional

Indicates whether tipping is enabled on the terminal.

Example: true

time-zonestringOptional

Time zone setting for the terminal. For example, Central/US.

Example: Central/US

batch-time-utcstringOptional

Time (in UTC) when the terminal batch is automatically closed. Format: HH:mm.

Example: 09:30

enable-auto-close-batchbooleanOptional

Indicates whether the terminal automatically closes batches at the set time.

Example: true

service-feestringOptional

Service fee applied to transactions (value format may vary).

Example: String

service-fee-typestringOptional

Specifies the type of service fee. For example, fixed, percentage.

Example: String

service-fee-statestringOptional

State where the service fee program is applicable.

Example: String

service-fee-program-typestringOptional

Type of service fee program the merchant is enrolled in.

Example: String

business-phonestringOptional

Phone number associated with the merchant's business.

Example: String

mccstringOptional

Merchant Category Code (MCC) assigned to the terminal.

Example: 7997

Responses

200

OK

application/jsonapplication/xml

payload

payloadTypestringOptional

Indicates the type of payload returned in the response.

401

Unauthorized

application/jsonapplication/xml

403

Forbidden

application/jsonapplication/xml

404

Not Found

application/jsonapplication/xml

put

/rest/v2/settings/terminal

HTTPcURLJavaScriptPython

PUT /rest/v2/settings/terminal HTTP/1.1
api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 407

{
  "merchant-name": "Test Merchant",
  "merchant-id": "000000843334",
  "terminal-name": "Waterloo location 1",
  "terminal-id": "10018001",
  "commerce-type": "ECOMMERCE",
  "enable-tip": true,
  "time-zone": "Central/US",
  "batch-time-utc": "09:30",
  "enable-auto-close-batch": true,
  "service-fee": "String",
  "service-fee-type": "String",
  "service-fee-state": "String",
  "service-fee-program-type": "String",
  "business-phone": "String",
  "mcc": "7997"
}

{
  "terminal-settings": {
    "merchant-name": "Test Merchant",
    "merchant-id": "000000843334",
    "terminal-name": "Waterloo location 1",
    "terminal-id": "10018001",
    "commerce-type": "ECOMMERCE",
    "enable-tip": true,
    "time-zone": "Central/US",
    "batch-time-utc": "09:30",
    "enable-auto-close-batch": true,
    "service-fee": "String",
    "service-fee-type": "String",
    "service-fee-state": "String",
    "service-fee-program-type": "String",
    "business-phone": "String",
    "mcc": "7997"
  },
  "payloadType": "text"
}