{"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":"pay-request-events","__idx":1},"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 Pay Request 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_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_REQUEST_VOIDED"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The payment for this Pay Request has been voided."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PAY_REQUEST_FAILED"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The transaction for this Pay Request has failed."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PAY_REQUEST_PROCESSING"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The transaction for this Pay Request is now processing."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PAY_REQUEST_SUCCESS"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The transaction for this Pay Request has succeeded."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"sample-pay-request-event","__idx":2},"children":["Sample Pay Request Event"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"type\": \"NEW_PAY_REQUEST\",\n  \"data\": {\n    \"id\": \"2688fcf2-44dd-4c72-88ac-79d0910f2931\",\n    \"uri\": \"https://api.tyro.com/connect/pay/requests/2688fcf2-44dd-4c72-88ac-79d0910f2931\",\n    \"resource\": \"payrequest\"\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"pay-method-events","__idx":3},"children":["Pay Method Events"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Be notified of events on a Pay Method via the webhook."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The types of Pay Method 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 Method Event"},"children":["Pay Method 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_METHOD"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A new Pay Method has been created."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"sample-pay-method-event","__idx":4},"children":["Sample Pay Method Event"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"type\": \"NEW_PAY_METHOD\",\n  \"data\": {\n    \"id\": \"2688fcf2-44dd-4c72-88ac-79d0910f2932\",\n    \"uri\": \"https://api.tyro.com/connect/pay/methods/2688fcf2-44dd-4c72-88ac-79d0910f2932\",\n    \"resource\": \"paymethod\"\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"pay-refund-events","__idx":5},"children":["Pay Refund Events"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Be notified of events on a Pay Refund via the webhook."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The types of Pay Refund 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 Refund Event"},"children":["Pay Refund 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_REFUND"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A new refund has been created."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"sample-pay-refund-event","__idx":6},"children":["Sample Pay Refund Event"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"type\": \"NEW_PAY_REFUND\",\n  \"data\": {\n    \"id\": \"2688fcf2-44dd-4c72-88ac-79d0910f2933\",\n    \"uri\": \"https://api.tyro.com/connect/tables/2688fcf2-44dd-4c72-88ac-79d0910f2933\",\n    \"resource\": \"payrefund\"\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":"Pay Request Events","id":"pay-request-events","depth":2},{"value":"Sample Pay Request Event","id":"sample-pay-request-event","depth":3},{"value":"Pay Method Events","id":"pay-method-events","depth":2},{"value":"Sample Pay Method Event","id":"sample-pay-method-event","depth":3},{"value":"Pay Refund Events","id":"pay-refund-events","depth":2},{"value":"Sample Pay Refund Event","id":"sample-pay-refund-event","depth":3}],"frontmatter":{"seo":{"title":"Notification events"}},"lastModified":"2026-09-02T06:39:28.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/api-explorer/pay-online/0.9/notification-events","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}