Card Shipment Notification

A notification providing details of postal tracking of card requests. This notification will contain information including the tracking number and how to access tracking information.

Card Shipment notification parameters

Parameters	Type	Description
NotificationType	string	Three-digit unique identifier of notification. Numeric value "067" denotes the Card Shipment Notification for a card request
ConsumerID	integer	Unique identifier of the consumer.
CardID	integer	Unique identifier of the card.
CourierCompanyName	string	Name of Courier company.
TrackingMethodID	integer	Tracking method, denotes how tracking can be undertaken. Will be one of the following: 1 - SMS, 2 - Website, 3 - Other
TrackingNumber	integer	Unique number provided by the Courier company. Docket Number to track order.
TrackingMethodDetail	string	A detailed description to track the docket. This will vary depending on the `TrackingMethodID`. TrackingMethodID = 1 (SMS) - "[courier supplied contact number]" TrackingMethodID = 2 (Website) "Track your order on [courier supplied URL]" TrackingMethodID = 3 (Other) - "Track your order by [other specified method]"
SecurityHash	string	Contains the hash of the payload values and your webhook security key, to verify the origin and integrity of the notification.

Example of Card Shipment notification

Copy

Copied

{
   "NotificationType": "067",
   "ConsumerID": "198393",
   "CardID": "86272",
   "CourierCompanyName": "DHL Deutsche Post",
   "TrackingMethodID:": "2",
   "TrackingNumber": "4E8CAD32-B895-4DA9-AEDC-4E27BB75F72C",
   "TrackingMethodDetail": "Track your order on https://www.deutschepost.de/sendung/simpleQuery.html?locale=en_GB",
   "SecurityHash": "7b3c391e94f9c4a1ba0588cfbf8573a6e307964633391c651e3879f67f399128"
}

Validating the notification security hash

Security Hash validation

See the respective guide for more information on calculating and verifying the notification security hash.

To compute the hash of the notification payload, concatenate the payload values in the following sequence, with your webhook security key as the final item:

Copy

Copied

<NotificationType>&<ConsumerID>&<CardID>&<CourierCompanyName>&<TrackingMethodID>&<TrackingNumber>&<TrackingMethodDetail>&<webhook-security-key>

The payload values above and example webhook security key of abcdefghijklmnop, will produce the following hash input:

Copy

Copied

067&198393&86272&DHL Deutsche Post&2&4E8CAD32-B895-4DA9-AEDC-4E27BB75F72C&Track your order on https://www.deutschepost.de/sendung/simpleQuery.html?locale=en_GB&abcdefghijklmnop