GetTerminalCheckout

{
  "type": "object",
  "properties": {
    "checkout": {
      "type": "object",
      "required": [
        "amount_money",
        "device_options"
      ],
      "properties": {
        "amount_money": {
          "type": "object",
          "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.",
          "properties": {
            "amount": {
              "type": "integer",
              "format": "int64",
              "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case."
            },
            "currency": {
              "type": "string",
              "description": "The type of currency, in __ISO 4217 format__. For example, the currency\ncode for US dollars is `USD`.\n\nSee [Currency](https://developer.squareup.com/reference/square_2021-08-18/enums/Currency) for possible values."
            }
          }
        },
        "app_id": {
          "type": "string",
          "description": "The ID of the application that created the checkout."
        },
        "cancel_reason": {
          "type": "string",
          "description": "Present if the status is `CANCELED`."
        },
        "created_at": {
          "type": "string",
          "description": "The time when the `TerminalCheckout` was created, as an RFC 3339 timestamp."
        },
        "deadline_duration": {
          "type": "string",
          "description": "An RFC 3339 duration, after which the checkout is automatically canceled.\nA `TerminalCheckout` that is `PENDING` is automatically `CANCELED` and has a cancellation reason\nof `TIMED_OUT`.\n\nDefault: 5 minutes from creation\n\nMaximum: 5 minutes"
        },
        "device_options": {
          "type": "object",
          "required": [
            "device_id"
          ],
          "properties": {
            "device_id": {
              "type": "string",
              "description": "The unique ID of the device intended for this `TerminalCheckout`.\nA list of `DeviceCode` objects can be retrieved from the /v2/devices/codes endpoint.\nMatch a `DeviceCode.device_id` value with `device_id` to get the associated device code."
            },
            "skip_receipt_screen": {
              "type": "boolean",
              "description": "Instructs the device to skip the receipt screen. Defaults to false."
            },
            "tip_settings": {
              "type": "object",
              "properties": {
                "allow_tipping": {
                  "type": "boolean",
                  "description": "Indicates whether tipping is enabled for this checkout. Defaults to false."
                },
                "custom_tip_field": {
                  "type": "boolean",
                  "description": "Indicates whether custom tip amounts are allowed during the checkout flow. Defaults to false."
                },
                "separate_tip_screen": {
                  "type": "boolean",
                  "description": "Indicates whether tip options should be presented on the screen before presenting\nthe signature screen during card payment. Defaults to false."
                },
                "smart_tipping": {
                  "type": "boolean",
                  "description": "Enables the \"Smart Tip Amounts\" behavior.\nExact tipping options depend on the region in which the Square seller is active.\n\nFor payments under 10.00, in the Australia, Canada, Ireland, United Kingdom, and United States, tipping options are presented as no tip, .50, 1.00 or 2.00.\n\nFor payment amounts of 10.00 or greater, tipping options are presented as the following percentages: 0%, 5%, 10%, 15%.\n\nIf set to true, the `tip_percentages` settings is ignored.\nDefaults to false.\n\nTo learn more about smart tipping, see [Accept Tips with the Square App](https://squareup.com/help/us/en/article/5069-accept-tips-with-the-square-app)."
                },
                "tip_percentages": {
                  "type": "array",
                  "description": "A list of tip percentages that should be presented during the checkout flow, specified as\nup to 3 non-negative integers from 0 to 100 (inclusive). Defaults to 15, 20, and 25.",
                  "items": {
                    "type": "integer"
                  }
                }
              }
            }
          }
        },
        "id": {
          "type": "string",
          "description": "A unique ID for this `TerminalCheckout`."
        },
        "location_id": {
          "type": "string",
          "description": "The location of the device where the `TerminalCheckout` was directed."
        },
        "note": {
          "type": "string",
          "description": "An optional note to associate with the checkout, as well as with any payments used to complete the checkout."
        },
        "payment_ids": {
          "type": "array",
          "description": "A list of IDs for payments created by this `TerminalCheckout`.",
          "items": {
            "type": "string"
          }
        },
        "payment_type": {
          "type": "string",
          "description": "The type of payment the terminal should attempt to capture from. Defaults to `CARD_PRESENT`."
        },
        "reference_id": {
          "type": "string",
          "description": "An optional user-defined reference ID that can be used to associate\nthis `TerminalCheckout` to another entity in an external system. For example, an order\nID generated by a third-party shopping cart. The ID is also associated with any payments\nused to complete the checkout."
        },
        "status": {
          "type": "string",
          "description": "The status of the `TerminalCheckout`.\nOptions: `PENDING`, `IN_PROGRESS`, `CANCEL_REQUESTED`, `CANCELED`, `COMPLETED`"
        },
        "updated_at": {
          "type": "string",
          "description": "The time when the `TerminalCheckout` was last updated, as an RFC 3339 timestamp."
        }
      }
    },
    "errors": {
      "type": "array",
      "description": "Information about errors encountered during the request.",
      "items": {
        "type": "object",
        "description": "Represents an error encountered during a request to the Connect API.\n\nSee [Handling errors](https://developer.squareup.com/docs/build-basics/handling-errors) for more information.",
        "required": [
          "category",
          "code"
        ],
        "properties": {
          "category": {
            "type": "string",
            "description": "The high-level category for the error."
          },
          "code": {
            "type": "string",
            "description": "The specific code of the error."
          },
          "detail": {
            "type": "string",
            "description": "A human-readable description of the error for debugging purposes."
          },
          "field": {
            "type": "string",
            "description": "The name of the field provided in the original request (if any) that\nthe error pertains to."
          }
        }
      }
    }
  }
}