WooCommerce · Schema
PaymentGateway
A payment gateway installed in the WooCommerce store.
eCommerceOpen SourceOrdersProductsWordPress
Properties
| Name | Type | Description |
|---|---|---|
| id | string | Payment gateway unique string identifier (e.g. stripe, paypal). |
| title | string | Gateway display name shown to customers at checkout. |
| description | string | Gateway description shown at checkout. |
| order | integer | Gateway display order at checkout. |
| enabled | boolean | Whether the gateway is active and available at checkout. |
| method_title | string | Admin label for the gateway. |
| method_description | string | Admin description of the gateway. |
| method_supports | array | Features supported by this gateway (e.g. products, refunds, subscriptions). |
| settings | object | Gateway settings as a key-value map. Each setting has id, label, description, type, value, and tip properties. |
JSON Schema
{
"$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-schema.json",
"title": "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": "integer",
"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": {}
}
}
}