Get a Gateway

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

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.

login string

Represents your login ID.

name string

Represents the name of the gateway.

type string

Specifies the type of object being returned.

password string

Specifies your password.

signature string

slug string

Specifies the slug 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.

Example (from schema)

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

401

Unauthorized

application/json

Schema

Schema

detail string
status string
title string

Example (from schema)

[
  null
]

Example

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

Loading...