Notifications/list

What it does: Returns pending booking events created directly in RentalCover.com. For example, date changes or cancellations initiated by RentalCover customer support.

For invoicing partners only

If your integration uses webhooks, you don't need to poll this endpoint. Webhooks deliver the same events in real time.

GET /notifications/list

Example request

GET

curl -i -X GET \
  -H "X_API_KEY: your_api_key" \
  https://api-staging.rentalcover.com/notifications/list

Response

[
   {
      "EventId":"evt_71jea4sjl778s24",
      "Sequence":1,
      "CreatedAt":"2018-01-19 10:38:26",
      "Category":"DirectUpdate",
      "EventStatus":"Pending",
      "Reference":"XXXX-XXXX-INS",
      "Type":"Refund",
      "Currency":"AUD",
      "Amount":-13.82,
      "CurrentAttributes":{
         "Status":"PendingUpdate",
         "Currency":"AUD",
         "TotalAmount":102.16,
         "FromDate":"2018-01-31 00:00:00",
         "ToDate":"2018-02-04 00:00:00",
         "InsuranceCoverAmount":100000,
         "DestinationCountry":"AU",
         "PartnerReference":null,
         "Policy":{
            "Code":"FULLPROTECTION1",
            "Type":"FullProtection",
            "Name":"Full Protection"
         },
         "VehicleTypes":{
            "freecancellationcover":false,
            "freetravelinsurance":false,
            "car":true,
            "motorhome":false,
            "campervan":false,
            "4x4":false,
            "minibus":false,
            "lighttruck":false,
            "bus":false
         },
         "Customer":{
            "FirstName":"Test",
            "LastName":"Test",
            "Email":"[email protected]",
            "Age":"34",
            "Country":"AU"
         }
      },
      "PreviousAttributes":{
         "Status":"Confirmed",
         "Currency":"AUD",
         "TotalAmount":115.98,
         "FromDate":"2018-01-31 00:00:00",
         "ToDate":"2018-02-05 00:00:00",
         "InsuranceCoverAmount":100000,
         "DestinationCountry":"AU",
         "PartnerReference":null,
         "Policy":{
            "Code":"FULLPROTECTION1",
            "Type":"FullProtection",
            "Name":"Full Protection"
         },
         "VehicleTypes":{
            "freecancellationcover":false,
            "freetravelinsurance":false,
            "car":true,
            "motorhome":false,
            "campervan":false,
            "4x4":false,
            "minibus":false,
            "lighttruck":false,
            "bus":false
         },
         "Customer":{
            "FirstName":"Test",
            "LastName":"Test",
            "Email":"[email protected]",
            "Age":"34",
            "Country":"AU"
         }
      }
   }
][
   {
      "EventId":"evt_71jea4sjl778s24",
      "Sequence":1,
      "CreatedAt":"2018-01-19 10:38:26",
      "Category":"DirectUpdate",
      "EventStatus":"Pending",
      "Reference":"XXXX-XXXX-INS",
      "Type":"Refund",
      "Currency":"AUD",
      "Amount":-13.82,
      "CurrentAttributes":{
         "Status":"PendingUpdate",
         "Currency":"AUD",
         "TotalAmount":102.16,
         "FromDate":"2018-01-31 00:00:00",
         "ToDate":"2018-02-04 00:00:00",
         "InsuranceCoverAmount":100000,
         "DestinationCountry":"AU",
         "PartnerReference":null,
         "Policy":{
            "Code":"FULLPROTECTION1",
            "Type":"FullProtection",
            "Name":"Full Protection"
         },
         "VehicleTypes":{
            "freecancellationcover":false,
            "freetravelinsurance":false,
            "car":true,
            "motorhome":false,
            "campervan":false,
            "4x4":false,
            "minibus":false,
            "lighttruck":false,
            "bus":false
         },
         "Customer":{
            "FirstName":"Test",
            "LastName":"Test",
            "Email":"[email protected]",
            "Age":"34",
            "Country":"AU"
         }
      },
      "PreviousAttributes":{
         "Status":"Confirmed",
         "Currency":"AUD",
         "TotalAmount":115.98,
         "FromDate":"2018-01-31 00:00:00",
         "ToDate":"2018-02-05 00:00:00",
         "InsuranceCoverAmount":100000,
         "DestinationCountry":"AU",
         "PartnerReference":null,
         "Policy":{
            "Code":"FULLPROTECTION1",
            "Type":"FullProtection",
            "Name":"Full Protection"
         },
         "VehicleTypes":{
            "freecancellationcover":false,
            "freetravelinsurance":false,
            "car":true,
            "motorhome":false,
            "campervan":false,
            "4x4":false,
            "minibus":false,
            "lighttruck":false,
            "bus":false
         },
         "Customer":{
            "FirstName":"Test",
            "LastName":"Test",
            "Email":"[email protected]",
            "Age":"34",
            "Country":"AU"
         }
      }
   }
]

Response

Returns an array of event objects. After processing each event, call Notifications/update with the EventId to prevent it from reappearing.

Event metadata

Field	Type	Description
EventId	string	Unique event identifier. Pass to Notifications/update to acknowledge.
Sequence	integer	Sequence number for ordering events.
CreatedAt	datetime	When the event was created.
Category	string	DirectUpdate: the booking was modified or cancelled directly in RentalCover.com.
EventStatus	string	Pending or Processed.

Financial details

Field	Type	Description
Reference	string	Booking reference.
Type	string	Financial event type: Refund, Charge, or Cancel.
Currency	string	Currency of the booking.
Amount	float	Amount to charge or refund. Negative values indicate a refund.

Booking state

Field	Type	Description
CurrentAttributes	object	Booking state after the change. Contains: Status, Currency, TotalAmount, FromDate, ToDate, InsuranceCoverAmount, DestinationCountry, PartnerReference, Policy, VehicleTypes, Customer.
PreviousAttributes	object	Booking state before the change. Same structure as CurrentAttributes.