---
title: "Shows an CompanyGateway"
method: GET
path: "/api/v1/company_gateways/{id}"
tags: ["company_gateways"]
---

# Shows an CompanyGateway

`GET /api/v1/company_gateways/{id}`

## Request

- Base URL: `https://demo.invoiceninja.com`
- URL: `https://demo.invoiceninja.com/api/v1/company_gateways/{id}`
- Auth: none declared. Required headers: `X-API-TOKEN`, `X-Requested-With`
- TypeScript: <https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference/docs/api/v1/company_gateways/:id/get.ts> (a function with typed inputs; its response is checked against the schema)

Displays an CompanyGateway by id

## Path parameters

- `id` string, string, required

## Query parameters

- `include` string

## Headers

- `X-API-TOKEN` string, required
- `X-Requested-With` string, required

## Response `200`

Returns the CompanyGateway object

- CompanyGateway
  - `id` string: The hashed id of the company gateway
  - `gateway_key` string: The gateway key (hash)
  - `accepted_credit_cards` integer: Bitmask representation of cards
  - `require_billing_address` boolean: Determines if the the billing address is required prior to payment.
  - `require_shipping_address` boolean: Determines if the the billing address is required prior to payment.
  - `config` string: The configuration map for the gateway
  - `update_details` boolean: Determines if the client details should be updated.
  - `fees_and_limits` FeesAndLimits[]: A mapped collection of the fees and limits for the configured gateway
    - `min_limit` string: The minimum amount accepted for this gateway
    - `max_limit` string: The maximum amount accepted for this gateway
    - `fee_amount` number, float: The gateway fee amount
    - `fee_percent` number, float: The gateway fee percentage
    - `fee_tax_name1` string: Fee tax name
    - `fee_tax_name2` string: Fee tax name
    - `fee_tax_name3` string: Fee tax name
    - `fee_tax_rate1` number, float: The tax rate
    - `fee_tax_rate2` number, float: The tax rate
    - `fee_tax_rate3` number, float: The tax rate
    - `fee_cap` number, float: If set the fee amount will be no higher than this amount
    - `adjust_fee_percent` boolean: Adjusts the fee to match the exact gateway fee.

## Other responses

- `401`: Authentication error
- `403`: Authorization error
- `422`: Validation error
- `default`: Unexpected Error

## Changes

- **2026-04-20** `69a36036d334`: 1 info
  - the response optional property `id` became read-only for the status `200`
- **2024-06-06** `8e82a2bd77e0`: 2 breaking, 14 info
  - the response's body type changed from no type to `object` for status `default`
  - the `fees_and_limits/items/` response's property type changed from no type to `object` for status `200`
  - added the optional property `code` to the response with the `default` status
  - added the optional property `fees_and_limits/items/adjust_fee_percent` to the response with the `200` status
  - …12 more
- **2024-06-05** `e61df65649e2`: 1 breaking, 2 warning
  - the response's body type changed from `object` to no type for status `default`
  - removed the optional property `code` from the response with the `default` status
  - removed the optional property `message` from the response with the `default` status
- **2024-06-05** `4ca478d85068`: 1 breaking, 12 warning
  - the `fees_and_limits/items/` response's property type changed from `object` to no type for status `200`
  - removed the optional property `fees_and_limits/items/adjust_fee_percent` from the response with the `200` status
  - removed the optional property `fees_and_limits/items/fee_amount` from the response with the `200` status
  - removed the optional property `fees_and_limits/items/fee_cap` from the response with the `200` status
  - …9 more
- …earlier changes not shown

[Operation history](https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference/changes/api/v1/company_gateways/:id/get.md)

---

[API](https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference.md) - [All operations](https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference/revisions/bcda1f823746?raw)