During the DPAY Provisioning process and the DPAY Lifecycle, there will be Event Notification messages sent by CLOWD9. The event_type will be one of the following:

created: The DPAN token has been created by the Network
activate: The DPAN has been changed from Inactive to Active ready for use
deactivated: The DPAN???
deleted: The DPAN can no longer to be used. This will be removed from the Wallet Provider via communication from the Network. If the Customer wishes to use their device again, they will need to start the tokenization process from the beginning
suspend: In the event the Customer does not wish to use the device for payments or has misplaced their device, they can change the status to a temporary suspend status. To use the device again, the DPAN will need to set to resume. If the device has been lost / stolen or cannot be found for any reason, the DPAN should be set to deleted
resume: Following the status being placed into suspend, this status will allow the DPAN and device to be used again

CLOWD9 will not require anything other than acknowledgment from you.

Request

Field	Description	Format
event_type	Identifies the activity	UUID
token_info
dpan_id	The Identifier associated to the DPAN	UUID
card_id	The Identifier associated to the Card
token_reference_id	Unique ID for the token associated with the PAN	UUID
pan_reference_id	Network generated Identifier
client_id	The Identifier associated to the Client	UUID
customer_id	The Identifier associated to the Customer	UUID
network	Identifies the Network associated with the Wallet Provider	String
status	The current status of the DPAN	String
previous_status	The previous status of the dpan_id if applicable	string
created_at	The date and time of the eligibility request	integer

Example

{
  "event_type": "EVENT_TYPE",
  "token_info": {
    "dpan_id": "cd7aef59-8fcf-4f48-95fd-5c93a8dbf3d5",
    "card_id": "ab1d3c7a-7cfa-4d80-b0b0-4c45c2b2d9ab",
    "token_reference_id": "4f3ac7e0-1d43-4e96-a60d-21a5931c3cf2",
    "pan_reference_id": "f2d8e30f-6fbd-4d56-bdd3-8cb08f0b2d3f",
    "client_id": "15c2e81b-cc4d-405f-ae95-2fdc3763c09a",
    "customer_id": "15c2e81b-cc4d-405f-ae95-2fdc3763c09a",
    "network": "Network",
    "status": "SUSPENDED",
    "previous_status": "ACTIVE"
  },
  "created_at": 1718793600
}

Response

Field Name	Description	Format
client_id	The Identifier associated to the Client	UUID
customer_id	The Identifier associated to the Customer	UUID
card_id	The Identifier associated to the Card	UUID
status	Status of the web hook request. Should carry a static value of “ok”	String

Example

{
 "client_id": "123e4567-e89b-12d3-a456-426614174000",
 "customer_id": "123e4567-e89b-12d3-a456-426614174002",
 "card_id": "123e4567-e89b-12d3-a456-426614174001",
 "status": "ok",
}