How to set Basic Payment Info

Payments

Depending on the method of payment, the relevant payment types should be sent with one of two following values (as an integer)

Further details on processing additional payment parameters below;

  "payment": {
    "amount": 1455,
    "type": 0,
    "due": 0,
    "rebate": 0,
    "commissionType": ""
  },

Tax Exclusive Orders

For customers in tax exclusive regions, you should ensure you handle tax accordingly, see details below;

Paid/Unpaid Orders

In some ordering platforms, users can checkout without processing a payment. A typical scenario would be for pickup orders with a cash payment on collection. If allowing for this option at checkout, it is important to set the flag "orderIsAlreadyPaid": false,

For all other scenarios where payment is taken online, set "orderIsAlreadyPaid": true,

Commission Type

This relates to the type of commission charged by the channel for its services.

Each type will correspond to an agreed percentage of the order value taken as commission, but is information provided by some channels only.

  "payment": {
    "amount": 7140,
    "type": 3,
    "due": 0,
    "rebate": 0,
    "commissionType": "regular"
  },

Tips

To send a tip through with an order, there are two possible parameters allowing a channel to distinguish between the intended recipient of tips. i.e

If a tip is intended for the restaurant;

"tip": 500,.

If intended for the driver;

"driverTip": 500,.

Please be aware that not all POS partners will handle this addition to an order, in which case we have a toggle setting to not include these.

Bag Fee

In certain regions it is mandatory to apply a charge against the packaging used. For this, we have the attribute "bagFee"

When included within an order it will be processed accordingly and will appear as a line item on the integrated POS.

A bag fee of $1.20 would then be sent as the below example;

"bagFee": 120,