Bill Payment Flow

Overview

This section describes how you (the integrator) can make bills available to customers, for them to pay.

A customer may request a bill for a place ie: a table or room (placeRef), or by a unique identifier (billRef), or both.

Usually a customer will request a bill by typing a ref in to the app, or scanning a QR code.

You push a bill to us to make it available and up to date for customers. You may choose to push bills at any time, or when customers request them, or both.

Keywords

Bill: A bill contains an amount to be paid by one or more customers, for products and services (items) they consumed. The bill also depicts the amount remaining to be paid, any payments or adjustments that have been made, and lists the billable items. Usually a bill is pushed by you, from a POS, to us, for the customers to see.

Bill Payment: A customer may pay the full amount remaining on the bill, or only a partial amount. A customer may make multiple payments, and one or more customers may pay. A bill is associated with one or more bill payments.

Push a Bill

You may push a bill at any time. When pushing a bill be sure to provide the billRef and/or placeRef. We recommend you only push bills in response to the bill requested event (webhook).

See push a bill for more information.

Customer requests a Bill

For the fastest customer experience, you should push the bill each time a customer requests it.

If a bill is not pushed within ~5 seconds, the most recent known open unpaid bill will be displayed to them.

To be notified when a customer requests a bill, use the webhooks guide, and subscribe to the bill requested event.

Customer makes a Bill Payment

For a successful customer experience, you must accept or reject each completed bill payment in a timely manner.

If a bill payment is not accepted or rejected, it will be refunded after ~5 seconds. See accept a bill payment and reject a bill payment to see how.

To be notified when a customer pays a bill, use the webhooks guide, and subscribe to the bill payment completed event.