Webhook Events

Merchant ID Authorisation Events

Be notified of merchant ID authorisation events via the webhook.

The types of authorisation events are:

Authorisation Event	Description
`TAPTOPAY_MERCHANT_ID_ENABLED`	A merchant ID has been enabled for Tap to Pay.
`TAPTOPAY_MERCHANT_ID_DISABLED`	A merchant ID has been disabled for Tap to Pay.

Sample Merchant ID Authorisation Event

Copy

Copied

{
  "type": "TAPTOPAY_MERCHANT_ID_ENABLED",
  "data": {
    "id": "EXAMPLE_MERCHANT123",
    "uri": "https://api.tyro.com/connect/tap-to-pay/merchants/EXAMPLE_MERCHANT123",
    "resource": "taptopaymerchantid"
  }
}

Embedded Payments Transaction Events

Be notified of Embedded Payments transaction events via the webhook.

The types of transaction events are:

Transaction Event	Description
`TAPTOPAY_TRANSACTION_FAILED`	The transaction has failed.
`TAPTOPAY_TRANSACTION_SUCCESS`	The transaction has succeeded.
`TAPTOPAY_TRANSACTION_REFUNDED`	The transaction has been refunded.

Sample Embedded Payments Transaction Event

Copy

Copied

{
  "type": "TAPTOPAY_TRANSACTION_SUCCESS",
  "data": {
    "id": "e8E_TFXsQuiCqstPUgFpaZzKg1U=",
    "uri": "https://api.tyro.com/connect/tap-to-pay/merchants/EXAMPLE_MERCHANT123/transactions/e8E_TFXsQuiCqstPUgFpaZzKg1U=",
    "resource": "taptopaytransaction"
  }
}

Reader Events

Be notified of Embedded Payments Reader events via the webhook.

The types of Reader events are:

Reader Event	Description
`TAPTOPAY_READER_CREATED`	A new Reader has been created.
`TAPTOPAY_READER_STATUS_UPDATED`	The Reader status has been updated.

Sample Embedded Payments Reader Event

Copy

Copied

{
  "type": "TAPTOPAY_READER_CREATED",
  "data": {
    "id": "2688fcf2-44dd-4c72-88ac-79d0910f2932",
    "uri": "https://api.tyro.com/connect/tap-to-pay/merchants/EXAMPLE_MERCHANT123/readers/2688fcf2-44dd-4c72-88ac-79d0910f2932",
    "resource": "taptopayreader"
  }
}

Registering Webhooks

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