Notifications

Overview

Notifications can be sent via email or webhook to notify merchants of certain events that occur in OnlinePay. Notifications can be triggered by transaction events or checkout events and can be configured using the OnlinePay administration section of the dashboard.

⚠️

Only Merchant Admin, Merchant Cashier, or Merchant Supervisor roles can access the Notifications section of the dashboard.

Event notification triggers

Notifications can be triggered by transaction events or checkout events. Transaction events are related to transactions that occur in OnlinePay, such as a successful sale or a declined sale. Checkout events are related to the checkout process, such as a successful checkout transaction or a failed 3DS authentication.

For example:

• A successful sale (Transaction Event)
• A failed 3DS authentication (Checkout Event)

Transaction events notification triggers

The following table lists the transaction events that can trigger a notification:

Checkout event notification triggers

The following table lists the checkout events that can trigger a notification:

View and create notifications

To access the Notifications section of the dashboard, navigate to Administration > Advanced Settings > Notifications.

View notifications

The Notifications section displays a list of all notifications that have been created and their status.

You can filter existing notifications by Organisation, Event type, or Status. Alternatively, search for notifications from the search bar by providing the notification Name, Email, or webhook URL.

To view the details of a notification, click on the notification name. From the notification details page, you can edit the notification, disable or delete the notification, or re-enable a disabled notification.

Create a notification

To create a new notification, navigate to the Notifications section of the dashboard and follow these steps:

1. Click the Create new notification at the top of the page.

2. Provide a Notification name.

3. Select the organisation. or multiple organisations, from the drop-down list. The notification will be triggered for transactions or checkouts that are associated with the selected organisation(s).

4. Select the Event types that will trigger the notification. You can select multiple event types from the drop-down list, which includes both transaction and checkout events. You will receive a notification for each event type selected.
   

5. Choose the notification delivery method.

   • Email: Select Email to provide the email address where the notification will be sent. The notification can only be sent to one email address. You can preview the email template by clicking Preview email next to the Email address selector.

   • Webhook: Select URL endpoint to provide the URL of the webhook where the notification will be sent. Selecting the URL endpoint option will display additional options to send Event metadata only or Full event payload (ony available for transaction events). You can preview the webhook payload by clicking Preview payload.

     

     Your webhook will receive a POST http call with a JSON payload including values related to the notification. See Webhook notification example for more information.

6. Click Save to save the notification.

ℹ️

New webhooks are active within 60 seconds. Updates to existing webhooks may take between 10 to 60 minutes to update depending on server load.

Disable or delete a notification

To disable or delete a notification, navigate to the Notifications section of the dashboard and follow these steps:

1. Click on the notification name to view the notification details.
2. Click Disable to disable the notification.
3. In the confirmation alert, click Disable notification to confirm. A disabled notification will not trigger any notifications. A disabled notification can be re-enabled by clicking Enable notification on the notification details screen.
4. Notifications can only be deleted if they are disabled. To delete a notification, click Delete on the disabled notification details screen. In the confirmation alert, click Delete notification to confirm.

Example notifications

The following examples show the content of notifications that are sent via email or webhook.

Email notification example

The following example is a sample email preview with generic data values:

Subject: New event - Refund approved

array (
    eventId: aefd58f2-7d4d-4afc-b3a8-b841aba5d833,
    eventDateTime : {dateTime={date={year=2021, month=11, day=16}, time={hour=14, minute=36, second=12, nano=921000000}}, offset={totalSeconds=0}},
    recordId : aefd58f2-7d4d-4afc-b3a8-b841aba5d833,
    entityUid :9aea8c9c-d54e-4811-b8d3-6d33aa3a702c,
    eoEntityUid:,
    eventType:Void Approved,
    estateOwner:,
    source:pdsp,
    component:,
    received:
    objectType:TransactionEvent
    content:
    UUID :aefd58f2-7d4d-4afc-b3a8-b841aba5d833,
    TRANSACTIONTYPE : VOID,
    INITIATORTRACEID : 002709,
    GATEWAYTRACEID : ,
    CREATEDDATETIME : 2021-11-16T14:36:12.921Z,
    POI : {},
    MERCHANT : {UUID=9aea8c9c-d54e-4811-b8d3-6d33aa3a702c, ID=87654, LOCALE={COUNTRYCODE=AU}, CONTRACTS=[{MCC=7654, MERCHANTID=87654}]},
    AMOUNT :{VALUE=10.03, CURRENCYCODE=AUD},
    INSTRUMENT :[{CARDBRAND=VISA, INSTRUMENTTYPE=CARD, MASKEDCARDNUMBER=411111******1111}, {INSTRUMENTTYPE=TOKEN}],
    OUTCOME:[{ACQUIRERRESPONSECODE=00}, {RESPONSE=SUCCESS, RESPONSECODE=0000}],
    CUSTOMER :,
    CONTEXT:
  )

Webhook notification example

Webhooks are sent to your specified URL endpoint in the form of a POST request with a JSON payload. The payload includes values and data related to the transaction that triggered the notification.

These values are sample data only and cannot be used to search for transactions or events in the OnlinePay dashboard.

The following example is a sample webhook payload when selecting the Full event payload option:

{
  "eventType": "TxnRefundApproved",
  "objectType": "TransactionEvent",
  "eventId": "5b5f42f6-db9f-4fd8-8396-1527ec621ab8",
  "eventDateTime": "2023-03-02T13:16:44.654Z",
  "recordId": "5b5f42f6-db9f-4fd8-8396-1527ec621ab8",
  "entityUid": "07652580-1037-4901-92f2-74676cb8aa7e",
  "source": "pdsp",
  "content": {
    "id": "5b5f42f6-db9f-4fd8-8396-1527ec621ab8",
    "currency_code": "AUD",
    "country_code": "AU",
    "created_at": "2023-03-02T13:16:44.654Z",
    "customer": "18c4694c-b498-40fa-ab9d-fbe671c0afca",
    "customer_ip": "127.0.0.1",
    "dynamic_descriptor": "Test Transaction",
    "payment_product": "CARD",
    "payment_product_type": "VISA",
    "transaction_type": "SALE",
    "transaction_status": "FAILED",
    "shipping_information": {
      "address": "201 Sussex St",
      "city": "Sydney",
      "country": "AU",
      "phone": "61292677099",
      "postal_code": "2000",
      "state": "NSW"
    },
    "user_agent": "string",
    "cvv_present": false,
    "card_brand": "VISA",
    "masked_card_number": "430000******7107",
    "merchant_id": "290010026",
    "merchant_reference": "200001",
    "shopper_interaction": "ecommerce",
    "threed_authentication": {
      "eci_flag": "05",
      "enrolled": "Y",
      "cavv": "MTIzNDU2Nzg5MDEyMzQ1Njc4OTA=",
      "pares_status": "Y",
      "ds_transaction_id": "020100004317fdc3ad2454438000000000000891",
      "threeds_version": "2.1.0"
    },
    "amount": "3.0",
    "payment_summary": {}
  }
}

The following example shows a webhook payload included in the Event metadata only option:

{
  "eventType": "TxnSaleApproved",
  "eventId": "72d2da83-ac4f-11e8-a4d5-c2941f1b9e6a",
  "eventDateTime": "2020-08-07T15:47:37.391+12:00",
  "recordId": "ddb21f1f-a691-4a62-9083-4ab9155b9739"
}

See the Notification parameters section for a list of parameters that can be included in notifications.

Notification parameters

The following table lists the parameters that can be included in notifications: