Core Resources
Payment Methods
Products
Checkout
Payment Links
Billing
Connect
Fraud
Issuing
Terminal
Treasury
Entitlements
Cart
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Forwarding
Webhooks

The Configuration object

Attributes

  • idstring

    Unique identifier for the object.

  • bbpos_wisepos_enullable object

    An object containing device type specific settings for BBPOS WisePOS E

  • 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

  • tippingnullable object

    On-reader tipping settings

  • verifone_p400nullable object

    An object containing device type specific settings for Verifone P400

More attributes

  • objectstring

  • livemodeboolean

  • namenullable string

  • offlinenullable object

  • reboot_windownullable objectPreview feature

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

Create a Configuration

Creates a new Configuration object.

Parameters

  • bbpos_wisepos_eobject

    An object containing device type specific settings for BBPOS WisePOS E readers

  • stripe_s700object

    An object containing device type specific settings for Stripe S700 readers

  • tippingobject

    Tipping configurations for readers supporting on-reader tips

  • verifone_p400object

    An object containing device type specific settings for Verifone P400 readers

More parameters

  • namestring

  • offlineobject

  • reboot_windowobjectPreview feature

Returns

Returns a Configuration object if creation succeeds.

POST /v1/terminal/configurations
curl -X POST https://api.stripe.com/v1/terminal/configurations \
  -u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:"
Response
{
  "id": "tmc_FQqbaQCiy0m1xc",
  "object": "terminal.configuration",
  "is_account_default": false,
  "livemode": false
}

Update a Configuration

Updates a new Configuration object.

Parameters

  • bbpos_wisepos_eobject

    An object containing device type specific settings for BBPOS WisePOS E readers

  • stripe_s700object

    An object containing device type specific settings for Stripe S700 readers

  • tippingobject

    Tipping configurations for readers supporting on-reader tips

  • verifone_p400object

    An object containing device type specific settings for Verifone P400 readers

More parameters

  • namestring

  • offlineobject

  • reboot_windowobjectPreview feature

Returns

Returns a Configuration object if the update succeeds.

POST /v1/terminal/configurations/:id
curl https://api.stripe.com/v1/terminal/configurations/tmc_FQqbaQCiy0m1xc \
  -u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:" \
  -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
}

Retrieve a Configuration

Retrieves a Configuration object.

Parameters

No parameters.

Returns

Returns a Configuration object if a valid identifier was provided.

GET /v1/terminal/configurations/:id
curl https://api.stripe.com/v1/terminal/configurations/tmc_FQqbaQCiy0m1xc \
  -u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:"
Response
{
  "id": "tmc_FQqbaQCiy0m1xc",
  "object": "terminal.configuration",
  "is_account_default": false,
  "livemode": false
}

List all Configurations

Returns a list of Configuration objects.

Parameters

  • is_account_defaultboolean

    if present, only return the account default or non-default configurations.

More parameters

  • ending_beforestring

  • limitinteger

  • starting_afterstring

Returns

A dictionary with a data property that contains an array of up to limit configurations, starting after configurations configurations. Each entry in the array is a separate Terminal configurations object. If no more configurations are available, the resulting array will be empty.

GET /v1/terminal/configurations
curl -G https://api.stripe.com/v1/terminal/configurations \
  -u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:" \
  -d limit=3
Response
{
  "object": "list",
  "url": "/v1/terminal/configurations",
  "has_more": false,
  "data": [
    {
      "id": "tmc_FQqbaQCiy0m1xc",
      "object": "terminal.configuration",
      "is_account_default": false,
      "livemode": false
    }
    {...}
    {...}
  ],
}