Update PayPal Express Checkout

PUT 
/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

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.

payer_id stringrequired

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

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.

payer_id string

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

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,
    "payer_id": "{{merchant account id}}",
    "name": "PayPal Express Checkout",
    "test": true,
    "slug": "paypal_express_checkout",
    "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...