Events Catalogue
These are the list of events available. It can be viewed in the event catalogue (opens in a new tab)
Checkout Lifecycle
A checkout session goes through various states in its life cycle. These states are
- Initiated
- Cancelled
- Abandoned
- Completed
Event payload
{
"type": "checkout.initiated",
"timestamp": "2023-11-03T20:30:00.0Z",
"location_id": "FPYCBCHYMXFK1",
"data": {
"id": "11YYufWQzNY63zpQ6QSNRQhkUpVph4WRmzW0zWJO2znZKdVujZ0N0S22u",
"order_id": "SP-1234",
"table_num": "T-1",
"order_total": {
"value": 4000,
"currency": "AUD"
},
"expiry": "2023-11-03T21:00:00.0Z"
}
}Transaction Lifecycle
A transaction goes through various states in its life cycle. These states are
- Initiated
- Pending
- Rejected
- Cancelled
- Completed
Event payload
{
"type": "transaction.initiated",
"location_id": "FPYCBCHYMXFK1",
"timestamp": "2023-11-03T20:30:00.0Z",
"data": {
"id": "11b969ea-2e4d-46ac-b727-3a7528e5306b",
"order_id": "SP-1234",
"method": "visa",
"amount": 1000,
"surcharge": 100,
"tip": 100,
"rounding": 2,
"createdAt": "2023-07-21T17:32:28Z",
"status": "requested",
"trn": "01HVN1X8SED9J8WPPSAFYKTD09",
"metadata": {
"items": ["1", "2"],
"consumer": "John Smith"
}
}
}Order
{
"type": "order.requested",
"location_id": "FPYCBCHYMXFK1",
"timestamp": "2023-11-03T20:30:00.0Z",
"data": {
"order_id": "SP-1234",
"table_num": "T-1"
}
}Tables
{
"type": "tables.requested",
"timestamp": "2023-11-03T20:30:00.0Z",
"location_id": "FPYCBCHYMXFK1"
}Locations
{
"type": "location.connected",
"timestamp": "2023-11-03T20:30:00.0Z",
"location_id": "FPYCBCHYMXFK1",
"data": {
"pos_location_id": "XVBCBCHYMXFK1"
}
}{
"type": "location.disconnected",
"timestamp": "2023-11-03T20:30:00.0Z",
"location_id": "FPYCBCHYMXFK1",
"data": {
"pos_location_id": "XVBCBCHYMXFK1"
}
}