{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-api-explorer/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"Notification events","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"notification-events","__idx":0},"children":["Notification events"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"merchant-id-authorisation-events","__idx":1},"children":["Merchant ID Authorisation Events"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Be notified of merchant ID authorisation events via the webhook."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The types of authorisation events are:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Authorisation Event"},"children":["Authorisation Event"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TAPTOPAY_MERCHANT_ID_ENABLED"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A merchant ID has been enabled for Tap to Pay."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TAPTOPAY_MERCHANT_ID_DISABLED"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A merchant ID has been disabled for Tap to Pay."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"sample-merchant-id-authorisation-event","__idx":2},"children":["Sample Merchant ID Authorisation Event"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"type\": \"TAPTOPAY_MERCHANT_ID_ENABLED\",\n  \"data\": {\n    \"id\": \"EXAMPLE_MERCHANT123\",\n    \"uri\": \"https://api.tyro.com/connect/tap-to-pay/merchants/EXAMPLE_MERCHANT123\",\n    \"resource\": \"taptopaymerchantid\"\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"embedded-payments-transaction-events","__idx":3},"children":["Embedded Payments Transaction Events"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Be notified of Embedded Payments transaction events via the webhook."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The types of transaction events are:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Transaction Event"},"children":["Transaction Event"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TAPTOPAY_TRANSACTION_FAILED"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The transaction has failed."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TAPTOPAY_TRANSACTION_SUCCESS"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The transaction has succeeded."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TAPTOPAY_TRANSACTION_REFUNDED"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The transaction has been refunded."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"sample-embedded-payments-transaction-event","__idx":4},"children":["Sample Embedded Payments Transaction Event"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"type\": \"TAPTOPAY_TRANSACTION_SUCCESS\",\n  \"data\": {\n    \"id\": \"e8E_TFXsQuiCqstPUgFpaZzKg1U=\",\n    \"uri\": \"https://api.tyro.com/connect/tap-to-pay/merchants/EXAMPLE_MERCHANT123/transactions/e8E_TFXsQuiCqstPUgFpaZzKg1U=\",\n    \"resource\": \"taptopaytransaction\"\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"reader-events","__idx":5},"children":["Reader Events"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Be notified of Embedded Payments Reader events via the webhook."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The types of Reader events are:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Reader Event"},"children":["Reader Event"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TAPTOPAY_READER_CREATED"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A new Reader has been created."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TAPTOPAY_READER_STATUS_UPDATED"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The Reader status has been updated."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"sample-embedded-payments-reader-event","__idx":6},"children":["Sample Embedded Payments Reader Event"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"type\": \"TAPTOPAY_READER_CREATED\",\n  \"data\": {\n    \"id\": \"2688fcf2-44dd-4c72-88ac-79d0910f2932\",\n    \"uri\": \"https://api.tyro.com/connect/tap-to-pay/merchants/EXAMPLE_MERCHANT123/readers/2688fcf2-44dd-4c72-88ac-79d0910f2932\",\n    \"resource\": \"taptopayreader\"\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Registering webhooks"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For information on how to register for webhooks and how to interpret the webhook message. Documentation can be found here: ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/getting-started/notification-events/webhooks"},"children":["Webhooks"]},"."]}]}]},"headings":[{"value":"Notification events","id":"notification-events","depth":1},{"value":"Merchant ID Authorisation Events","id":"merchant-id-authorisation-events","depth":2},{"value":"Sample Merchant ID Authorisation Event","id":"sample-merchant-id-authorisation-event","depth":3},{"value":"Embedded Payments Transaction Events","id":"embedded-payments-transaction-events","depth":2},{"value":"Sample Embedded Payments Transaction Event","id":"sample-embedded-payments-transaction-event","depth":3},{"value":"Reader Events","id":"reader-events","depth":2},{"value":"Sample Embedded Payments Reader Event","id":"sample-embedded-payments-reader-event","depth":3}],"frontmatter":{"seo":{"title":"Notification events"}},"lastModified":"2026-09-02T06:39:28.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/api-explorer/tap-to-pay/1.0/notification-events","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}