close
Core Resources
Payment Methods
Products
Commerce
Agentic Commerce
Checkout
Payment Links
Billing
Capital
Connect
Reserves
Fraud
Issuing
Terminal
Treasury for Platforms
Payment Records
Account Evaluation
Entitlements
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Forwarding
Privacy
Webhooks

Configurations

A Configurations object represents how features should be configured for terminal readers. For information about how to use it, see the Terminal configurations documentation.

Was this section helpful?YesNo
Create a Configuration
POST/v1/terminal/configurations
Update a Configuration
POST/v1/terminal/configurations/:id
Retrieve a Configuration
GET/v1/terminal/configurations/:id
List all Configurations
GET/v1/terminal/configurations
Delete a Configuration
DELETE/v1/terminal/configurations/:id

The Configuration object

Attributes

  • idstring

    Unique identifier for the object.

  • bbpos_wisepad3nullable object

    An object containing device type specific settings for BBPOS WisePad 3

  • 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, value is "terminal.configuration"

  • cellularnullable object

  • livemodeboolean

  • namenullable string

  • offlinenullable object

  • reader_securitynullable objectPreview feature

  • reboot_windownullable objectPreview feature

  • stripe_s710nullable object

  • verifone_m425nullable object

  • verifone_p630nullable object

  • verifone_ux700nullable object

  • verifone_v660pnullable object

  • wifinullable object

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

Create a Configuration

POST /v1/terminal/configurations

Creates a new Configuration object.

Parameters

  • bbpos_wisepad3object

    An object containing device type specific settings for BBPOS WisePad 3 readers.

  • 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 that support on-reader tips.

  • verifone_p400object

    An object containing device type specific settings for Verifone P400 readers.

More parameters

  • cellularobject

  • namestring

  • offlineobject

  • reader_securityobjectPreview feature

  • reboot_windowobjectPreview feature

  • stripe_s710object

  • verifone_m425object

  • verifone_p630object

  • verifone_ux700object

  • verifone_v660pobject

  • wifiobject

Returns

Returns a Configuration object if creation succeeds.

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