Webhooks Events

Merchant ID Authorisation Events

Be notified of merchant ID authorisation events via the webhook.

The types of authorisation events are:

Authorisation Event	Description
`PAY_TERMINAL_MERCHANT_ID_ENABLED`	A merchant ID has been enabled for Pay Instore.
`PAY_TERMINAL_MERCHANT_ID_DISABLED`	A merchant ID has been disabled for Pay Instore.

Sample Merchant ID Authorisation Event

Copy

Copied

{
  "type": "PAY_TERMINAL_MERCHANT_ID_ENABLED",
  "data": {
    "id": "EXAMPLE_MERCHANT123",
    "uri": "https://api.tyro.com/connect/pay-terminal/merchants/EXAMPLE_MERCHANT123",
    "resource": "payterminalmerchant"
  }
}

Pay Request Events

Be notified of events on a Pay Request via the webhook.

The types of events are:

Pay Request Event	Description
`NEW_PAY_TERMINAL_REQUEST`	A new Pay Request has been created.
`PAY_TERMINAL_REQUEST_INITIALISED`	The Pay Request has been initialised on the terminal, ready to take payment.
`PAY_TERMINAL_REQUEST_UPDATED`	The Pay Request has new status, prompts or data to consume.
`PAY_TERMINAL_REQUEST_SUCCESS`	The Pay Request has been successfully processed.
`PAY_TERMINAL_REQUEST_FAILED`	The Pay Request has failed, and cannot be reused.

Sample Pay Request Event

Copy

Copied

{
  "type": "NEW_PAY_TERMINAL_REQUEST",
  "data": {
    "id": "2688fcf2-44dd-4c72-88ac-79d0910f2933",
    "uri": "https://api.tyro.com/connect/pay-terminal/requests/2688fcf2-44dd-4c72-88ac-79d0910f2933",
    "resource": "payterminalrequest"
  }
}

Registering Webhooks

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