Configure Elastic Path Payments Powered by Stripe – Elastic Path Composable Commerce: Docs

`PUT` Update Elastic Path Payments Powered by Stripe settings

https://useast.api.elasticpath.com/v2/gateways/elastic_path_payments_stripe

Use the /gateways/elastic_path_payments_stripe endpoint to configure Elastic Path Payments Powered by Stripe in Commerce.

You can contact Elastic Path sales or customer success team to get more information about Elastic Path Payments Powered by Stripe and to check whether it will work for you.

Parameters

Headers

Name	Required	Type	Description
`Authorization`	Required	`string`	The Bearer token required to get access to the API.

Body

Attribute	Required	Type	Description
`stripe_account`	Required	`string`	Specifies the Stripe account ID.
`type`	Required	`string`	Specifies the type of the resource. You must use `gateway`. This field cannot be edited.
`name`	Optional	`string`	Specifies the display name of the gateway. This field cannot be edited.
`slug`	Optional	`string`	Specifies a unique slug for this gateway. This field cannot be edited.
`enabled`	Required	`boolean`	Specifies whether the gateway is enabled. The options are `true` or `false`.
`test`	Required	`boolean`	Specifies whether the test mode is enabled. The options are `true` or `false`.

Object example

{
  "data": {
    "enabled": true,
    "stripe_account": "acct_xxx",
    "name": "Elastic Path Payments powered by Stripe",
    "slug": "elastic_path_payments_stripe",
    "test": true,
    "type": "gateway"
  }
}

Request Example

curl -X PUT https://useast.api.elasticpath.com/v2/gateways/elastic_path_payments_stripe \
     -H "Authorization: Bearer XXX" \
     -H "Content-Type: application/json" \
     -d $'{
       "data": {
         "enabled": true,
         "stripe_account": "acct_xxx"
         "test": true,
       }
     }'

Response Example

200 OK

{
  "data": {
    "enabled": true,
    "test": true,
    "stripe_account": "acct_xxx",
    "name": "Elastic Path Payments powered by Stripe",
    "slug": "elastic_path_payments_stripe",
    "type": "gateway"
  }
}

PUT Update Elastic Path Payments Powered by Stripe settings