LogoLogo
PayShield - Dispute Alerts
PayShield - Dispute Alerts
  • Overview
  • Webhooks
    • Notification of a New Alert
    • Notification of an Alert Status Update
  • API Endpoints
    • Alert Status Update
    • Test Alert Endpoint
  • Appendix
    • Status
    • Reason Code
    • Result Code
    • Dispute Intelligence Payment Processor field mappings
    • Ethoca Alert Reason Code- New Mapping (from Jun18th, 2024)
    • Verifi Alert Reason Code - New Mapping(from Jun18th, 2024)
Powered by GitBook
On this page
Edit on GitHub
  1. API Endpoints

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

Name
Type
Description

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

comments

String

Reason for not refunding when 900.002 is used as reason code

status

String

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 This is a mandatory parameter 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

merchant_notes

String

Merchant can use this field for their reference. This will be stored in the alert record

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"
}
PreviousNotification of an Alert Status UpdateNextTest Alert Endpoint

Last updated 2 months ago

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

Status of the transaction. - RESOLVED - DECLINED - WIP - OTHER. See for details. This is a mandatory parameter

reason code
result code
status page