Webhook Events

The following ordering event types can be sent to you when an order status is updated:

Order status event Mandatory
for POS
Description
ORDER_ACCEPTED Yes Order has been accepted by the POS.
ORDER_REJECTED Yes Order has been rejected by the POS or POS failed to accept that order within 2 minutes.
ORDER_BEING_PREPARED No Order is being prepared.
ORDER_READY Yes Order is marked as ready by POS.
ORDER_OUT_FOR_DELIVERY No Order has been dispatched for delivery.
ORDER_FULFILLED No Order has been picked up by the customer and is fulfilled.
ORDER_CANCELLED_BY_MERCHANT No Order has been cancelled by the POS.
ORDER_CANCELLED_BY_CUSTOMER No Order has been cancelled by the customer.

Sample Event

Copy
Copied
{
  "type": "ORDER_ACCEPTED",
  "data": {
    "id": "2688fcf2-44dd-4c72-88ac-79d0910f2933",
    "uri": "https://api.tyro.com/connect/orders/2688fcf2-44dd-4c72-88ac-79d0910f2933",
    "resource": "order"
  }
}
Registering Webhooks

For information on how to register for webhooks and how to interpret the webhook message. Documentation can be found here: Webhooks

Copyright © Tyro Payments 2019-2024. All right reserved.