Update a Configuration

Terminal

Configuration

Updates a new Configuration object.

Parameters

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

stripe_s700object
An object containing device type specific settings for Stripe S700 readers
- stripe_s700.splashscreenstring
  A File ID representing an image you would like displayed on the reader.

tippingobject
Tipping configurations for readers supporting on-reader tips
- tipping.aedobject
  Tipping configuration for AED
  tipping.aed.fixed_amountsarray of integers
  Fixed amounts displayed when collecting a tip
  tipping.aed.percentagesarray of integers
  Percentages displayed when collecting a tip
  tipping.aed.smart_tip_thresholdinteger
  Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
- tipping.audobject
  Tipping configuration for AUD
  tipping.aud.fixed_amountsarray of integers
  Fixed amounts displayed when collecting a tip
  tipping.aud.percentagesarray of integers
  Percentages displayed when collecting a tip
  tipping.aud.smart_tip_thresholdinteger
  Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
- tipping.bgnobject
  Tipping configuration for BGN
  tipping.bgn.fixed_amountsarray of integers
  Fixed amounts displayed when collecting a tip
  tipping.bgn.percentagesarray of integers
  Percentages displayed when collecting a tip
  tipping.bgn.smart_tip_thresholdinteger
  Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
- tipping.cadobject
  Tipping configuration for CAD
  tipping.cad.fixed_amountsarray of integers
  Fixed amounts displayed when collecting a tip
  tipping.cad.percentagesarray of integers
  Percentages displayed when collecting a tip
  tipping.cad.smart_tip_thresholdinteger
  Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
- tipping.chfobject
  Tipping configuration for CHF
  tipping.chf.fixed_amountsarray of integers
  Fixed amounts displayed when collecting a tip
  tipping.chf.percentagesarray of integers
  Percentages displayed when collecting a tip
  tipping.chf.smart_tip_thresholdinteger
  Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
- tipping.czkobject
  Tipping configuration for CZK
  tipping.czk.fixed_amountsarray of integers
  Fixed amounts displayed when collecting a tip
  tipping.czk.percentagesarray of integers
  Percentages displayed when collecting a tip
  tipping.czk.smart_tip_thresholdinteger
  Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
- tipping.dkkobject
  Tipping configuration for DKK
  tipping.dkk.fixed_amountsarray of integers
  Fixed amounts displayed when collecting a tip
  tipping.dkk.percentagesarray of integers
  Percentages displayed when collecting a tip
  tipping.dkk.smart_tip_thresholdinteger
  Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
- tipping.eurobject
  Tipping configuration for EUR
  tipping.eur.fixed_amountsarray of integers
  Fixed amounts displayed when collecting a tip
  tipping.eur.percentagesarray of integers
  Percentages displayed when collecting a tip
  tipping.eur.smart_tip_thresholdinteger
  Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
- tipping.gbpobject
  Tipping configuration for GBP
  tipping.gbp.fixed_amountsarray of integers
  Fixed amounts displayed when collecting a tip
  tipping.gbp.percentagesarray of integers
  Percentages displayed when collecting a tip
  tipping.gbp.smart_tip_thresholdinteger
  Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
- tipping.hkdobject
  Tipping configuration for HKD
  tipping.hkd.fixed_amountsarray of integers
  Fixed amounts displayed when collecting a tip
  tipping.hkd.percentagesarray of integers
  Percentages displayed when collecting a tip
  tipping.hkd.smart_tip_thresholdinteger
  Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
- tipping.hufobject
  Tipping configuration for HUF
  tipping.huf.fixed_amountsarray of integers
  Fixed amounts displayed when collecting a tip
  tipping.huf.percentagesarray of integers
  Percentages displayed when collecting a tip
  tipping.huf.smart_tip_thresholdinteger
  Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
- tipping.jpyobject
  Tipping configuration for JPY
  tipping.jpy.fixed_amountsarray of integers
  Fixed amounts displayed when collecting a tip
  tipping.jpy.percentagesarray of integers
  Percentages displayed when collecting a tip
  tipping.jpy.smart_tip_thresholdinteger
  Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
- tipping.mxnobject
  Tipping configuration for MXN
  tipping.mxn.fixed_amountsarray of integers
  Fixed amounts displayed when collecting a tip
  tipping.mxn.percentagesarray of integers
  Percentages displayed when collecting a tip
  tipping.mxn.smart_tip_thresholdinteger
  Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
