Alert Update - Version 1

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Merchant / Client notifying txShield of an update to an alert / action performed in response to an alert by the Merchant / Client
Status updates are initiated from the merchant system to inform TxShield on the status of a previous alert raised from TxShield. Status updates can be synchronous or asynchronous. Synchronous in the return to the alert notification / webhook. Or asynchronous by calling this endpoint.

Version 1
Sandbox: uat.txshield.payshield.ai/secure/alert/update
Production: Please reach out the project team for production endpoints.

Form Data
string

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

string

Status of the transaction. - RESOLVED - DECLINED - WIP - OTHER RESOLVED: The alert may have been resolved under many different conditions. the exact detail of the resolved alert can be sent via the reason_code parameter DECLINED: The alert may have been declined for many reasons. Details of the reason can be sent via the reason_code parameter WIP: The merchant system may respond to an alert as WIP (Work-In-Progress). This will inform TxShield that the merchant system will need more time to respond. The reason_code parameter can hold the details. OTHER: The merchant system can send any other status such as Errors under this parameter. The tx_details parameter could hold the details.

string

Reason code will explain the reason for each “status” parameter. Each status type will have restrictions on what reason_code’s can be used. Which will be mapped under the APPENDIX I The system will only handle one reason code with one status update.

string

Any description regarding the transaction that the merchant system needs to send for future records can be sent as a JSON array

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json