Alert

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

Payment Processor Field Mapping

Mappings from txShield name to the Payment Processors Field name.

NMI
Mappings for the tx_details values for transactions processed through NMI.

txShieldNMI
payment_gateway_referencetransaction_id
payment_gateway_reference2order_id
payment_gateway_tx_typeaction_type
payment_gateway_transaction_datedate
Query Params
string
enum

Masked or unmasked card number

Allowed:
string

Authentication date/time for the transaction

string

The merchant descriptor is the description as seen on the card holders’ statement

string

Transaction amount

string

Transaction currency

string

Acquirer Reference Number (ARN) is a unique 23-digit number that tags a card transaction when it goes from the merchant bank (acquiring bank) through the card scheme to the cardholders’ bank

string

Alert ID from TxShield. This ID should be used when sending status updates

string

Type of the alert or event - DISPUTE - DISPUTE_RDR - DISPUTE_NOTICE - CANCEL - FRAUD_NOTICE

string

Action to be taken on the merchant system - REFUND - CANCEL - REVIEW - MATCHED - RESOLVED The action required by the merchant to take, for this alert. Or in the case of an alert_type of DISPUTE_RDR, the action that has already been taken.

string

auth_code is sent by the alert provider. TxShield will send the same auth_code to the merchant. In some cases, the auth_code can be empty.

string

descriptor_id is a code given by the merchant for each descriptor. TxShield will send this descriptor code with every alert sent to the merchant. The idea of this code is to make the merchant system search its transactions faster. This ID is not used in TxShield for any of its processes. This is treated as a merchant reference code.

string

The name of the provider the alert originated from.

string

JSON array containing orderid and transactionid when a matched refund is done

string

JSON Object that represents the original transaction the alert is raised for, with the payment processors details . The 4 fields inside the object are from the payment gateway. If null, no direct match could be found.

string

JSON Object that represents the refund transaction which was raised to reverse the alert_transactions . The 4 fields inside the object are from the payment gateway. If null, no refund transaction was able to be found, or processed.

string

JSON Array that contains transaction objects. Each transaction object is potentially a match for the alert. It may not be a complete list, and a manual review is required to identify the transaction that the alert is for. The transaction object inside the array are using payment gateway data. If null, no partial matches were found, or an exact match was found.

Response

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