Lightspeed · JSON Structure

Restaurant K Series Ape Order Payment Structure

apeOrderPayment schema from Lightspeed Restaurant K Series API

Type: object Properties: 3 Required: 1
POSRetailRestaurantEcommerce

apeOrderPayment is a JSON Structure definition published by Lightspeed, describing 3 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

paymentMethod paymentAmount tipAmount

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/lightspeed-pos/refs/heads/main/json-structure/restaurant-k-series-ape-order-payment-structure.json",
  "name": "apeOrderPayment",
  "description": "apeOrderPayment schema from Lightspeed Restaurant K Series API",
  "type": "object",
  "properties": {
    "paymentMethod": {
      "example": "OOPAYMENT",
      "description": "Payment method code as configured by the merchant.",
      "type": "string"
    },
    "paymentAmount": {
      "example": 14.0,
      "description": "The total amount of the payment including tips if any.",
      "type": "double"
    },
    "tipAmount": {
      "example": 2.0,
      "description": "The tip amount, if any.",
      "type": "double"
    }
  },
  "required": [
    "paymentAmount"
  ]
}