WooCommerce · JSON Structure

Woocommerce Rest Api Payment Gateway Structure

A payment gateway installed in the WooCommerce store.

Type: object Properties: 9
E-CommerceOpen-SourceOrderProductWordPress

PaymentGateway is a JSON Structure definition published by WooCommerce, describing 9 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id title description order enabled method_title method_description method_supports settings

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/woocommerce/refs/heads/main/json-structure/woocommerce-rest-api-payment-gateway-structure.json",
  "name": "PaymentGateway",
  "description": "A payment gateway installed in the WooCommerce store.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Payment gateway unique string identifier (e.g. stripe, paypal).",
      "example": "500123"
    },
    "title": {
      "type": "string",
      "description": "Gateway display name shown to customers at checkout.",
      "example": "Example Name"
    },
    "description": {
      "type": "string",
      "description": "Gateway description shown at checkout.",
      "example": "A sample description"
    },
    "order": {
      "type": "int32",
      "description": "Gateway display order at checkout.",
      "example": 1
    },
    "enabled": {
      "type": "boolean",
      "description": "Whether the gateway is active and available at checkout.",
      "example": true
    },
    "method_title": {
      "type": "string",
      "description": "Admin label for the gateway.",
      "example": "Example Name"
    },
    "method_description": {
      "type": "string",
      "description": "Admin description of the gateway.",
      "example": "A sample description"
    },
    "method_supports": {
      "type": "array",
      "description": "Features supported by this gateway (e.g. products, refunds, subscriptions).",
      "items": {
        "type": "string"
      },
      "example": [
        "string-value"
      ]
    },
    "settings": {
      "type": "object",
      "description": "Gateway settings as a key-value map. Each setting has id, label, description, type, value, and tip properties.",
      "additionalProperties": true,
      "example": {}
    }
  }
}

Work with this as data

Every JSON Structure here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for json structure

4 MCP tools reach this
  • find_json_structuresBrowse and filter every JSON Structure in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Structure
curl "https://apis.io/api/v1/json-structures/woocommerce-rest-api-payment-gateway-structure"
All json structure
curl "https://apis.io/api/v1/json-structures?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.