Update Stripe Connect Gateway

PUT 
/v2/gateways/stripe_connect

Use this endpoint to configure Stripe Connect in Commerce.

note

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

Request

application/json

Body

data object

enabled boolean

Specifies whether the gateway is enabled or disabled. Set true to enable the gateway and false to disable the gateway. Default is false.

stripe_account stringrequired

Specifies the Stripe Connect account ID.

test boolean

Specifies whether the test mode is enabled. Set true to enable test mode and false to disable the test mode. Default is false.

Responses

200

OK

application/json

Schema

Schema

data object

enabled boolean

Specifies whether the gateway is enabled or disabled. Set true to enable the gateway and false to disable the gateway. Default is false.

stripe_account string

Specifies the Stripe Connect account ID.

name string

Specifies the name of the gateway.

test boolean

Specifies whether the test mode is enabled. Set true to enable test mode and false to disable the test mode. Default is false.

slug string

Represents the slug of the gateway.

type string

Specifies the type of object being returned.

Example (from schema)

{
  "data": {
    "enabled": true,
    "stripe_account": "{{stripeConnectAccountId}}",
    "name": "Stripe Connect",
    "test": true,
    "slug": "stripe_connect",
    "type": "gateway"
  }
}

401

Unauthorized

application/json

Schema

Schema

detail string
status string
title string

Example (from schema)

[
  null
]

Example

{
  "errors": {
    "status": 401,
    "title": "Unauthorized"
  }
}

Loading...