activities4

auth6

bank_integrations11

bank_transaction_rules8

bank_transactions9

charts4

claim_license1

client_gateway_tokens7

clients14

companies10

company_gateways8

company_ledger1

company_user1

connected_account1

credits8

Credits1

designs8

documents1

emails1

expense1

expense_categories8

expenses8

export1

group_settings9

health_check1

import1

imports2

invoices12

locations7

logout1

migration3

one_time_token1

payment_terms7

payment_termss1

payments11

ping2

postmark3

preview2

products9

projects9

Purchase Orders11

quotes12

Recurring Invoices11

recurring_expense1

recurring_expenses8

recurring_quotes9

refresh1

reports27

scheduler1

search1

statics1

subscriptions8

support1

system_logs2

tags8

task_schedulers7

task_status8

tasks10

tax_rates7

templates2

tokens8

update2

users11

vendors9

webcron1

webhooks7

Webhooks1

yodlee1

company_gateways

Updates an CompanyGateway

Changed on Apr 20, 2026

Handles the updating of an CompanyGateway by id

put/api/v1/company_gateways/{id}

Request

Base URL
https://demo.invoiceninja.com
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/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring string required

The CompanyGateway Hashed ID

Query parameters

includestring

Example:first_load

Includes child relationships in the response, format is comma separated. Check each model for the list of associated includes

Headers

X-API-TOKENstring required

Example:TOKEN

The API token to be used for authentication

X-Requested-Withstring required

Example:XMLHttpRequest

Used to send the XMLHttpRequest header

Response

Returns the CompanyGateway object

idstring

The hashed id of the company gateway

gateway_keystring

The gateway key (hash)

accepted_credit_cardsinteger

Bitmask representation of cards

require_billing_addressboolean

Determines if the the billing address is required prior to payment.

require_shipping_addressboolean

Determines if the the billing address is required prior to payment.

configstring

The configuration map for the gateway

update_detailsboolean

Determines if the client details should be updated.

Example response

{
  "id": "Opnel5aKBz",
  "gateway_key": "2",
  "accepted_credit_cards": 32,
  "require_billing_address": true,
  "require_shipping_address": true,
  "config": "dfadsfdsafsafd",
  "update_details": true,
  "fees_and_limits": [
    {
      "min_limit": "2",
      "max_limit": "2",
      "fee_amount": 2,
      "fee_percent": 2,
      "fee_tax_name1": "GST",
      "fee_tax_name2": "VAT",
      "fee_tax_name3": "CA Sales Tax",
      "fee_tax_rate1": 10,
      "fee_tax_rate2": 17.5,
      "fee_tax_rate3": 25,
      "fee_cap": 2,
      "adjust_fee_percent": true
    }
  ]
}

Changes

Apr 20, 202669a36036d334 Revision changes
- info
  the response optional property became read-only for the status
Jun 6, 20248e82a2bd77e0 Revision changes
- breaking
  the response's body type changed from no type to object for status
- breaking
  the / response's property type changed from no type to object for status
- info
  added the optional property to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property to the response with the status

Operation history (8 revisions)