Notifications/list

The Notification endpoint enables the partners to get list of events that were created as part of direct update in RentalCover.com for bookings using Invoicing feature rather than Credit Card.

Endpoint: /notifications/list

Method: GET

GET /notifications/list

curl -i -X GET \
-H "X_API_KEY: [my-api-key]" \
-H "Content-Type: application/json" \
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 Parameters:

EventId: string	EventId
Sequence: integer	Sequence number for the events.
CreatedAt: date [yyyy-mm-dd hh:mm:ss]	Date/time when the event was created
Category: string	DirectUpdate for bookings that has been modified / cancelled on RentalCover.com
EventStatus: string	Status of the event (Pending / Processed)
Reference: string	Reference (INS) of booking
Type: string	event type (Refund / Charge / Cancel)
Currency: string	Currency of the policy
Amount:	float Amount to charge / Refund
CurrentAttributes.Status: string	policy has been cancelled.
CurrentAttributes.Currency: string	policy has been partially paid for however there are amounts outstanding. Usually as the result of a modification which increased the price.
CurrentAttributes.TotalAmount datetime	Start date/time of booking
CurrentAttributes.FromDate datetime	End date/time of booking
CurrentAttributes.ToDate float	Total amount customer is to pay for the policy (already includes discounts and markups)
CurrentAttributes.InsuranceCoverAmount float	Amount of cover the policy includes
CurrentAttributes.DestinationCountry string	Supplier’s policy reference once purchased
CurrentAttributes.PartnerReference boolean	Flag whether the policy has expired
CurrentAttributes.Policy.Code string	Policy Code
CurrentAttributes.Policy.Type string	Policy Type
CurrentAttributes.Policy.Name string	Policy Name
CurrentAttributes.VehicleTypes.freecancellationcover: boolean	Free cancellation cover
CurrentAttributes.VehicleTypes.freetravelinsurance: boolean	Free travel cover
CurrentAttributes.VehicleTypes.car: boolean	Car
CurrentAttributes.VehicleTypes.motorhome: boolean	Motorhome
CurrentAttributes.VehicleTypes.campervan: boolean	Campervan
CurrentAttributes.VehicleTypes.4x4: boolean	4*4
CurrentAttributes.VehicleTypes.minibus: boolean	Minibus
CurrentAttributes.VehicleTypes.lighttruck: boolean	lighttruck
CurrentAttributes.Customer.FirstName: string	FirstName
CurrentAttributes.Customer.LastName: string	LastName
CurrentAttributes.Customer.Email: string	Email
CurrentAttributes.Customer.Age: string	Age
CurrentAttributes.Customer.Country: string	Country
PreviousAttributes.Status: string	policy has been cancelled.
PreviousAttributes.Currency: string	policy has been partially paid for however there are amounts outstanding. Usually as the result of a modification which increased the price.
PreviousAttributes.TotalAmount datetime	Start date/time of booking
PreviousAttributes.FromDate datetime	End date/time of booking
PreviousAttributes.ToDate float	Total amount customer is to pay for the policy (already includes discounts and markups)
PreviousAttributes.InsuranceCoverAmount float	Amount of cover the policy includes
PreviousAttributes.DestinationCountry string	Supplier’s policy reference once purchased
PreviousAttributes.PartnerReference boolean	Flag whether the policy has expired
PreviousAttributes.Policy.Code string	Policy Code
PreviousAttributes.Policy.Type string	Policy Type
PreviousAttributes.Policy.Name string	Policy Name
PreviousAttributes.VehicleTypes.freecancellationcover: boolean	Free cancellation cover
PreviousAttributes.VehicleTypes.freetravelinsurance: boolean	Free travel cover
PreviousAttributes.VehicleTypes.car: boolean	Car
PreviousAttributes.VehicleTypes.motorhome: boolean	Motorhome
PreviousAttributes.VehicleTypes.campervan: boolean	Campervan
PreviousAttributes.VehicleTypes.4x4: boolean	4*4
PreviousAttributes.VehicleTypes.minibus: boolean	Minibus
PreviousAttributes.VehicleTypes.lighttruck: boolean	lighttruck
PreviousAttributes.Customer.FirstName: string	FirstName
PreviousAttributes.Customer.LastName: string	LastName
PreviousAttributes.Customer.Email: string	Email
PreviousAttributes.Customer.Age: string	Age
PreviousAttributes.Customer.Country: string	Country