The Configuration object

Terminal

Configuration

Attributes

idstring
Unique identifier for the object.

bbpos_wisepos_enullable object
An object containing device type specific settings for BBPOS WisePOS E
- bbpos_wisepos_e.splashscreennullable stringExpandable
  A File ID representing an image to display on the reader

is_account_defaultnullable boolean
Whether this Configuration is the default for your account

stripe_s700nullable object
An object containing device type specific settings for Stripe S700
- stripe_s700.splashscreennullable stringExpandable
  A File ID representing an image to display on the reader

tippingnullable object
On-reader tipping settings
- tipping.aednullable object
  Tipping configuration for AED
  tipping.aed.fixed_amountsnullable array of integers
  Fixed amounts displayed when collecting a tip
  tipping.aed.percentagesnullable array of integers
  Percentages displayed when collecting a tip
  tipping.aed.smart_tip_thresholdnullable integer
  Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
- tipping.audnullable object
  Tipping configuration for AUD
  tipping.aud.fixed_amountsnullable array of integers
  Fixed amounts displayed when collecting a tip
  tipping.aud.percentagesnullable array of integers
  Percentages displayed when collecting a tip
  tipping.aud.smart_tip_thresholdnullable integer
  Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
- tipping.bgnnullable object
  Tipping configuration for BGN
  tipping.bgn.fixed_amountsnullable array of integers
  Fixed amounts displayed when collecting a tip
  tipping.bgn.percentagesnullable array of integers
  Percentages displayed when collecting a tip
  tipping.bgn.smart_tip_thresholdnullable integer
  Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
- tipping.cadnullable object
  Tipping configuration for CAD
  tipping.cad.fixed_amountsnullable array of integers
  Fixed amounts displayed when collecting a tip
  tipping.cad.percentagesnullable array of integers
  Percentages displayed when collecting a tip
  tipping.cad.smart_tip_thresholdnullable integer
  Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
- tipping.chfnullable object
  Tipping configuration for CHF
  tipping.chf.fixed_amountsnullable array of integers
  Fixed amounts displayed when collecting a tip
  tipping.chf.percentagesnullable array of integers
  Percentages displayed when collecting a tip
  tipping.chf.smart_tip_thresholdnullable integer
  Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
- tipping.czknullable object
  Tipping configuration for CZK
  tipping.czk.fixed_amountsnullable array of integers
  Fixed amounts displayed when collecting a tip
  tipping.czk.percentagesnullable array of integers
  Percentages displayed when collecting a tip
  tipping.czk.smart_tip_thresholdnullable integer
  Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
- tipping.dkknullable object
  Tipping configuration for DKK
  tipping.dkk.fixed_amountsnullable array of integers
  Fixed amounts displayed when collecting a tip
  tipping.dkk.percentagesnullable array of integers
  Percentages displayed when collecting a tip
  tipping.dkk.smart_tip_thresholdnullable integer
  Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
- tipping.eurnullable object
  Tipping configuration for EUR
  tipping.eur.fixed_amountsnullable array of integers
  Fixed amounts displayed when collecting a tip
  tipping.eur.percentagesnullable array of integers
  Percentages displayed when collecting a tip
  tipping.eur.smart_tip_thresholdnullable integer
  Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
- tipping.gbpnullable object
  Tipping configuration for GBP
  tipping.gbp.fixed_amountsnullable array of integers
  Fixed amounts displayed when collecting a tip
  tipping.gbp.percentagesnullable array of integers
  Percentages displayed when collecting a tip
  tipping.gbp.smart_tip_thresholdnullable integer
  Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
- tipping.hkdnullable object
  Tipping configuration for HKD
  tipping.hkd.fixed_amountsnullable array of integers
  Fixed amounts displayed when collecting a tip
  tipping.hkd.percentagesnullable array of integers
  Percentages displayed when collecting a tip
  tipping.hkd.smart_tip_thresholdnullable integer
  Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
- tipping.hufnullable object
  Tipping configuration for HUF
  tipping.huf.fixed_amountsnullable array of integers
  Fixed amounts displayed when collecting a tip
  tipping.huf.percentagesnullable array of integers
  Percentages displayed when collecting a tip
  tipping.huf.smart_tip_thresholdnullable integer
  Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
- tipping.jpynullable object
  Tipping configuration for JPY
  tipping.jpy.fixed_amountsnullable array of integers
  Fixed amounts displayed when collecting a tip
  tipping.jpy.percentagesnullable array of integers
  Percentages displayed when collecting a tip
  tipping.jpy.smart_tip_thresholdnullable integer
  Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
- tipping.mxnnullable object
  Tipping configuration for MXN
  tipping.mxn.fixed_amountsnullable array of integers
  Fixed amounts displayed when collecting a tip
  tipping.mxn.percentagesnullable array of integers
  Percentages displayed when collecting a tip
  tipping.mxn.smart_tip_thresholdnullable integer
  Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
