Event Notifications

Suggest Edits

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:

activated: The DPAN has been changed from Inactive to Active ready for use
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
resumed: Following the status being placed into suspend, this status will allow the DPAN and device to be used again
check_eligibility: Event send at the beginning of the tokenization flow.

The status will be one of the following:

active - the DPAN is active
inactive - the DPAN is inactive
suspend - the DPAN is suspend
deactivated - the DPAN is deactivated

CLOWD9 will not require anything other than acknowledgment from you.

Request

Field	Description	Format
event_type	Identifies the activity	String
created_datetime	The date and time of the request, the number of seconds elapsed since January 1	integer
token_info		Object
dpan_id	The Identifier associated to the DPAN	UUID
card_id	The Identifier associated to the Card	UUID
token_reference_id	Unique ID for the token associated with the PAN	String
pan_reference_id	Network generated Identifier	String
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 if applicable	String

Example

Example 1 - DPAN was activated,

{
  "created_datetime": 1754318722,
  "event_type": "activated",
  "token_info": {
    "card_id": "47277b0d-2aa6-48ab-a2f5-7a5dababf2f8",
    "client_id": "82d890aa-f083-4359-a1c8-5cd483ba40e8",
    "dpan_id": "07cf880d-3f36-480d-b2d0-fffc6529b681",
    "network": "visa",
    "pan_reference_id": "V-3025197339880335891989",
    "previous_status": "inactive",
    "status": "active",
    "token_reference_id": "DNITHE302521033484727131"
  }
}

Example 2 - DPAN Check Eligibility

{
  "created_datetime": 1754313047,
  "event_type": "check_eligibility",
  "token_info": {
    "card_id": "47277b0d-2aa6-48ab-a2f5-7a5dababf2f8",
    "client_id": "82d890aa-f083-4359-a1c8-5cd483ba40e8",
    "network": "visa",
    "pan_reference_id": "V-3025197339880335891989",
    "previous_status": "",
    "status": "",
    "token_reference_id": "DNITHE302521033484727131"
  }
}

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": "82d890aa-f083-4359-a1c8-5cd483ba40e8",
  "customer_id": "ea32381c-5889-4aa4-9dc4-7d24cccd9b1d",
  "card_id": "47277b0d-2aa6-48ab-a2f5-7a5dababf2f8",
  "status": "ok"
}

Updated about 1 month ago