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? Yes No

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

• id string Unique identifier for the object.
• bbpos _ wisepad3 nullable object An object containing device type specific settings for the related setting WisePad 3
• bbpos _ wisepos _ e nullable object An object containing device type specific settings for the related setting WisePOS E
• is _ account _ default nullable boolean Whether this Configuration is the default for your account
• stripe _ s700 nullable object An object containing device type specific settings for Stripe the related setting
• tipping nullable object On-reader tipping settings
• verifone _ p400 nullable object An object containing device type specific settings for Verifone the related setting

More attributes

• object string, value is "terminal.configuration"
• cellular nullable object
• livemode boolean
• name nullable string
• offline nullable object
• reader _ security nullable object Preview feature
• reboot _ window nullable object Preview feature
• stripe _ s710 nullable object
• verifone _ m425 nullable object
• verifone _ p630 nullable object
• verifone _ ux700 nullable object
• verifone _ v660p nullable object
• wifi nullable object

The Configuration object

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

Create a Configuration

POST / v1 / terminal / configurations

Creates a new Configuration object.

Parameters

• bbpos _ wisepad3 object An object containing device type specific settings for the related setting WisePad 3 readers.
• bbpos _ wisepos _ e object An object containing device type specific settings for the related setting WisePOS E readers.
• stripe _ s700 object An object containing device type specific settings for Stripe the related setting readers.
• tipping object Tipping configurations for readers that support on-reader tips.
• verifone _ p400 object An object containing device type specific settings for Verifone the related setting readers.

More parameters

• cellular object
• name string
• offline object
• reader _ security object Preview feature
• reboot _ window object Preview feature
• stripe _ s710 object
• verifone _ m425 object
• verifone _ p630 object
• verifone _ ux700 object
• verifone _ v660p object
• wifi object

Returns

Returns a Configuration object if creation succeeds.

Response

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