Notifications

Overview

Notifications are the means by which Kinetic Advantage notifies partners of certain events.

These events include:

  • Floorplan status updates (notificationType = "Floorplan Status Update")

  • Payments (notificationType = "Floorplan Payment")

Notifications are sent via a POST request when one of the above events happen. A partner will configure an endpoint to recieve the notifications. All notifications will have a JSON body with a "notificationType" property reflecting the type of notification as specified in the list above.

Security

Kinetic Advantage will send the partnerKey in the header in the same way the partnerKey is passed to Kinetic's API. Verify the partnerKey is correct to ensure the request originated from Kinetic Advantage.

Retries

If the attempt to deliver the notifications is unsuccessful (anything but an HTTP 2xx response) will trigger retries. We will retry the delivery attempt on the following schedule:

  • 10 seconds

  • 1 minute

  • 5 minutes

Floorplan Status Updates

These notifications are sent when a floorplan is approved or declined.

Sample

{ "notificationType": "Floorplan Status Update", "time": "2021-03-23T15:48:24.9258213Z", "vin": "1C3CDZABXDN566086", "dealerId": "D50", "auctionAccessId": 1234567, "floorplanId": "b22941da-55c1-42c3-9ec8-8dbab6909277", "decision": "Approved", "reason": null }

Fields

  • notificationType - Represents the type of notifications being sent.

  • time - The UTC time of the event.

  • vin - The VIN of the vehicle on the floorplan.

  • dealerId - The unique identifier for the dealer as defined and used by Kinetic Advantage.

  • auctionAccessId - Auction Access ID as defined by Auction Access.

  • floorplanId - The unique identifier for the floorplan as defined and used by Kinetic Advantage. This is returned on floorplan request responses.

  • decision - The decision made on the floorplan (either "Approved" or "Declined").

  • reason - (optional) A reason may be provided if the floorplan was declined.

Floorplan Payment Notifications

These notifications are sent when payment is made for a floorplan.

Sample

{ "notificationType": "Floorplan Payment", "time": "2021-03-23T15:48:24.9258213Z", "vin": "1C3CDZABXDN566086", "dealerId": "D50", "auctionAccessId": 1234567, "floorplanId": "b22941da-55c1-42c3-9ec8-8dbab6909277", "amount": 10500, "method": ACH "paymentId": 210323342565324 }

Fields

  • notificationType - Represents the type of notifications being sent.

  • time - The UTC time of the event.

  • vin - The VIN of the vehicle on the floorplan.

  • dealerId - The unique identifier for the dealer as defined and used by Kinetic Advantage.

  • auctionAccessId - Auction Access ID as defined by Auction Access.

  • floorplanId - The unique identifier for the floorplan as defined and used by Kinetic Advantage. This is returned on floorplan request responses.

  • amount - The payment amount.

  • method - The payment method (Wire, Check, ACH).

  • paymentId - The payment id as defined and used by Kinetic Advantage. Use this to reference a specific payment.