Create a Configuration
Creates a new Configuration
object.
Parameters
- bbpos_
wisepos_ eobject An object containing device type specific settings for BBPOS WisePOS E 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
- stripe_
s700object
Returns
Returns a Configuration
object if creation succeeds.
{
"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
- 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
- stripe_
s700object
Returns
Returns a Configuration
object if the update succeeds.
{
"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.
{
"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.
{
"object": "list",
"url": "/v1/terminal/configurations",
"has_more": false,
"data": [
{
"id": "tmc_FQqbaQCiy0m1xc",
"object": "terminal.configuration",
"is_account_default": false,
"livemode": false
}
{...}
{...}
],
}
Delete a Configuration
Deletes a Configuration
object.
Parameters
No parameters.
Returns
Returns the Configuration
object that was deleted.
{
"id": "tmc_FQqbaQCiy0m1xc",
"object": "terminal.configuration",
"deleted": true
}