{"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":["PAY_TERMINAL_MERCHANT_ID_ENABLED"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A merchant ID has been enabled for Pay Instore."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PAY_TERMINAL_MERCHANT_ID_DISABLED"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A merchant ID has been disabled for Pay Instore."]}]}]}]}]},{"$$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\": \"PAY_TERMINAL_MERCHANT_ID_ENABLED\",\n  \"data\": {\n    \"id\": \"EXAMPLE_MERCHANT123\",\n    \"uri\": \"https://api.tyro.com/connect/pay-terminal/merchants/EXAMPLE_MERCHANT123\",\n    \"resource\": \"payterminalmerchant\"\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"pay-request-events","__idx":3},"children":["Pay Request Events"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Be notified of events on a Pay Request via the webhook."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The types of 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":"Pay Request Event"},"children":["Pay Request 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":["NEW_PAY_TERMINAL_REQUEST"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A new Pay Request has been created."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PAY_TERMINAL_REQUEST_INITIALISED"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The Pay Request has been initialised on the terminal, ready to take payment."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PAY_TERMINAL_REQUEST_UPDATED"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The Pay Request has new status, prompts or data to consume."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PAY_TERMINAL_REQUEST_SUCCESS"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The Pay Request has been successfully processed."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PAY_TERMINAL_REQUEST_FAILED"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The Pay Request has failed, and cannot be reused."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"sample-pay-request-event","__idx":4},"children":["Sample Pay Request Event"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"type\": \"NEW_PAY_TERMINAL_REQUEST\",\n  \"data\": {\n    \"id\": \"2688fcf2-44dd-4c72-88ac-79d0910f2933\",\n    \"uri\": \"https://api.tyro.com/connect/pay-terminal/requests/2688fcf2-44dd-4c72-88ac-79d0910f2933\",\n    \"resource\": \"payterminalrequest\"\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":"Pay Request Events","id":"pay-request-events","depth":2},{"value":"Sample Pay Request Event","id":"sample-pay-request-event","depth":2}],"frontmatter":{"seo":{"title":"Notification events"}},"lastModified":"2026-09-02T06:39:28.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/api-explorer/pay-in-person/0.9/notification-events","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}