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

Create a Configuration 

Creates a new Configuration object.

Parameters

  • bbpos_wisepos_eassociative array

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

  • stripe_s700associative array

    An object containing device type specific settings for Stripe S700 readers

  • tippingassociative array

    Tipping configurations for readers supporting on-reader tips

  • verifone_p400associative array

    An object containing device type specific settings for Verifone P400 readers

More parameters

  • namestring

  • offlineassociative array

  • reboot_windowassociative arrayPreview feature

  • wifiassociative array

Returns

Returns a Configuration object if creation succeeds.

POST /v1/terminal/configurations
$stripe = new \Stripe\StripeClient('sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2');
$configuration = $stripe->terminal->configurations->create([]);
Response
{
  "id": "tmc_FQqbaQCiy0m1xc",
  "object": "terminal.configuration",
  "is_account_default": false,
  "livemode": false
}

Update a Configuration 

Updates a new Configuration object.

Parameters

  • bbpos_wisepos_eassociative array

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

  • stripe_s700associative array

    An object containing device type specific settings for Stripe S700 readers

  • tippingassociative array

    Tipping configurations for readers supporting on-reader tips

  • verifone_p400associative array

    An object containing device type specific settings for Verifone P400 readers

More parameters

  • namestring

  • offlineassociative array

  • reboot_windowassociative arrayPreview feature

  • wifiassociative array

Returns

Returns a Configuration object if the update succeeds.

POST /v1/terminal/configurations/:id
$stripe = new \Stripe\StripeClient('sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2');
$configuration = $stripe->terminal->configurations->update(
  'tmc_FQqbaQCiy0m1xc',
  ['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
$stripe = new \Stripe\StripeClient('sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2');
$configuration = $stripe->terminal->configurations->retrieve(
  'tmc_FQqbaQCiy0m1xc',
  []
);
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 associative array 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
$stripe = new \Stripe\StripeClient('sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2');
$configurations = $stripe->terminal->configurations->all(['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
    }
  ]
}

Delete a Configuration 

Deletes a Configuration object.

Parameters

No parameters.

Returns

Returns the Configuration object that was deleted.

DELETE /v1/terminal/configurations/:id
$stripe = new \Stripe\StripeClient('sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2');
$deleted = $stripe->terminal->configurations->delete('tmc_FQqbaQCiy0m1xc', []);
Response
{
  "id": "tmc_FQqbaQCiy0m1xc",
  "object": "terminal.configuration",
  "deleted": true
}