- tipping.myrobject
  Tipping configuration for MYR
  tipping.myr.fixed_amountsarray of integers
  Fixed amounts displayed when collecting a tip
  tipping.myr.percentagesarray of integers
  Percentages displayed when collecting a tip
  tipping.myr.smart_tip_thresholdinteger
  Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
- tipping.nokobject
  Tipping configuration for NOK
  tipping.nok.fixed_amountsarray of integers
  Fixed amounts displayed when collecting a tip
  tipping.nok.percentagesarray of integers
  Percentages displayed when collecting a tip
  tipping.nok.smart_tip_thresholdinteger
  Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
- tipping.nzdobject
  Tipping configuration for NZD
  tipping.nzd.fixed_amountsarray of integers
  Fixed amounts displayed when collecting a tip
  tipping.nzd.percentagesarray of integers
  Percentages displayed when collecting a tip
  tipping.nzd.smart_tip_thresholdinteger
  Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
- tipping.plnobject
  Tipping configuration for PLN
  tipping.pln.fixed_amountsarray of integers
  Fixed amounts displayed when collecting a tip
  tipping.pln.percentagesarray of integers
  Percentages displayed when collecting a tip
  tipping.pln.smart_tip_thresholdinteger
  Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
- tipping.ronobject
  Tipping configuration for RON
  tipping.ron.fixed_amountsarray of integers
  Fixed amounts displayed when collecting a tip
  tipping.ron.percentagesarray of integers
  Percentages displayed when collecting a tip
  tipping.ron.smart_tip_thresholdinteger
  Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
- tipping.sekobject
  Tipping configuration for SEK
  tipping.sek.fixed_amountsarray of integers
  Fixed amounts displayed when collecting a tip
  tipping.sek.percentagesarray of integers
  Percentages displayed when collecting a tip
  tipping.sek.smart_tip_thresholdinteger
  Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
- tipping.sgdobject
  Tipping configuration for SGD
  tipping.sgd.fixed_amountsarray of integers
  Fixed amounts displayed when collecting a tip
  tipping.sgd.percentagesarray of integers
  Percentages displayed when collecting a tip
  tipping.sgd.smart_tip_thresholdinteger
  Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
- tipping.usdobject
  Tipping configuration for USD
  tipping.usd.fixed_amountsarray of integers
  Fixed amounts displayed when collecting a tip
  tipping.usd.percentagesarray of integers
  Percentages displayed when collecting a tip
  tipping.usd.smart_tip_thresholdinteger
  Below this amount, fixed amounts will be displayed; above it, percentages will be displayed

verifone_p400object
An object containing device type specific settings for Verifone P400 readers
- verifone_p400.splashscreenstring
  A File ID representing an image you would like displayed on the reader.

More parameters

namestring
Name of the configuration

offlineobject
Configurations for collecting transactions offline.
- offline.enabledbooleanRequired
  Determines whether to allow transactions to be collected while reader is offline. Defaults to false.

reboot_windowobjectPreview feature
Reboot time settings for readers that support customized reboot time configuration.
- reboot_window.end_hourintegerRequired
  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_hourintegerRequired
  Integer between 0 to 23 that represents the start hour of the reboot time window.

wifiobject

Configurations for connecting to a WiFi network.

wifi.typeenumRequired

Security type of the WiFi network. Fill out the hash with the corresponding name to provide the set of 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).

wifi.enterprise_eap_peapobject
Credentials for a WPA-Enterprise WiFi network using the EAP-PEAP authentication method.
- wifi.enterprise_eap_peap.passwordstringRequired
  Password for connecting to the WiFi network
- wifi.enterprise_eap_peap.ssidstringRequired
  Name of the WiFi network
- wifi.enterprise_eap_peap.usernamestringRequired
  Username for connecting to the WiFi network
- wifi.enterprise_eap_peap.ca_certificate_filestring
  A File ID representing a PEM file containing the server certificate

wifi.enterprise_eap_tlsobject
Credentials for a WPA-Enterprise WiFi network using the EAP-TLS authentication method.
- wifi.enterprise_eap_tls.client_certificate_filestringRequired
  A File ID representing a PEM file containing the client certificate
- wifi.enterprise_eap_tls.private_key_filestringRequired
  A File ID representing a PEM file containing the client RSA private key
