Notification Properties

⚠️

Card Present Gateway

If you want to access information about our in-store offering, you may check the API specifications here: In-store Transactions Overview

Cards Connect event notifications contain the same payload as the GET API response for the operation that caused the event notification, wrapped with the meta data regarding the notification itself as described below.

Event Notification Properties

• _id: Unique identifier of the event notification, generated by the system.
• type: Type of the event notification. The format is "application.scope.operation_state", for example a notification regarding a successful authorisation will have a type as cardsconnect.transaction.authorization_succeeded while a notification for a Void request accepted by Cards Connect have a type as cardsconnect.transaction.void_accepted
• time: Notification generation time.
• wpay_merchantid: Unique identifier of the respective merchant in the Cards Connect system.
• source: Source system generated the event notification.
• specversion: Current version of event notification system specs.
• datacontenttype: Content of the data in the notification payload. Always application/json for Cards Connect transaction events.
• dataschema: Scheme of the data if there's a specific schema applicable to the notification. null for Cards Connect transaction events.
• data: Payload of the notification. Here, you can expect to find the same JSON properties as you would in the GET API response for the respective operation.
• wpay_apiversion: Current API version used in the event notification system.

As an example, here's an event notification for a successful authorisation:

{
  "_id": "fa54351f-1827-4815-b064-33e81b9f5493",
  "type": "cardsconnect.transaction.authorization_succeeded",
  "time": "2025-05-02T05:10:37.000+00:00",
  "wpay_merchantid": "cc201970-bcca-4d05-8fff-24fb04c8b808",
  "source": "https://www.wpay.cardsconnect.com.au",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "dataschema": null,
  "data": {
    "authorization": {
      "id": "384970e1-e373-4c49-883f-fc37f791ff96",
      "schemeTraceId": "MG00042805020510360502MCC0KYMQW",
      "createdAt": "2025-05-02T05:10:36",
      "authResponseId": "238860",
      "outcome": "Succeeded",
      "responseCode": "00",
      "responseDescription": "Approved or completed",
      "cvvResponseCode": "Match",
      "currency": "AUD",
      "amount": 5500
    },
    "transactionId": "384970e1-e373-4c49-883f-fc37f791ff96",
    "reconciliationId": "e8dd3707-0d8f-4dde-8691-dec639ba6f5e"
  },
  "wpay_apiversion": "1.0",
}