- tipping.myrnullable object
  Tipping configuration for MYR
  tipping.myr.fixed_amountsnullable array of integers
  Fixed amounts displayed when collecting a tip
  tipping.myr.percentagesnullable array of integers
  Percentages displayed when collecting a tip
  tipping.myr.smart_tip_thresholdnullable integer
  Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
- tipping.noknullable object
  Tipping configuration for NOK
  tipping.nok.fixed_amountsnullable array of integers
  Fixed amounts displayed when collecting a tip
  tipping.nok.percentagesnullable array of integers
  Percentages displayed when collecting a tip
  tipping.nok.smart_tip_thresholdnullable integer
  Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
- tipping.nzdnullable object
  Tipping configuration for NZD
  tipping.nzd.fixed_amountsnullable array of integers
  Fixed amounts displayed when collecting a tip
  tipping.nzd.percentagesnullable array of integers
  Percentages displayed when collecting a tip
  tipping.nzd.smart_tip_thresholdnullable integer
  Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
- tipping.plnnullable object
  Tipping configuration for PLN
  tipping.pln.fixed_amountsnullable array of integers
  Fixed amounts displayed when collecting a tip
  tipping.pln.percentagesnullable array of integers
  Percentages displayed when collecting a tip
  tipping.pln.smart_tip_thresholdnullable integer
  Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
- tipping.ronnullable object
  Tipping configuration for RON
  tipping.ron.fixed_amountsnullable array of integers
  Fixed amounts displayed when collecting a tip
  tipping.ron.percentagesnullable array of integers
  Percentages displayed when collecting a tip
  tipping.ron.smart_tip_thresholdnullable integer
  Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
- tipping.seknullable object
  Tipping configuration for SEK
  tipping.sek.fixed_amountsnullable array of integers
  Fixed amounts displayed when collecting a tip
  tipping.sek.percentagesnullable array of integers
  Percentages displayed when collecting a tip
  tipping.sek.smart_tip_thresholdnullable integer
  Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
- tipping.sgdnullable object
  Tipping configuration for SGD
  tipping.sgd.fixed_amountsnullable array of integers
  Fixed amounts displayed when collecting a tip
  tipping.sgd.percentagesnullable array of integers
  Percentages displayed when collecting a tip
  tipping.sgd.smart_tip_thresholdnullable integer
  Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
- tipping.usdnullable object
  Tipping configuration for USD
  tipping.usd.fixed_amountsnullable array of integers
  Fixed amounts displayed when collecting a tip
  tipping.usd.percentagesnullable array of integers
  Percentages displayed when collecting a tip
  tipping.usd.smart_tip_thresholdnullable integer
  Below this amount, fixed amounts will be displayed; above it, percentages will be displayed

verifone_p400nullable object
An object containing device type specific settings for Verifone P400
- verifone_p400.splashscreennullable stringExpandable
  A File ID representing an image to display on the reader

More attributes

objectstring
String representing the object’s type. Objects of the same type share the same value.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

namenullable string
String indicating the name of the Configuration object, set by the user

offlinenullable object
Configurations for collecting transactions offline.
- offline.enablednullable boolean
  Determines whether to allow transactions to be collected while reader is offline. Defaults to false.

reboot_windownullable objectPreview feature
Reboot time settings for readers that support customized reboot time configuration.
- reboot_window.end_hourinteger
  Integer between 0 to 23 that represents the end hour of the reboot time window. The value must be different than the start_hour.
- reboot_window.start_hourinteger
  Integer between 0 to 23 that represents the start hour of the reboot time window.

wifinullable object

Configurations for connecting to a WiFi network.

wifi.enterprise_eap_peapnullable object
Credentials for a WPA-Enterprise WiFi network using the EAP-PEAP authentication method.
- wifi.enterprise_eap_peap.ca_certificate_filenullable string
  A File ID representing a PEM file containing the server certificate
- wifi.enterprise_eap_peap.passwordstring
  Password for connecting to the WiFi network
- wifi.enterprise_eap_peap.ssidstring
  Name of the WiFi network
- wifi.enterprise_eap_peap.usernamestring
  Username for connecting to the WiFi network

wifi.enterprise_eap_tlsnullable object
Credentials for a WPA-Enterprise WiFi network using the EAP-TLS authentication method.
- wifi.enterprise_eap_tls.ca_certificate_filenullable string
  A File ID representing a PEM file containing the server certificate
- wifi.enterprise_eap_tls.client_certificate_filestring
  A File ID representing a PEM file containing the client certificate
