WooCommerce · Schema

PaymentGatewayInput

Input for updating a payment gateway.

eCommerceOpen SourceOrdersProductsWordPress

Properties

Name Type Description
enabled boolean Whether to enable the gateway.
settings object Gateway settings to update.
View JSON Schema on GitHub

JSON Schema

woocommerce-rest-api-payment-gateway-input-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/woocommerce/refs/heads/main/json-schema/woocommerce-rest-api-payment-gateway-input-schema.json",
  "title": "PaymentGatewayInput",
  "description": "Input for updating a payment gateway.",
  "type": "object",
  "properties": {
    "enabled": {
      "type": "boolean",
      "description": "Whether to enable the gateway.",
      "example": true
    },
    "settings": {
      "type": "object",
      "description": "Gateway settings to update.",
      "additionalProperties": true,
      "example": {}
    }
  }
}