Skip to main content

Deposits

Introduction​

The Reservations for Platforms API allows integrators to accept deposits or pre-payment for reservations and transmit the details to the Lightspeed Restaurant K-Series POS. A deposit can be subsequently applied as a payment for the order linked to the reservation.

Below you will find instructions for enabling the deposits feature in the Lightspeed Restaurant K-Series Back Office, sending deposit details and applying payment using deposits.

Before You Begin

  • Make sure you have configured a reservation Platform Profile with depositSupported set to true.

  • Make sure you have an account on the trial server for testing. If you do not have a test account, please contact your Technical Partner Manager.

Part 1 - Enabling Deposits​

Deposits need to be enabled via the Lightspeed Restaurant K-Series Back Office before they can be accepted by the POS.

Step 1 - Locate Reservation Settings​

If your Platform Profile is correctly configured, you should see a tile for your reservation platform under the Integrations > Reservations screen.

Step 1.1

Step 2 - Activate Deposits​

Click on "More details". You will now see an option to enable deposits. Activating deposits will create a new hidden payment method in the POS called "Deposit". This payment method will be used to apply deposits as payments to orders linked to reservations. Click on "Activate".

Step 1.2

Step 3 - Add Menu Button​

Activating deposits will also add a web extension, so that a button can be added to the POS menu screen. Select which menu to add the button to.

Step 1.3

Part 2 - Sending Deposit Details​

When creating a reservation, you can now include a deposit amount in your reservation request.

Step 1 - Configure Your Reservation Payload​

Include deposit details in your reservation payload in the deposits array under the liability object. The deposit object should include the deposit amount, a unique identifier for the deposit, and the currency.

{
  "status": "SEATED",
  "partySize": 2,
  "guest": {
    "platformGuestId": "ABC-123",
    "firstName": "John",
    "lastName": "Smith",
    "email": "john.smith@email.com",
    "phone": "+13453455555",
    "walkIn": true
  },
  "tableNumbers": [
    "1"
  ],
  "notes": "My birthday",
  "liability": {
    "currency": "USD",
    "deposits": [
      {
        "platformDepositId": "unique-deposit-id",
        "amount": "10.00",
        "voided": false,
        "utcCreatedAt": "{{currentTimestamp}}"
      }
    ]
  },
  "utcScheduledAt": "{{currentTimestamp}}",
  "utcUpdatedAt": "{{currentTimestamp}}",
  "sequenceId": {{sequenceId}}
}

Step 2 - Send Reservation Request​

Once a reservation request with a status of SEATED or PARTIALLY_SEATED is sent to the Create or Update Reservation endpoint, the reservation will be visible in the POS and the deposit will be available to apply as a payment.

Step 2.1

Part 3 - Applying Deposit Payments​

When a reservation is created with a deposit, an order will be opened in the POS on the specified table. Once items are added to the order, the 'Pay by deposit' button can be selected on the menu screen and the deposit can be applied as a payment.

Step 1 - Open Reservation Order​

Tap on the table in the floor plan to open the reservation order and tap "Select".

Step 3.1

Step 2 - Add Items to Order​

Add items to the order as usual.

Step 3.2

Step 3 - Apply Deposit Payment​

Once items are added to the order, tap on the "Pay by deposit" button on the menu screen. The available deposit amount will be displayed along with the reservation details. Tap "Apply Deposit" to apply the deposit as a payment.

Step 3.3a

The deposit will be applied and the remaining balance updated.

Step 3.3b

Step 4 - Complete Payment​

Reopen the order and tap "Pay" to complete the remaining payment.

Step 3.4a Step 3.4b

FAQ​

  • Question: "I do not see the option to activate deposits in the back office"
  • Answer: If you do not see a tile for your reservation platform in the back office, or you see a message on the deposit activation screen indicating that deposits are not supported, please ensure that your Platform Profile is correctly configured with depositSupported set to true.

Troubleshooting

  • Question: "Can I refund a deposit payment"
  • Answer: If a deposit needs to be refunded, for example in the case where the cheque is split and it was applied to the wrong cheque, deposit payments can be cancelled. Tap on 'Partial Payments' on the order screen and select "delete payment". The deposit payment will be cancelled and the remaining balance updated. The deposit will now be available to be applied to another cheque on the same reservation.

Refund Deposit