# Retrieve a gateway

`GET https://api.cademi.com.br/api/v3/sales/gateways/{gateway_id}`

Operation ID: `gateways.get` · API v3

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.

Required permissions: `gateways.read`.

## Parameters

| Name | In | Type | Required | Description |
|---|---|---|---|---|
| `gateway_id` | path | string | yes |  |

## Responses

### 200

Returns the requested gateway.

Body: `data`: Gateway.

Fields of Gateway:

| Field | Type | Required | Description |
|---|---|---|---|
| `capabilities` | object | yes |  |
| `featured` | boolean | yes |  |
| `help_url` | string or null | yes |  |
| `icon_url` | string or null | yes |  |
| `id` | string | yes | Public ID of the payment gateway: gtw_ followed by the gateway's catalog key. |
| `labels` | object | yes | The name the payment gateway uses for each field in its own documentation. |
| `name` | string | yes |  |
| `object` | string, one of `gateway` | yes |  |

### 401

The credential is missing, malformed, expired, or revoked.

Body: Error.

### 403

The current credentials do not have the permission required by this operation.

Body: Error.

### 404

The gateway is not in the catalog.

Body: Error.

Full schema: https://cademi.dev/openapi/v3.json