Handles event notifications sent by the PXP system.

post/events

Request

Base URL
https://api.example.com
URL
https://api.example.com/events
Auth
none declared

Request body

idstring required

The unique identifier of the event. Can be used for tracking which events have been already processed.

createdOnstring required

The UTC date and time when the event was sent. Used for identifying the correct order of events.

type'MerchantStateChangedEvent' | 'PreScreenMerchantStateChangedEvent' required

The type of the event. Used for specifying what properties will be put in the 'data' property.

Example request

{
  "id": "AAF851BE-94C4-4F96-87F3-6EAE1AA2D51D",
  "createdOn": "2010-10-18 23:10:27:231",
  "data": {
    "merchantStateChangedEvent": {
      "merchantId": "f0deffbc-9c87-40aa-b863-5e2b6caf14a7",
      "state": {
        "type": "Declined",
        "reason": "Already Processing"
      }
    },
    "preScreenMerchantStateChangedEvent": {
      "preScreenMerchantId": "f0deffbc-9c87-40aa-b863-5e2b6caf14a7",
      "state": {
        "type": "Declined"
      }
    }
  }
}

Response

Event successfully received by the subscriber.

Changes

No recorded changes to this operation across all 1 revision of this API.