Alert Status Update

Notify TxAlert of actions taken and status updates on the alert by a merchant.

Status updates are initiated from the merchant system to inform TxShield about the status of a previous alert raised by TxShield. Updates can be synchronous, returning to the alert notification/webhook, or asynchronous when calling this endpoint.

POST https://uat.txshield.payshield.ai/secure/alert/update/v2/

Request Body

NameTypeDescription

alert_outcome_currency

String

The currency for the alert_outcome_amount

alert_outcome_amount

String

The amount that was cancelled / refunded. Can be partial or full amount of the alert.

alert_outcome_action_date

String

The date & time that the outcome was reached on, e.g. the time and date that the refund was processed.

reason_code

String

Reason code will explain the reason for each “status” parameter. It should be in the format xxx.yyy where xxx is the reason code and yyyy is the result code.

status

String

Status of the transaction. - RESOLVED - DECLINED - WIP - OTHER. See status page for details

alert_id

String

Alert ID from the original alert sent by TxShield. This is a mandatory parameter to map the status update of the initial alert

tx_details[].duplicate_alertid

String

alertid of the duplicate alert when using reason code 940.***

tx_details[].userid

String

Merchant can pass the userid of the user who did the action in this field

tx_details[].username

String

Merchant can pass the user name of the user who did the action in this field

txdetails[]

String

Merchant can use json structure to send the details of the user or the duplicates in this field

Example

JSON : Header

"rcode: xxxxxxxxxxx ",
"Content-Type: application/json"

JSON : Format

Postdata
{
“alert_id”: 10001,
“status”: “resolved”,
“reason_code”: ”100.001”,
“tx_details”: {"duplicate_alertid":"12323" },
“alert_outcome_action_date“: “2020-11-09T05:00:00+02:00“,
“alert_outcome_amount“: “10“,
“alert_outcome_currency“: “USD“
}

Last updated