This guide will be removed on April 29, 2022. Please use our new, easier-to-use Toast technical documentation site. All updated content is on the new site.

Example order with an alternative payment type

The following example shows an Order object that contains one check with a single payment that was processed outside of the Toast platform.

POST request message body to create a dine-in order with payment information

{
  "entityType": "Order",
  "diningOption": {
    "guid": "23fc2559-fc37-46ce-a963-cc5fdb88af0c",1
    "entityType": "DiningOption"
  },
  "checks": [
    {
      "entityType": "Check",
      "selections": [
        {
          "entityType": "MenuItemSelection",
          "itemGroup": {
            "guid": "46c963b8-a4c8-4cd0-9b7e-e1c431ed0b53",2
            "entityType": "MenuGroup"
          },
          "item": {
            "entityType": "MenuItem",
            "guid": "a8b4439d-185d-41df-8ad3-2ff4f7dfa6ec"3
          },
          "quantity": 1,4
          "modifiers": []
        }
      ],
      "payments": [5
        {
          "paidDate": "2017-05-09T16:24:09.000+0000",6
          "type": "OTHER",7
          "amount": "9.55",8
          "otherPayment": {
            "guid": "0dc19214-d29e-4ab9-a773-27e5812999c7"9
          },
          "tipAmount": "0.00",10
          "amountTendered": "9.55"11
        }
      ]
    }
  ]
}

1

The GUID of the dining option for the order.

2

The GUID of the menu group for the menu item selected for this check. For example, a menu might include a menu group named "appetizers" or "drinks."

3

The GUID of the menu item selected for this check. For example, a menu item might be "spinach dip" or "lemonade."

4

The number of the menu items selected for this check. For example, a check might include a "lemonade" menu item selection and a quantity of three, for a party of three customers.

5

You do not need to include payment information to create an order. This example includes payment information when it creates the order. The price information for the payment is available from the /prices endpoint of the orders API. For more information, see Getting check prices before you submit an order.

6

The date and time that the customer presented payment for the check.

7

One of the enumerated payment categories used by the Toast platform. The OTHER payment category includes payments processed outside of the Toast platform, for example by third-party services.

8

The currency value of the payment, excluding tips.

9

The GUID of the specific alternate payment type configured for the restaurant. For example, a restaurant might configure a specific third-party service as one alternate payment type in the OTHER payment category. Use alternative payment types if you process your payments outside of The Toast credit cards API.

10

The currency value of the gratuity included with the payment.

11

The currency value presented by the customer to provide the payment. Do not include the tip in the amountTendered value.