Webhooks Events

Pay Request Events

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

The types of Pay Request events are:

Pay Request Event	Description
`NEW_PAY_REQUEST`	A new Pay Request has been created.
`PAY_REQUEST_VOIDED`	The payment for this Pay Request has been voided.
`PAY_REQUEST_FAILED`	The transaction for this Pay Request has failed.
`PAY_REQUEST_PROCESSING`	The transaction for this Pay Request is now processing.
`PAY_REQUEST_SUCCESS`	The transaction for this Pay Request has succeeded.

Sample Pay Request Event

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

Pay Method Events

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

The types of Pay Method events are:

Pay Method Event	Description
`NEW_PAY_METHOD`	A new Pay Method has been created.

Sample Pay Method Event

{
  "type": "NEW_PAY_METHOD",
  "data": {
    "id": "2688fcf2-44dd-4c72-88ac-79d0910f2932",
    "uri": "https://api.tyro.com/connect/pay/methods/2688fcf2-44dd-4c72-88ac-79d0910f2932",
    "resource": "paymethod"
  }
}

Pay Refund Events

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

The types of Pay Refund events are:

Pay Refund Event	Description
`NEW_PAY_REFUND`	A new refund has been created.

Sample Pay Refund Event

{
  "type": "NEW_PAY_REFUND",
  "data": {
    "id": "2688fcf2-44dd-4c72-88ac-79d0910f2933",
    "uri": "https://api.tyro.com/connect/tables/2688fcf2-44dd-4c72-88ac-79d0910f2933",
    "resource": "payrefund"
  }
}

Registering Webhooks

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