Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Elastic Path Gateways API

The Gateways API from Elastic Path — 12 operation(s) for gateways.

Elastic Path Gateways API is one of 100 APIs that Elastic Path publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Gateways. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 12 operations across 12 paths, and defines 21 schemas. It is described by OpenAPI 3.1.0, at version 25.1126.6886238.

Requests are made against 2 base URLs: https://useast.api.elasticpath.com, https://euwest.api.elasticpath.com.

12 operations 12 paths 21 schemas 2 GET10 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
25.1126.6886238
Base URL
https://useast.api.elasticpath.com
Authentication
HTTP Bearer
License
Resource Areas
1

Authentication & Security 1

Elastic Path Gateways API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerToken). By default, every request must be authenticated.

Paths & Operations 12

Across 12 paths, the API surfaces 12 operations — 2 GET, 10 PUT. Each is listed below with its method, path, parameters, and response codes.

Gateways 12
GET
/v2/gateways
Get all Gateways
getAllGateways → 200401
GET
/v2/gateways/{gatewaySlug}
Get a Gateway
getAGateway 1 param → 200401
PUT
/v2/gateways/manual
Update Manual Gateway
updateManualGateway body → 200401
PUT
/v2/gateways/braintree
Update Braintree Gateway
updateBraintreeGateway body → 200401
PUT
/v2/gateways/stripe
Update Stripe Gateway
updateStripeGateway body → 200401
PUT
/v2/gateways/stripe_payment_intents
Update Stripe Payment Intents Gateway
updateStripeIntentsGateway body → 200401
PUT
/v2/gateways/elastic_path_payments_stripe
Update Elastic Path Payments Powered by Stripe
updateEpPaymentsStripe body → 200401
PUT
/v2/gateways/paypal_express_checkout
Update PayPal Express Checkout
updatePaypalExpressCheckoutGateway body → 200401
PUT
/v2/gateways/adyen
Update Adyen Gateway
updateAdyenGateway body → 200401
PUT
/v2/gateways/authorize_net
Update Authorize.net Gateway
updateAuthorizeNetGateway body → 200401
PUT
/v2/gateways/card_connect
Update CardConnect Gateway
updateCardConnectGateway body → 200401
PUT
/v2/gateways/cyber_source
Update CyberSource Gateway
updateCyberSourceGateway body → 200401

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are Response.Gateway (8 properties), Data.UpdateBraintreeGateway (5 properties), Data.UpdateAdyenGateway (5 properties), UpdateAuthorizeNetGatewayData (5 properties). Each schema is shown below with its type and property counts.

Response.Gateway
object
8 properties
Data.UpdateManualGateway
object
1 property
UpdateAdyenGatewayRequest
object
1 property
Request.UpdateBraintreeGateway
object
1 property
Request.UpdateManualGateway
object
1 property
Data.UpdateStripeGateway
object
2 properties 1 required
UpdateAuthorizeNetGatewayData
object
5 properties 2 required
Data.UpdatePaypalExpressCheckoutGateway
object
3 properties 1 required
Data.ElasticPathPaymentsStripeGateway
object
3 properties 1 required
Response.Error
array
3 properties
Data.UpdateCardConnectGateway
object
5 properties 3 required
Request.UpdateStripeGateway
object
1 property
Data.UpdateCyberSourceGateway
object
4 properties 2 required
Data.UpdateAdyenGateway
object
5 properties 3 required
Data.UpdateBraintreeGateway
object
5 properties 3 required
Request.UpdatePaypalExpressCheckoutGateway
object
1 property
Request.UpdateCardConnectGateway
object
1 property
Request.UpdateElasticPathPaymentsStripeGateway
object
1 property
Response.Data
object
1 property
Request.UpdateAuthorizeNetGateway
object
1 property
Request.UpdateCyberSourceGateway
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elastic-path-gateways-api-openapi.yml Raw ↑

Other APIs Elastic Path publishes across the network.

Elastic Path GraphQL API
Elastic Path Account Addresses API
Elastic Path Account Authentication Settings API
Elastic Path Account Cart Associations API
Elastic Path Account Management Authentication API
Elastic Path Account Members API
Elastic Path Account Membership API
Elastic Path Account Membership Settings API
Elastic Path Account Tags API
Elastic Path Accounts API
Elastic Path Administrator Latest Releases Catalog API API
Elastic Path Application Keys API