PaymentTypeCollection

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/lightspeed/main/json-schema/lightspeed-payment-type-collection-schema.json",
  "title": "PaymentTypeCollection",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/lightspeed-payment-types-api-openapi.yml#/components/schemas/PaymentTypeCollection",
  "properties": {
    "data": {
      "description": "An array of payment types.",
      "items": {
        "$ref": "#/$defs/PaymentType"
      },
      "type": "array"
    },
    "version": {
      "$ref": "#/$defs/Version"
    }
  },
  "required": [
    "data",
    "version"
  ],
  "type": "object",
  "$defs": {
    "GlobalPaymentType": {
      "description": "The global (platform-level) payment type definition associated with a retailer payment type.",
      "properties": {
        "badge": {
          "description": "URL of the payment type badge image.",
          "type": [
            "string",
            "null"
          ]
        },
        "category": {
          "description": "The category of the payment type.",
          "type": "string"
        },
        "configuration_url": {
          "description": "URL for configuring this payment type.",
          "type": [
            "string",
            "null"
          ]
        },
        "description": {
          "description": "A description of the payment type.",
          "type": [
            "string",
            "null"
          ]
        },
        "header": {
          "description": "The display header for the payment type.",
          "type": [
            "string",
            "null"
          ]
        },
        "id": {
          "description": "The global payment type ID.",
          "format": "int64",
          "type": "integer"
        },
        "internal": {
          "description": "Indicates if this is an internal payment type.",
          "type": "boolean"
        },
        "logo": {
          "description": "URL of the payment type logo.",
          "type": [
            "string",
            "null"
          ]
        },
        "name": {
          "description": "The name of the global payment type.",
          "type": "string"
        },
        "online_only": {
          "description": "Indicates if this payment type is available online only.",
          "type": "boolean"
        },
        "platforms": {
          "description": "The platforms on which this payment type is supported.",
          "items": {
            "type": "string"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "referred_inactive": {
          "description": "Indicates if the payment type was referred but is inactive.",
          "type": "boolean"
        },
        "show_banner": {
          "description": "Indicates if a banner should be shown for this payment type.",
          "type": "boolean"
        },
        "subcategory": {
          "description": "The subcategory of the payment type.",
          "type": "string"
        },
        "subtext": {
          "description": "Additional display text shown below the payment type name.",
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "id",
        "name",
        "internal",
        "platforms",
        "category",
        "subcategory",
        "referred_inactive",
        "show_banner",
        "online_only"
      ],
      "type": "object"
    },
    "PaymentType": {
      "properties": {
        "config": {
          "additionalProperties": true,
          "description": "Payment type configuration. Shape varies by payment type.",
          "type": [
            "object",
            "null"
          ]
        },
        "created_at": {
          "description": "The creation timestamp.",
          "format": "date-time",
          "type": [
            "string",
            "null"
          ]
        },
        "deleted_at": {
          "description": "The deletion timestamp.",
          "format": "date-time",
          "type": [
            "string",
            "null"
          ]
        },
        "disabled": {
          "description": "Indicates if the payment type is disabled.",
          "type": "boolean"
        },
        "gateway": {
          "description": "Indicates if the payment type is a gateway type.",
          "type": "boolean"
        },
        "id": {
          "description": "Auto-generated object ID.",
          "type": "string"
        },
        "internal": {
          "description": "Indicates if the payment type is for internal use only.",
          "type": "boolean"
        },
        "is_editable": {
          "description": "Indicates if the payment type can be edited. Omitted when not applicable.",
          "type": [
            "boolean",
            "null"
          ]
        },
        "name": {
          "description": "The name of the payment type.",
          "type": "string"
        },
        "name_changed_by_user": {
          "description": "Indicates if the name was customised by the retailer.",
          "type": "boolean"
        },
        "outlet_ids": {
          "description": "The list of outlet IDs this payment type is associated with.",
          "items": {
            "type": "string"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "payment_type": {
          "$ref": "#/$defs/GlobalPaymentType"
        },
        "type_id": {
          "description": "The ID of the global payment type. It shouldn't be used to identify the payment type - there may be multiple payment types with the same `type_id`.",
          "type": "integer"
        },
        "version": {
          "description": "Auto-incrementing object version number.",
          "format": "int64",
          "type": "integer"
        }
      },
      "required": [
        "id",
        "name",
        "type_id",
        "version",
        "disabled",
        "internal"
      ],
      "type": "object"
    },
    "Version": {
      "description": "An object containing the highest and lowest version numbers for all items of the returned collection.",
      "properties": {
        "max": {
          "description": "Highest version number of the payload, or `null` when the result set is empty.",
          "format": "int64",
          "type": [
            "integer",
            "null"
          ]
        },
        "min": {
          "description": "Lowest version number of the payload, or `null` when the result set is empty.",
          "format": "int64",
          "type": [
            "integer",
            "null"
          ]
        }
      },
      "required": [
        "max",
        "min"
      ],
      "type": "object"
    }
  }
}