Get a Gateway

GET 
https://useast.api.elasticpath.com/v2/gateways/:gatewaySlug

Retrieves the specified gateway.

Request

Path Parameters

gatewaySlug stringrequired

Possible values: [manual, braintree, stripe, stripe_payment_intents, stripe_connect, elastic_path_payments_stripe, paypal_express_checkout, adyen, authorize_net, card_connect, cyber_source]

The slug of the gateway.

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
loginstring
Represents your login ID.
namestring
Represents the name of the gateway.
Example: {gatewayName}
typestring
Specifies the type of object being returned.
Example: gateway
passwordstring
Specifies your password.
signaturestring
slugstring
Specifies the slug of the gateway.
Example: {gatewaySlug}
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: false

Example (auto)

{
  "data": {
    "enabled": true,
    "login": "string",
    "name": "{gatewayName}",
    "type": "gateway",
    "password": "string",
    "signature": "string",
    "slug": "{gatewaySlug}",
    "test": false
  }
}

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.Get, "https://useast.api.elasticpath.com/v2/gateways/:gatewaySlug");
request.Headers.Add("Accept", "application/json");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://useast.api.elasticpath.com

Parameters

gatewaySlug — pathrequired

---manualbraintreestripestripe_payment_intentsstripe_connectelastic_path_payments_stripepaypal_express_checkoutadyenauthorize_netcard_connectcyber_source

ResponseClear

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