Test Alert Endpoint

The test alert endpoint allows you to create alerts with different values in the system. This will then trigger the full alert workflow for those alerts. If configured, you should receive new webhook calls, alerts in the front end, or emails notification. Please note, this will only be available to you once you have completed on boarding.

POST https://uat.txshield.payshield.ai/secure/alerts/txshield_dummy

Request Body

NameTypeDescription

txdetails

String

auth_code

String

auth_code of the transaction if known

arn

String

arn of the transaction if known

alert_action

String

This will be supplied to you.

alert_type

String

This will be supplied to you.

currency

String

ISO 4217 3 character Currency Code. e.g. "USD"

amount

String

Value of the transaction as a string, including decimals. e.g. "10.00"

descriptor

String

descriptor the transaction was processed under. This will be supplied.

transaction_timestamp

Datetime

ISO 8601 timestamp of the transaction. You can find the time stamp on https://www.utctime.net/ as UTC. See example for format.

card

String

Card number used in the transaction. Should be masked. e.g. "411111******1111"

Example

JSON

{
"card" : "411111******1111",
"transaction_timestamp" :  "2021-10-11T00:00:23.000Z",
"descriptor" : "testnmi",
"amount" : "10.00",
"currency" : "USD",
"alert_type" : "Confirmed Fraud",
"alert_action" : "REFUND",
"arn" : "",
"auth_code" : "",
"txdetails" : ""
}

Last updated