- wifi.enterprise_eap_tls.private_key_filestring
  A File ID representing a PEM file containing the client RSA private key
- wifi.enterprise_eap_tls.private_key_file_passwordnullable string
  Password for the private key file
- wifi.enterprise_eap_tls.ssidstring
  Name of the WiFi network

wifi.personal_psknullable object
Credentials for a WPA-Personal WiFi network.
- wifi.personal_psk.passwordstring
  Password for connecting to the WiFi network
- wifi.personal_psk.ssidstring
  Name of the WiFi network

wifi.typeenum

Security type of the WiFi network. The hash with the corresponding name contains the credentials for this security type.

Possible enum values

enterprise_eap_peap

WPA-Enterprise network using EAP-PEAP authentication (username/password).

enterprise_eap_tls

WPA-Enterprise network using EAP-TLS authentication (certificates).

personal_psk

WPA-Personal network using PSK authentication (password).

The Configuration object

{
  "id": "tmc_FQqbaQCiy0m1xc",
  "object": "terminal.configuration",
  "is_account_default": false,
  "livemode": false
}

The Configuration object

Attributes

idstring

bbpos_wisepos_enullable object

bbpos_wisepos_e.splashscreennullable stringExpandable

is_account_defaultnullable boolean

stripe_s700nullable object

stripe_s700.splashscreennullable stringExpandable

tippingnullable object

tipping.aednullable object

tipping.aed.fixed_amountsnullable array of integers

tipping.aed.percentagesnullable array of integers

tipping.aed.smart_tip_thresholdnullable integer

tipping.audnullable object

tipping.aud.fixed_amountsnullable array of integers

tipping.aud.percentagesnullable array of integers

tipping.aud.smart_tip_thresholdnullable integer

tipping.bgnnullable object

tipping.bgn.fixed_amountsnullable array of integers

tipping.bgn.percentagesnullable array of integers

tipping.bgn.smart_tip_thresholdnullable integer

tipping.cadnullable object

tipping.cad.fixed_amountsnullable array of integers

tipping.cad.percentagesnullable array of integers

tipping.cad.smart_tip_thresholdnullable integer

tipping.chfnullable object

tipping.chf.fixed_amountsnullable array of integers

tipping.chf.percentagesnullable array of integers

tipping.chf.smart_tip_thresholdnullable integer

tipping.czknullable object

tipping.czk.fixed_amountsnullable array of integers

tipping.czk.percentagesnullable array of integers

tipping.czk.smart_tip_thresholdnullable integer

tipping.dkknullable object

tipping.dkk.fixed_amountsnullable array of integers

tipping.dkk.percentagesnullable array of integers

tipping.dkk.smart_tip_thresholdnullable integer

tipping.eurnullable object

tipping.eur.fixed_amountsnullable array of integers

tipping.eur.percentagesnullable array of integers

tipping.eur.smart_tip_thresholdnullable integer

tipping.gbpnullable object

tipping.gbp.fixed_amountsnullable array of integers

tipping.gbp.percentagesnullable array of integers

tipping.gbp.smart_tip_thresholdnullable integer

tipping.hkdnullable object

tipping.hkd.fixed_amountsnullable array of integers

tipping.hkd.percentagesnullable array of integers

tipping.hkd.smart_tip_thresholdnullable integer

tipping.hufnullable object

tipping.huf.fixed_amountsnullable array of integers

tipping.huf.percentagesnullable array of integers

tipping.huf.smart_tip_thresholdnullable integer

tipping.jpynullable object

tipping.jpy.fixed_amountsnullable array of integers

tipping.jpy.percentagesnullable array of integers

tipping.jpy.smart_tip_thresholdnullable integer

tipping.mxnnullable object

tipping.mxn.fixed_amountsnullable array of integers

tipping.mxn.percentagesnullable array of integers

tipping.mxn.smart_tip_thresholdnullable integer

tipping.myrnullable object

tipping.myr.fixed_amountsnullable array of integers

tipping.myr.percentagesnullable array of integers

tipping.myr.smart_tip_thresholdnullable integer

tipping.noknullable object

tipping.nok.fixed_amountsnullable array of integers

tipping.nok.percentagesnullable array of integers

tipping.nok.smart_tip_thresholdnullable integer

tipping.nzdnullable object

tipping.nzd.fixed_amountsnullable array of integers

tipping.nzd.percentagesnullable array of integers

tipping.nzd.smart_tip_thresholdnullable integer

tipping.plnnullable object

tipping.pln.fixed_amountsnullable array of integers

tipping.pln.percentagesnullable array of integers

tipping.pln.smart_tip_thresholdnullable integer

tipping.ronnullable object

tipping.ron.fixed_amountsnullable array of integers

tipping.ron.percentagesnullable array of integers

More attributes