bill.requested | A bill has been requested |
Name | Type | Description |
---|
billRequest | BillRequest | The bill request detail this event is related to.
|
{
"event": "bill.requested",
"billRequest": {
"...": "..."
}
}
bill.payment-completed | A bill payment has been completed |
Name | Type | Description |
---|
billPaymentDetail | BillPaymentDetail | The payment this event is related to.
|
{
"event": "bill.payment-completed",
"billPaymentDetail": {
"...": "..."
}
}
Name | Type | Description |
---|
locationId | string | The location Id the bill belongs to.
|
organizationId | string | The organization Id the bill belongs to.
|
billRef | string | Bill Id from non LOKE system.
|
placeRef | string | The place reference(table number, room number, QR code, etc) used to pull bill.
|
Name | Type | Description |
---|
id | string | Payment ID
|
locationId | string | The location Id the bill belongs to.
|
organizationId | string | The organization Id the bill belongs to.
|
completedAt | string | When the payment was completed
|
billRef | string | Bill Id from non LOKE system.
|
chargedAmount | integer | Portion covered by credit card
|
creditAmount | integer | Portion covered by customer credit
|
currency | string |
|
discountAmount | integer | Portion discounted by user promotion
|
feeAmount | integer |
|
payoutAmount | integer |
|
tipAmount | integer |
|
total | integer | Total amount covered by payment
|
customer | CustomerTiny |
|
items | PaymentLineItem[] |
|
Name | Type | Description |
---|
id | string | Unique ID of the Customer
|
email | string | (optional) The Customers email address
|
firstName | string | Customer first name or given name
|
lastName | string | Customer last name or surname
|
phoneNumber | string | (optional) The Customers mobile phone number
|
Name | Type | Description |
---|
id | string | Unique identifier for the item
|
name | string | Item name
|
amount | integer | Item per unit amount
|
quantity | integer | Quantity of units of item
|
type | string | item, discount, surcharge
|
options | PaymentLineItemOption[] | (optional) options chosen for this item
|
Name | Type | Description |
---|
id | string | Unique identifier for the option
|
name | string | Option name, eg 'size'
|
choices | PaymentLineItemOptionChoice[] | Choices made for this option
|
Name | Type | Description |
---|
id | string | Unique identifier for the choice
|
name | string | Choice name, eg 'small'
|
amount | integer | Choice per unit amount
|