Webhooks

This page includes information regarding the various webhooks that you can receive from our API. These can be setup from the developer section of our dashboard.

All webhooks are sent as POST requests to the url that you have defined.

Transaction Status Event

Transaction Status Event Example

{

  "amount": 1,
  "booking": {
    "id": "3d38e53b-867a-43bd-ad5d-4af786dd1b33",
    "booking_reference": "test-123"
  },
  "completed_at": "2021-11-03T11:04:27.000Z",
  "currency": "GBX",
  "payment_link": { "id": "2cc9b939-d2fa-41e5-abae-39c377236978" },
  "provider": {
    "name": "nuvei",
    "reference": "93216A82FBDD1696203B7FC6099A9B66.prod02-vm-tx94"
  },
  "status": "COMPLETE",
  "transaction": { "id": "2cc9b939-d3fa-41e5-acae-39c377236978" }
}

amountinteger

The total value of the transaction in the lowest denomination of the currency (for GBX it is pence, for USX it is cents)

booking.iduuid

The booking ID the transaction is linked to.

booking.booking_referencestring

Your unique reference for the customers booking

completed_atdatetime

The datetime at which the transaction was completed by the customer

currencystring

The currency of the transaction | see currency documentation

payment_link.iduuid

The payment link ID that was used to create the transaction.

provider.namestring

The provider / merchant acquirer name

provider.referencestring

The provider / merchant acquirer reference for the transaction

statusstring

The status of the transaction

transaction.iduuid

The transaction ID

Refund Status Event

Refund Status Event Example

{

  "authorisation_code": "3d38e53b-867a-43bd-ad5d-4af786dd1b33",
  "actioned_at": "2021-11-03T11:04:27.000Z",
  "status": {
    "id": "PENDING_AUTHORISATION"
  },
  "transaction": { 
    "id": "2cc9b939-d3fa-41e5-acae-39c377236978"
  }
}

authorisation_codestring

A unique code, used to identify a refund.

actioned_atdatetime

The datetime at which the refund status change was actioned.

status.idstring

The status of the refund, all statuses can be retrieved using the enums endpoint.

transaction.iduuid

The transaction ID