Update Stripe Connect Gateway

PUT 
https://useast.api.elasticpath.com/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

enabledboolean

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

stripe_accountstringrequired

Specifies the Stripe Connect account ID.

testboolean

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
enabledboolean
Specifies whether the gateway is enabled or disabled. Set true to enable the gateway and false to disable the gateway. Default is false.
Example: true
stripe_accountstring
Specifies the Stripe Connect account ID.
Example: {{stripeConnectAccountId}}
namestring
Specifies the name of the gateway.
Example: Stripe Connect
testboolean
Specifies whether the test mode is enabled. Set true to enable test mode and false to disable the test mode. Default is false.
Example: true
slugstring
Represents the slug of the gateway.
Example: stripe_connect
typestring
Specifies the type of object being returned.
Example: gateway

Example (auto)

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

401

Unauthorized

application/json

Schema

Schema

detailstring
statusstring
titlestring

Example (auto)

[
  null
]

Example

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

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://useast.api.elasticpath.com/v2/gateways/stripe_connect");
request.Headers.Add("Accept", "application/json");
var content = new StringContent("{\n  \"data\": {\n    \"enabled\": true,\n    \"stripe_account\": \"string\",\n    \"test\": true\n  }\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://useast.api.elasticpath.com

Body

• Example (from schema)
• default

{
  "data": {
    "enabled": true,
    "stripe_account": "string",
    "test": true
  }
}

ResponseClear

Click the Send API Request button above and see the response here!