Card Status Updates

Card Status Update (CSU) notifications can be sent to you as a result of a card status change. These are triggered by either Paymentology API's or scheme transactions where incidents of <<glossary:PIN>> verification failure have occurred multiple times. This allows clients to be aware of the activity in real-time as it occurs.

🗒️
You can choose to use a new endpoint or the same endpoint as your <<glossary:FAST>> messages. You are not required to respond to the notification.

Basic CSU message structure

The basic structure of the messages are consistent across the message triggers and are in the form of an envelope message.

`MESSAGE_TYPE`	Field name	Description
	`Message Type`	Type of message. Here, we have e.g. CSU only for now
	`Message Desc`	Description of the message type

Field name	Description	Format	Max length
`Unique Identifier`	Type of message. Here, we have e.g. CSU only for now	String	50
`Client ID`	Description of the message type	Integer (non-negative)	1 to 2147483647
`PID`	Product ID of the card product	Big integer (non-negative)	1 to 9223372036854775807
`Token`	Paymentology's card token	Big integer (non-negative)	1 to 9223372036854775807
`Token Status_Old`	Paymentology's card token's previous state	String	50
`Token Status_New`	Paymentology's card token's new updated state	String	50
`Source`	Source of the message (API name or scheme transaction)	String	250
`Network`	Payment scheme used or card's original network scheme	String	30
`Date_Time`	Date/time of notification message (dd-mm-yyy h: m: s)	String	DD-MM-YYYY HH:MM:SS
`Message_Reason`	Additional information of the message	String	500

CSU notification message samples

Clients who have subscribed to receive Card Status Update notifications, are required to consume the following notification message types.

CSU: Set card status notification

{
    "MESSAGE_TYPE": {
        "Message Type": "CSU",
        "Message Desc": "Card Status Update Notification"
    },
    "SUMMARY": {
        "Unique Identifier": "1234587788996543875631",
        "Client ID": 111222,
        "PID": 101,
        "Token": 987654321,
        "Token Status_Old": "1005",
        "Token Status_New": "1000",
        "Source": "pws_set_card_status",
        "Network": "MC",
        "Date_Time": "10-01-2024 11:52:25",
        "Message_Reason": null
    }
}

CSU: PIN unblock notification

{
    "MESSAGE_TYPE": {
        "Message Type": "CSU   ",
        "Message Desc": "Card Status Update Notification"
    },
    "SUMMARY": {
        "Unique Identifier": "12345678910987654321012",
        "Client ID": 123456,
        "PID": 5,
        "Token": 987654321,
        "Token Status_Old": "1005",
        "Token Status_New": "1000",
        "Source": "pcjs_pin_unblock",
        "Network": "MC",
        "Date_Time": "28-06-2022 15:20:12",
        "Message_Reason": "The card status has been updated from 1005 to 1000"
    }
}

CSU: Verify PIN notification

{
    "MESSAGE_TYPE": {
        "Message Type": "CSU   ",
        "Message Desc": "Card Status Update Notification"
    },
    "SUMMARY": {
        "Unique Identifier": "12345678910987654321012",
        "Client ID": 123456,
        "PID": 5,
        "Token": 987654321,
        "Token Status_Old": "1000",
        "Token Status_New": "1006",
        "Source": "Verify Pin",
        "Network": "Visa",
        "Date_Time": "28-06-2021 15:20:12",
        "Message_Reason": "The card has been blocked due to pin verification failed for successive 4 times"
    }
}

CSU: Scheme transaction notification

{
    "MESSAGE_TYPE": {
        "Message Type": "CSU   ",
        "Message Desc": "Card Status Update Notification"
    },
    "SUMMARY": {
        "Unique Identifier": "1234567",
        "Client ID": 123456,
        "PID": 5,
        "Token": 987654321,
        "Token Status_Old": "1000",
        "Token Status_New": "1006",
        "Source": "Scheme Transaction",
        "Network": "Visa",
        "Date_Time": "28-06-2021 15:20:22",
        "Message_Reason": "The card has been changed from 1000 to 1006 due to successive pin retries limit exceed"
    }
}

🗒️
You can read more about Card status here.

Updated 7 months ago