Retrieve a gateway

GET/sales/gateways/{gateway_id}

Retrieves a payment gateway from the catalog. Gateway IDs use the gtw_ prefix followed by the gateway key, for example gtw_<alias>; the key without the prefix is not accepted.

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Path Parameters

gateway_id*string

Public ID of the gateway, prefixed with gtw_.

Header Parameters

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/sales/gateways/string"
{  "data": {    "capabilities": {      "beta": true,      "requires_secret": true,      "subscriptions": true,      "subscriptions_only": true    },    "featured": true,    "help_url": "string",    "icon_url": "string",    "id": "string",    "labels": {      "external_id": "string",      "secret": "string"    },    "name": "string",    "object": "gateway"  }}