Notification of an Alert Status Update
The notification of an Alert's status update will push a notification to the merchants system that an alert has had its status updated. The merchant must opt in to receive these notifications This will happen when the status field of an alert has changed, if any other field is updated and the status remains the same, it will not send a notification.
The merchant must provide TxShield with the URL that they want the status update notifications sent to. This must be a https URL. The merchant can also, and it's also strongly recommended, that they protect the endpoint with a long lived bearer token that they provide to TxAlert.
POST https://{merchant_supplied_url}
The data in this call is sent as x-www-form-urlencoded data.
Request Body
action
Sting
"statusupdate"
alert_id
String
Alert ID from TxShield.
status
String
reason_code
String
reason code that was updated. In case of RDR_DELETE, the reason_code will be empty Refer table below
merchant_update_on
String
Date when the update was received from merchant(not available for RDR Delete)
outcome_updated_on
String
Date when provider was updated successfully(not available for RDR Delete)
alert_outcome_amount
String
amount refunded. available if present in the status update
alert_outcome_currency
String
currency of the amount refunded. available if present in the status update
alert_outcome_action_date
String
outcome action date. available if present in the status update
tx_details[]
Array
variable information, available only if present in status update
merchant_notes
String
available only if present in the status update
comments
String
available only if present in the status update
Example
Headers
Data - full
The full data set being sent. The data in this call is sent as x-www-form-urlencoded data.
Last updated