Update PayPal Express Checkout

PUT 
https://useast.api.elasticpath.com/v2/gateways/paypal_express_checkout

Use this endpoint to configure PayPal Express Checkout.

note

To learn more about PayPal Express Checkout and check whether it will work for you, contact your sales or customer success team.

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.

payer_idstringrequired

Specifies the merchant account ID. The ID is displayed in the PayPal account details of the merchant.

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
payer_idstring
Specifies the merchant account ID. The ID is displayed in the PayPal account details of the merchant.
Example: {{merchant account id}}
namestring
Specifies the name of the gateway.
Example: PayPal Express Checkout
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: paypal_express_checkout
typestring
Specifies the type of object being returned.
Example: gateway

Example (auto)

{
  "data": {
    "enabled": true,
    "payer_id": "{{merchant account id}}",
    "name": "PayPal Express Checkout",
    "test": true,
    "slug": "paypal_express_checkout",
    "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/paypal_express_checkout");
request.Headers.Add("Accept", "application/json");
var content = new StringContent("{\n  \"data\": {\n    \"enabled\": true,\n    \"payer_id\": \"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,
    "payer_id": "string",
    "test": true
  }
}

ResponseClear

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