- wifi.enterprise_eap_tls.ssidstringRequired
  Name of the WiFi network
- wifi.enterprise_eap_tls.ca_certificate_filestring
  A File ID representing a PEM file containing the server certificate
- wifi.enterprise_eap_tls.private_key_file_passwordstring
  Password for the private key file

wifi.personal_pskobject
Credentials for a WPA-Personal WiFi network.
- wifi.personal_psk.passwordstringRequired
  Password for connecting to the WiFi network
- wifi.personal_psk.ssidstringRequired
  Name of the WiFi network

Returns

Returns a Configuration object if the update succeeds.

POST /v1/terminal/configurations/:id

Server-side language

curl https://api.stripe.com/v1/terminal/configurations/tmc_FQqbaQCiy0m1xc \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -d "bbpos_wisepos_e[splashscreen]"=file_1NtDiHBHO5VeT9SUjuWGkEAN

Response

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

Update a Configuration

Parameters

bbpos_wisepos_eobject

bbpos_wisepos_e.splashscreenstring

stripe_s700object

stripe_s700.splashscreenstring

tippingobject

tipping.aedobject

tipping.aed.fixed_amountsarray of integers

tipping.aed.percentagesarray of integers

tipping.aed.smart_tip_thresholdinteger

tipping.audobject

tipping.aud.fixed_amountsarray of integers

tipping.aud.percentagesarray of integers

tipping.aud.smart_tip_thresholdinteger

tipping.bgnobject

tipping.bgn.fixed_amountsarray of integers

tipping.bgn.percentagesarray of integers

tipping.bgn.smart_tip_thresholdinteger

tipping.cadobject

tipping.cad.fixed_amountsarray of integers

tipping.cad.percentagesarray of integers

tipping.cad.smart_tip_thresholdinteger

tipping.chfobject

tipping.chf.fixed_amountsarray of integers

tipping.chf.percentagesarray of integers

tipping.chf.smart_tip_thresholdinteger

tipping.czkobject

tipping.czk.fixed_amountsarray of integers

tipping.czk.percentagesarray of integers

tipping.czk.smart_tip_thresholdinteger

tipping.dkkobject

tipping.dkk.fixed_amountsarray of integers

tipping.dkk.percentagesarray of integers

tipping.dkk.smart_tip_thresholdinteger

tipping.eurobject

tipping.eur.fixed_amountsarray of integers

tipping.eur.percentagesarray of integers

tipping.eur.smart_tip_thresholdinteger

tipping.gbpobject

tipping.gbp.fixed_amountsarray of integers

tipping.gbp.percentagesarray of integers

tipping.gbp.smart_tip_thresholdinteger

tipping.hkdobject

tipping.hkd.fixed_amountsarray of integers

tipping.hkd.percentagesarray of integers

tipping.hkd.smart_tip_thresholdinteger

tipping.hufobject

tipping.huf.fixed_amountsarray of integers

tipping.huf.percentagesarray of integers

tipping.huf.smart_tip_thresholdinteger

tipping.jpyobject

tipping.jpy.fixed_amountsarray of integers

tipping.jpy.percentagesarray of integers

tipping.jpy.smart_tip_thresholdinteger

tipping.mxnobject

tipping.mxn.fixed_amountsarray of integers

tipping.mxn.percentagesarray of integers

tipping.mxn.smart_tip_thresholdinteger

tipping.myrobject

tipping.myr.fixed_amountsarray of integers

tipping.myr.percentagesarray of integers

tipping.myr.smart_tip_thresholdinteger

tipping.nokobject

tipping.nok.fixed_amountsarray of integers

tipping.nok.percentagesarray of integers

tipping.nok.smart_tip_thresholdinteger

tipping.nzdobject

tipping.nzd.fixed_amountsarray of integers

tipping.nzd.percentagesarray of integers

tipping.nzd.smart_tip_thresholdinteger

tipping.plnobject

tipping.pln.fixed_amountsarray of integers

tipping.pln.percentagesarray of integers

tipping.pln.smart_tip_thresholdinteger

tipping.ronobject

tipping.ron.fixed_amountsarray of integers

tipping.ron.percentagesarray of integers

tipping.ron.smart_tip_thresholdinteger

tipping.sekobject

More parameters