Create a Configuration

Terminal

Configuration

Creates 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 you would like displayed 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.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.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.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.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.

Returns

Returns a Configuration object if creation succeeds.

POST /v1/terminal/configurations

Server-side language

curl -X POST https://api.stripe.com/v1/terminal/configurations \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:"

Response

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

Create a Configuration

Parameters

bbpos_wisepos_eobject

bbpos_wisepos_e.splashscreenstring

stripe_s700object

stripe_s700.splashscreenstring

tippingobject

tipping.audobject

tipping.aud.fixed_amountsarray of integers

tipping.aud.percentagesarray of integers

tipping.aud.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.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.sekobject

tipping.sek.fixed_amountsarray of integers

tipping.sek.percentagesarray of integers

tipping.sek.smart_tip_thresholdinteger

tipping.sgdobject

tipping.sgd.fixed_amountsarray of integers

tipping.sgd.percentagesarray of integers

tipping.sgd.smart_tip_thresholdinteger

tipping.usdobject

tipping.usd.fixed_amountsarray of integers

tipping.usd.percentagesarray of integers

tipping.usd.smart_tip_thresholdinteger

verifone_p400object

verifone_p400.splashscreenstring

More parametersCollapse all

namestring

offlineobject

offline.enabledbooleanRequired

reboot_windowobjectPreview feature

reboot_window.end_hourintegerRequired

reboot_window.start_hourintegerRequired

Returns

More parameters