On this page:

Overview
Authenticating the DMN
General Parameters
Pre-chargeback Inquiry
Pre-chargeback Alert
Chargeback/Dispute
PayFac Submerchant Creation
Manual Corrected
Control Panel Generated Transaction
Manual Inserted
Fraud Reported Transaction
External Pre-chargeback Alert
External RDR Case

Overview

The Events Configuration settings in the Control Panel allow merchants to enable and configure Direct Merchant Notifications (DMNs), also known as a webhooks, for certain types of events. DMNs are particularly useful for asynchronous events; for example, when a customer’s bank opens an Order Insight inquiry or when a customer disputes a charge. Instead of pulling information via our API, DMNs push the information to merchants when important events occur.

You can enable and configure DMNs for these event types:

Pre-chargeback Inquiry – Notifies you that you received an Order Insight inquiry (Visa pre-chargeback), which may have been automatically responded to by Nuvei on your behalf.
Pre-chargeback Alert – Notifies you that you received an Ethoca alert (Mastercard pre-chargeback), which may require a decision to be made either in Nuvei’s Case Management interface or based on an automated rule (automatic refund).
Chargeback/Dispute – Notifies you that you have either received a new chargeback/dispute, which requires your response, OR that a chargeback/dispute status has been updated following your response.
PayFac Submerchant Creation – Relevant only for payment facilitators, this notification acknowledge a successful creation of a submerchant account.
Manual Correction – Notifies you that transaction was manually corrected by the Nuvei Operation Team.
Control Panel Generated Transaction – Notifies you that a new transaction was created manually in one of the following options (reports and actions):
- Bulk Upload: Void, Refund, Settle, Payout
- Transactions Report: Void, Refund, Settle, Payout, Void Credit, Fast Payout
- Chargebacks Report: Refund
- Risk Alerts – Transaction: Void, Refund, Settle
- Risk Alerts – User: Void, Refund, Settle
- Lifecycle: Void, Refund, Payout, Void Credit, Fast Payout
Manual Inserted – Notifies you that transaction was manually inserted by the Nuvei Operation Team.
Fraud Reported Transaction – Notifies you on transactions that have been reported as “Fraud” by issuer banks and are being considered when measuring your compliance with the card schemes’ fraud programs. These transactions may or may not be reported as chargebacks.
External Pre-chargeback Alert – Notifies you that you received an Ethoca alert for an external (non-Nuvei) transaction. You may wish to send a decision response via REST API.
External RDR Case – Notifies you that an RDR case has been processed for an external (non-Nuvei) transaction.

An event DMN consists of general parameters and the parameters specific to the event type listed below.

Example Pre-chargeback Alert DMN

{
  "EventId": "fec2486c-0784-4641-b777-a7d190541ecf",
  "EventDate": "2020-07-14 17:19:34.970",
  "EventType": "Pre-Chargeback Alert",
  "ProcessingEntityType": "multiClient",
  "ProcessingEntityId": "3245",
  "AttemptNumber": 1,
  "ClientId":15830,
  "ClientName": "Test Client",
  "EventDateUTC":"2023-06-18T11:15:40.079Z",
  "EventCorrelationId":"generated guid",
  "Alert":{
    "AlertReceivedDate":"2018-02-27T04:33:04.000",
    "EthocaId":"kEYWGEwlBpWqfthbLEbKIXYTC",
    "AlertType":"issuer_alert",
    "AlertTimestamp":"2018-02-27T04:33:04.000",
    "Issuer":"Bank of ABC",
    "MaskedCreditCard":"1***********4444",
    "Arn":"64738272371643523456435",
    "Amount":10,
    "Currency":"USD",
    "TransactionId":"abcd1234567890"
  },
"TransactionDetails":{
  "TransactionId":2110000000002089574,
  "TransactionDate":"2020-07-14T17:19:34.970",
  "TransactionAmount":6,
  "TransactionCurrency":"eur",
  "Email":"[email protected]",
  "ClientUniqueId":"61038"
  }
}

Authenticating the DMN

Event DMNs include a checksum in the header that merchants can use to verify Nuvei sent the DMN and that it was not manipulated by any external parties.

To authenticate an event DMN:

Concatenate into a string all of the parameter values in the JSON payload of the DMN in the exact order that they are sent.
Add merchantSecretKey to the beginning of that string.
Encrypt the entire string with SHA-256.
Use encoding passed from the merchant site to create the encryption. The default encoding is UTF-8 (unless the encoding input parameter specifies otherwise).
Compare the result to the checksum in the header of the DMN. If they match, Nuvei sent the DMN.

This checksum calculation is only relevant for event DMNs.

Example DMN JSON Payload

{
  "ClientId": 151999723,
  "ClientName": "Test Client",
  "EventType": "Chargeback",
  "EventDateUTC": "2022-05-18T08:21:23.3749665Z",
  "EventCorrelationId": "0bd473cb-093b-4540-971b-6f0773be755b",
  "Chargeback": {
    "Date": "09/04/2018 10:37:17",
    "StatusCategory": "Regular",
    "Type": "Chargeback",
    "Status": null,
    "Amount": 10.25,
    "Currency": "eur",
    "ChargebackReason": "10.4 - Other Fraud-Card Absent Environment",
    "ReasonMessage": "Other Fraud-Card Absent Environment",
    "DisputeDueDate": null
  },
  "TransactionDetails": {
    "TransactionId": 382511946222,
    "TransactionDate": "09/01/2018 10:37:17",
    "ClientUniqueId": null,
    "AcquirerName": "Demo Bank",
    "MaskedCardNumber": "1***********1234",
    "Arn": "05295314304000000000456"
  }
}

Example `merchantSecretKey`

DlgOtMNE0DhcJelIQLzc1PN0zcEqugkplNRTeYorjRDgAX0aM4rab7BT9OVF2iuY

For this example event DMN and merchantSecretKey, the string before encryption is:

DlgOtMNE0DhcJelIQLzc1PN0zcEqugkplNRTeYorjRDgAX0aM4rab7BT9OVF2iuY{“ClientId”:151999723,”ClientName”: “Test Client”,”EventType”:”Chargeback”,”EventDateUTC”:”2022-05-18T08:21:23.3749665Z”,”EventCorrelationId”:”0bd473cb-093b-4540-971b-6f0773be755b”,”Chargeback”:{“Date”:”09/04/2018 10:37:17″,”StatusCategory”:”Regular”,”Type”:”Chargeback”,”Status”:null,”Amount”:10.25,”Currency”:”eur”,”ChargebackReason”:”10.4 – Other Fraud-Card Absent Environment”,”ReasonMessage”:”Other Fraud-Card Absent Environment”,”DisputeDueDate”:null},”TransactionDetails”:{“TransactionId”:382511946222,”TransactionDate”:”09/01/2018 10:37:17″,”ClientUniqueId”:null,”AcquirerName”:”Demo Bank”,”MaskedCardNumber”:”1***********1234″,”Arn”:”05295314304000000000456″}}

After SHA-256 encryption, the checksum should be:

2729122933fb1f3296c590a630520a96443ab01fdc35c9885aab3855fa0677c6

General Parameters

Example General Parameters

{
  "EventId": "fec2486c-0784-4641-b777-a7d190541ecf",
  "EventDate": "2020-07-14 17:19:34.970",
  "EventType": "Pre-Chargeback Alert",
  "ProcessingEntityType": "multiClient",
  "ProcessingEntityId": "3245",
  "AttemptNumber": 1,
  ...
}

Descriptions of General Parameters

Parameter	Type	Mandatory	Notes
EventId	char (36)	Y	GUID – Generated by Events API
EventDate	datetime	Y	Current date and time Example: 2020-12-28T17:32:00.727+02:00
EventType	string	Y	Possible values: Pre-chargeback Inquiry Pre-chargeback Alert Chargeback PayFac Submerchant Creation Manual Correction Control Panel Generated Transaction Manual Inserted
ProcessingEntityType	string	Y	Indicates the client level for which the event is set up. Valid Values: client – For events set up on a specific client. multiClient – For events set up on a group of clients under a multi-client account.
ProcessingEntityId	Int	Y	Indicates the Client or Multi-client ID for which the event is set up.
AttemptNumber	int	Y	Is "1" the first time.

Pre-chargeback Inquiry

Example Pre-chargeback Inquiry Parameters

{
  ...
  "ClientId": 15830,
  "ClientName": "Test Client",
  "EventType": "Pre-Chargeback Inquiry",
  "EventDateUTC": "2023-06-18T11:16:08.977Z",
  "EventCorrelationId": "c098a75e-e2c8-4027-94dd-b876921f08ba",
  "TransactionId": 2110000000002786600,
  "TransactionDate": "2020-12-28T15:32:00.727",
  "ClientUniqueId": "58685",
  "MaskedCreditCard": "5***********0008",
  "Email": "[email protected]"
}

Descriptions of Pre-chargeback Inquiry Parameters

Parameter	Description	Type
ClientId	An ID assigned to your account by Nuvei.	Number
ClientName	Client name as it appears in the Control Panel.	String
EventDateUTC	Notification date and time in UTC. Example: 2018-02-27T04:33:04.000Z	String
EventCorrelationId	The notification unique ID. Example: b217ea66-f592-47dc-a290-75af39243107	String
TransactionId	The Nuvei Transaction ID to which the pre-chargeback inquiry is related.	Number
TransactionDate	The date and time when the original transaction was processed. Example: 2020-12-28T17:32:00.727+02:00	String
ClientUniqueId	Displays the merchant's unique reference sent for the original processed transaction.	String
MaskedCreditCard	The masked 16-character debit or credit card number, which shows the first digit and last four digits of the card. Example: 1***********2453	String
Email	The customer's email address (the consumer who initiated the transaction).	String

Pre-chargeback Alert

Example Pre-chargeback Alert Parameters

{
  ...
  "ClientId": 15830,
  "ClientName": "Test Client",
  "EventType": "Pre-Chargeback Alert",
  "EventDateUTC": "2023-06-18T11:15:40.079Z",
  "EventCorrelationId": "generated guid",
  "Alert": {
    "AlertReceivedDate": "2018-02-27T04:33:04.000",
    "EthocaId": "kEYWGEwlBpWqfthbLEbKIXYTC",
    "AlertType": "issuer_alert",
    "AlertTimestamp": "2018-02-27T04:33:04.000",
    "AlertAge": 15,
    "Decision": "Resolved and process Refund",
    "Refunded": "True"
    "RefundTransactionId": 113000000235656,
    "Issuer": "Bank of ABC",
    "MaskedCreditCard": "1***********4444",
    "Arn": "64738272371643523456435",
    "Amount": 10,
    "Currency": "USD",
    "TransactionId": "abcd1234567890"
  },
  "TransactionDetails": {
    "TransactionId": 2110000000002089574,
    "TransactionDate": "2020-07-14T17:19:34.970",
    "AuthCode": "DSC871",
    "TransactionAmount": 6,
    "TransactionCurrency": "eur",
    "Email": "[email protected]",
    "ClientUniqueId": "61038"
  }
}

Descriptions of Pre-chargeback Alert Parameters

Parameter	Description	Type
ClientId	An ID assigned to your account by Nuvei.	Number
ClientName	Client name as it appears in the Control Panel.	String
EventDateUTC	Notification date and time in UTC. Example: 2018-02-27T04:33:04.000Z	String
EventCorrelationId	Notification unique ID. Example: b217ea66-f592-47dc-a290-75af39243107	String
Alert.AlertReceivedDate	Alert creation date in Ethoca.	String
Alert.EthocaId	Unique ID assigned to the alert by Ethoca.	String
Alert.AlertType	Represents the type of alert – Consumer or Issuer generated. Example: issuer_alert, customerdispute_alert	String
Alert.AlertTimeStamp	Notification date and time.	String
Alert.AlertAge	Number of days between transaction date and alert date.	Number
Alert.Decision	Indicates the Merchant's decision upon responding to the alert, extracted from the Case Management system's 'Decision' column.	String
Alert.Refunded	Indicates whether the transaction was refunded based on the decision made. Possible values: True, False.	String
Alert.RefundTransactionId	The Transaction ID related to the refund.	Number
Alert.Issuer	Card issuer name.	String
Alert.MaskedCreditCard	The masked 16-character debit or credit card Number, which shows the first digit and last four digits of the card. Example: 1***********2453	String
Alert.Arn	The Acquirer Reference Number associated with the original transaction.	Number
Alert.Amount	The amount stated in the Ethoca alert.	Number
Alert.Currency	The currency stated in the Ethoca alert. Example: USD	String
Alert.TransactionId	The Scheme Reference Transaction ID.	Number
TransactionDetails.TransactionId	The Nuvei original Transaction ID.	Number
TransactionDetails.TransactionDate	Date and time of the original transaction processing.	String
TransactionDetails.AuthCode	Authorization code for the transaction.	String
TransactionDetails.TransactionAmount	The amount of the original transaction.	Number
TransactionDetails.TransactionCurrency	The currency in which the original transaction was processed.	String
TransactionDetails.Email	The customer's email address (consumer who initiated the transaction).	String
TransactionDetails.ClientUniqueId	Displays the merchant's unique reference sent for the original processed transaction.	String

Chargeback/Dispute

Example Chargeback/Dispute Parameters

{
  ...
  "ClientId": 15830,
  "ClientName": "Test Client",
  "EventType": "Chargeback",
  "EventDateUTC": "2023-06-18T11:11:13.190Z",
  "EventCorrelationId": "1d1e7149-15cb-427e-a313-3bfadcd25069",
  "Chargeback": {
    "Date": null,
    "ChargebackStatusCategory": "Regular",
    "Type": "Chargeback",
    "Status": null,
    "Amount": 10.25,
    "Currency": "eur",
    "ReportedAmount": 10.25,
    "ReportedCurrency": "eur",
    "ISOCurrency": null,
    "ChargebackReason": "10.4 - Other Fraud-Card Absent Environment",
    "ReasonMessage": "Other Fraud-Card Absent Environment",
    "DisputeDueDate": null,
    "ChargebackReasonCategory": "Fraud"
  },
  "TransactionDetails": {
    "TransactionId": 382511946565,
    "TransactionDate": null,
    "ClientUniqueId": null,
    "AcquirerName": "Nuvei Demo Bank",
    "MaskedCardNumber": "1***********1234",
    "Arn": "05295314304000000000142"
  }
}

Description of Chargeback Parameters

Parameter	Description	Type
ClientId	An ID assigned to your account by Nuvei.	Number
ClientName	Client name as it appears in the Control Panel.	String
EventDateUTC	Notification date and time in UTC. Example: 2018-02-27T04:33:04.000Z	String
EventCorrelationId	Notification unique ID. Example: b217ea66-f592-47dc-a290-75af39243107	String
Chargeback.Date	Displays the date on which the chargeback was initiated.	String
Chargeback.ChargebackStatusCategory	Chargeback category. Possible values: Regular, cancelled, Duplicate	String
Chargeback.Type	The type of the chargeback (“Chargeback” or “Retrieval”).	String
Chargeback.Status. (New Suite Only)	Current status of the chargeback.	String
Chargeback.Amount	The amount charged back by the issuer.	Number
Chargeback.Currency	The currency in which the chargeback was processed.	String
Chargeback.ReportedAmount	The chargeback reported amount that is returned from the issuer.	String
Chargeback.ReportedCurrency	The chargeback reported currency that is returned from the issuer.	String
Chargeback.ISOCurrency	The 3-letter ISO currency code.	String
Chargeback.ChargebackReason	Chargeback reason codes as per scheme rules.	String
Chargeback.ReasonMessage	Issuers description of the chargeback reason.	String
Chargeback.DisputeDueDate	For future use.	String
Chargeback.ChargebackReasonCategory	The chargeback category.	String
TransactionDetails.TransactionId	The Nuvei original Transaction ID to which the chargeback alert is related.	Number
TransactionDetails.TransactionDate	Date and time of the original transaction processing.	String
TransactionDetails.ClientUniqueId	Displays the merchant's unique reference sent for the original processed transaction.	String
TransactionDetails.AcquirerName	The acquirer bank name that processed the original transaction.	String
TransactionDetails.MaskedCardNumber	The masked 16-character debit or credit card Number, which shows the first digit and last four digits of the card. Example: 1***********2453	String
TransactionDetails.Arn	The Acquirer Reference Number associated with the original transaction.	String

PayFac Submerchant Creation

Example PayFac Submerchant Creation Parameters

{
  ...
  "Message": {
    "MultiClientId":"13244",
    "SubMerchant":{
      "ClientId":"1806",
      "ClientName":"TestSubMerchantName9",
      "MerchantSiteId":"1234"
    }
  }
}

Description of PayFac Submerchant Creation Parameters

Parameter	Description	Type
MultiClientId	The unique identifier for the PayPac account set by Nuvei.	Number
SubMerchant.ClientId	The created submerchant unique ID.	Number
SubMerchant.ClientName	The created submerchant name.	String
SubMerchant.MerchantSiteId	The created submerchant website ID.	Number

Manual Corrected

Example Manually Corrected Parameters

{
  ...
  "ClientId": 15830,
  "ClientName": "Test Client",
  "EventDateUTC": "2023-06-18T11:09:15.385Z",
  "EventCorrelationId": "7e78c7af-72a1-44b0-8b20-f957aef03b83",
  "Correction": {
    "Id": 1000102244,
    "Date": "2020-02-11T12:41:10.667",
    "Details": {
      "Description": "Sale: Declined -> Approved",
      "FromResult": "Declined",
      "ToResult": "Approved"
    },
    "Reason": "Reversal request by Nuvei",
    "Demander": "Operations",
    "Comments": "my correction test",
    "TransctionDetails": {
      "TransctionId": 0,
      "TansactionDate": "0001-01-01T00:00:00.000",
      "TransactionType": "Sale",
      "ClientUniqueId": null
    }
  }
}

Description of Manually Corrected Parameters

Parameter	Description	Type	Example
ClientId	An ID assigned to your account by Nuvei.	Number	"1091"
ClientName	The merchant account name.	String	Daniel Test
EventDateUTC	Notification date and time in UTC.	String	"2020-12-28T17:32:00.727"
EventCorrelationId	Notification unique ID.	String	"b217ea66-f592-47dc-a290-75af39243107"
Correction.Id	The Nuvei correction unique identifier.	Number	"1000102244"
Correction.Date	Date of the manual correction.	String	"2020-02-11 12:41:10.667"
Correction.Details.Description	Transaction type, original status, and updated status.	String	"Credit: Approved -> Declined"
Correction.Details.FromResult	Transaction original status.	String	"Approved"
Correction.Details.ToResult	Transaction corrected status.	String	"Declined"
Correction.Reason	Reason of the applied correction.	String	"Reversal request by Nuvei"
Correction.Demander	Name of the correction demander.	String	"Operations"
Correction.Comments	Comments by the correction demander.	String	"my correction test"
Correction.TransctionDetails.TransactionId	The updated transaction's unique Nuvei ID.	Number	"2110000000001491500"
Correction.TransctionDetails.TransactionDate	The updated transaction's date.	String	"2020-02-11 12:15:24.790",
Correction.TransctionDetails.TransactionType	The updated transaction's type.	String	"Credit"
Correction.TransctionDetails.ClientUniqueId	Displays the merchant's unique reference sent for the original processed transaction.	String	"33354343"

Control Panel Generated Transaction

Example Control Panel Generated Parameters

{
  ...
  "ClientId": 1091,
  "EventDateUTC": "2020-12-28T17:32:00.727",
  "EventCorrelationId": "b217ea66-f592-47dc-a290-75af39243107",
  "ClientName": "Daniel Test",
  "TransactionDetails": {
    "TransactionId": 2110000000002089500,
    "TransactionDate": "2020-07-14 17:19:34.970",
    "TelatedTransactionId": 2110000000002089488,
    "ClientUniqueId": "463453778",
    "TransactionAmount": 100.20,
    "TransactionCurrency": "eur",
    "AcquirerName": "Nuvei",
    "PaymentMethod": "Mastercard",
    "TransactionType": "Credit",
    "TransactionResult": "Approved",
    "Email": "[email protected]",
    "UserTokenId": "21312D"
  }
}

Description of Control Panel Generated Parameters

Parameter	Description	Type	Example
ClientId	An ID assigned to your account by Nuvei.	Number	"1091"
EventDateUTC	Notification date and time in UTC.	String	"2020-12-28T17:32:00.727"
EventCorrelationId	Notification Unique ID.	String	"b217ea66-f592-47dc-a290-75af39243107"
ClientName	The merchant account name.	String	"Daniel Test"
TransactionDetails.TransactionId	The Nuvei unique Transaction ID.	Number	"2110000000002080000"
TransactionDetails.TransactionDate	Date of the transaction.	String	"2020-07-14 17:19:34.970"
TransactionDetails.RelatedTransactionId	The Nuvei original Transaction ID to which the manual transaction is related.	Number	"2110000000002089488"
TransactionDetails.ClientUniqueId	Displays the merchant's unique reference sent for the original processed transaction.	String	"463453778"
TransactionDetails.TransactionAmount	The inserted transaction amount.	Number	"100.20"
TransactionDetails.TransactionCurrency	The inserted transaction currency.	String	"eur"
TransactionDetails.AcquirerName	The acquirer bank name that processed the transaction.	String	"Nuvei"
TransactionDetails.PaymentMethod	Payment method type used for the transaction.	String	"Mastercard"
TransactionDetails.TransactionType	The inserted transaction's type.	String	"Credit"
TransactionDetails.TransactionResult	The inserted transaction's result.	String	"Approved"
TransactionDetails.Email	The customer's email address (consumer who initiated the transaction).	String	"[email protected]"
TransactionDetails.UserTokenId	Displays the merchant's unique identifier of the client.	String	"21312D"

Manual Inserted

Example Manually Inserted Parameters

{
  ...
  "ClientId": 15830,
  "EventDateUTC": "2023-06-18T11:13:53.381Z",
  "EventCorrelationId": "774b05e4-e209-48dc-ac77-42a0119b8792",
  "ClientName": "Daniel Test",
  "TransactionDetails": {
    "TransactionId": 2110000000002089500,
    "TransactionDate": "2020-07-14T17:19:34.970",
    "RelatedTransactionId": 2110000000002089500,
    "ClientUniqueId": "463453778",
    "TransactionAmount": 100.2,
    "TransactionCurrency": "eur",
    "AcquirerName": "Nuvei",
    "PaymentMethod": "MasterCard",
    "TransactionType": "Credit",
    "TransactionResult": "Approved",
    "Email": "[email protected]",
    "UserTokenId": "21312D"
  }
}

Description of Manually Inserted Parameters

Parameter	Description	Type	Example
ClientId	An ID assigned to your account by Nuvei.	Number	"1091"
EventDateUTC	Notification date and time in UTC.	String	"2020-12-28T17:32:00.727"
EventCorrelationId	Notification unique ID.	String	"b217ea66-f592-47dc-a290-75af39243107"
ClientName	The merchant account name.	String	"Daniel Test"
TransactionDetails.TransactionId	The Nuvei unique Transaction ID.	Number	"2110000000002080000"
TransactionDetails.TransactionDate	Date of the transaction.	String	"2020-07-14 17:19:34.970"
TransactionDetails.RelatedTransactionId	The Nuvei original transaction ID to which the manual transaction is related.	Number	"2110000000002089488"
TransactionDetails.ClientUniqueId	Displays the merchant's unique reference sent for the original processed transaction.	String	"463453778"
TransactionDetails.TransactionAmount	The inserted transaction amount.	Number	"100.20"
TransactionDetails.TransactionCurrency	The inserted transaction currency.	String	"eur"
TransactionDetails.AcquirerName	The acquirer bank name that processed the transaction.	String	"Nuvei"
TransactionDetails.PaymentMethod	Payment method type used for the transaction.	String	"Mastercard"
TransactionDetails.TransactionType	The inserted transaction's type.	String	"Credit"
TransactionDetails.TransactionResult	The inserted transaction's result.	String	"Approved"
TransactionDetails.Email	The customer's email address (consumer who initiated the transaction).	String	"[email protected]"
TransactionDetails.UserTokenId	Displays the merchant's unique identifier of the client.	String	"21312D"

Fraud Reported Transaction

Example Fraud Reported Transaction Parameters

{
"ClientId": 1091,
"ClientName": "Test Client",
"EventType": "Fraud reported Transaction",
"EventDateUTC": "2020-12-28T17:32:00.727",
"EventCorrelationId": "b217ea66-f592-47dc-a290-75af39243107",
"Report": {
"ReportDate": "2018-09-04 10:37:17.547",
"UpdateDate": "2018-09-04 10:37:17.547",
"FraudAmount": 100.00,
"FraudCurrency": "eur",
"FraudType": "Stolen Fraud",
"FraudSubType": "Unknown",
"IsCredited": 0,
"IsChargeback": 0,
"Is3D": 0,
"IsLiabilityShift": 0,
},
"TransactionDetails": {
"TransactionId": 2110000000004114847,
"TransactionDate": "2021-07-09 21:18:45.607",
"TransactionAmount": 100.00,
"TransactionCurrency": "eur",
"AcquirerName": "Nuvei Acquirer - Visa",
"ClearingDate": "2021-07-10 21:20:09.243",
"Arn": "64738272371643523456435",
"ExternalTokenProvider": "",
"ClientUniqueId": "6876868",
"MaskedCardNumber": "4***********5354",
"CardBrand": "Visa",
"Bin": 434556,
"IssuingCountry": "united states",
"Issuer": "BANCO SANTANDER TOTTA S.A.",
"Email": "[email protected]",
"UserId": "",
"BillingState": ""
}
}

Description of Fraud Reported Transaction Parameters

Parameter	Description	Type
ClientId	An ID assigned to your account by Nuvei.	Number
ClientName	The merchant account name.	String
EventType	Fraud reported Transaction	String
EventDateUTC	Notification date and time in UTC.	String
EventCorrelationId	Notification unique ID.	String
Report.ReportDate	The date that the fraud was reported.	String
Report.UpdateDate	The date that the fraud was updated.	String
Report.FraudAmount	Amount of the fraud.	Number
Report.FraudCurrency	Currency of the fraud.	String
Report.FraudType	Indicates the specific types of fraud to be used as a search parameter.	String
Report.FraudSubType	Indicates the specific sub-types of fraud to be used as a search parameter.	String
Report.IsCredited	Indicates whether or not the query should include credit transactions. Possible Values: Y/N	String
Report.IsChargeback	Indicates whether or not the query should include chargeback transactions. Possible Values: Y/N	String
Report.Is3D	Indicates whether or not the query should include transactions that are 3D-Secure. Possible Values: Y/N	String
Report.IsLiabilityShift	Indicates whether or not the query should include transactions with a liability shift. Possible Values: Y/N	String
TransactionDetails.TransactionId	Nuvei Transaction ID.	Number
TransactionDetails.TransactionDate	Date and time of the original transaction processing.	String
TransactionDetails.TransactionAmount	The original amount of the transaction.	Number
TransactionDetails.TransactionCurrency	The original currency of the transaction.	String
TransactionDetails.AcquirerName	The acquiring bank used involved in the transaction.	String
TransactionDetails.ClearingDate	The clearing date of the transaction.	String
TransactionDetails.Arn	The Acquirer Reference Number associated with the transaction.	Number
TransactionDetails.ExternalTokenProvider	The external provider that provides the token for a credit card transaction.	String
TransactionDetails.ClientUniqueId	The ID of the transaction in the merchant’s system.	Number
TransactionDetails.MaskedCardNumber	The masked debit or credit card number.	String
TransactionDetails.CardBrand	Indicates the card scheme sub-brand.	String
TransactionDetails.Bin	Displays the first six digits of the credit/debit card, which identify the issuing institute.	Number
TransactionDetails.IssuingCountry	The location of the credit or debit card provider.	String
TransactionDetails.Issuer	The name of the issuer bank for credit card transactions.	String
TransactionDetails.Email	The customer's email address (consumer who initiated the transaction).	String
TransactionDetails.UserId	The customer's ID that you assigned to the customer.	String
TransactionDetails.BillingState	The customer's billing state (Relevant for the US, Canada, and the UK.)	String

External Pre-chargeback Alert

Example External Pre-chargeback Alert Parameters

{
  "ClientId":1091,
  "ClientName": "Test Client",
  "EventDateUTC":"2020-12-28T17:32:00.727+02:00",
  "EventCorrelationId":"b217ea66-f592-47dc-a290-75af39243107",
  "Alert":{
    "AlertReceivedDate":"2018-02-27T04:33:04.000Z",
    "EthocaId":"kEYWGEwlBpWqfthbLEbKIXYTC",
    "EthocaMemberID":585,
    "EthocaMemberName":"Ethoca Member",
    "AlertType":"issuer_alert",
    "AlertTimestamp":"2018-02-27T04:33:04.000Z",
    "AlertAge": 15,
    "Issuer":"Bank of ABC",
    "MaskedCreditCard":"1***********2453",
    "Arn":"64738272371643523456435",
    "ChargebackAmount":10.25,
    "ChargebackCurrency":"USD",
    "MerchantDescriptor":"Descriptor123"
  },
  "TransactionDetails":{
    "TransactionId":"abcd1234567890",
    "CreditCardBin":"111122",
    "AuthTransactionDate":"2020-07-14 17:19:34.970",
    "AuthCode": "DSC871",
    "ChargebackReasonCode":"A890",
    "TransactionAmount":340.6,
    "TransactionCurrency":"USD"
  }
}

Description of External Pre-chargeback Alert Parameters

Parameter	Description	Type
ClientId	An ID assigned to your account by Nuvei.	Number
ClientName	Client name as it appears in the Control Panel.	String
EventDateUTC	Notification date and time in UTC. Example: 2018-02-27T04:33:04.000Z	String
EventCorrelationId	Notification unique ID. Example: b217ea66-f592-47dc-a290-75af39243107	String
Alert.alertReceivedDate	Alert creation date in Ethoca.	String
Alert.ethocaId	Unique ID assigned to the alert by Ethoca.	String
Alert.ethocaMemberID	Unique ID assigned to your client account with Ethoca	String
Alert.EthocaMemberName	Your client account name with Ethoca	String
Alert.AlertType	Represents the type of alert – Consumer or Issuer generated. Example: issuer_alert, customerdispute_alert	String
Alert.AlertTimestamp	Notification date and time.	String
Alert.AlertAge	Number of days between transaction date and alert date.	Number
Alert.Issuer	Card issuer name.	String
Alert.MaskedCreditCard	The masked 16-character debit or credit card Number, which shows the first digit and last four digits of the card. Example: 1***********2453	Number
Alert.Arn	The Acquirer Reference Number associated with the original transaction.	Number
Alert.ChargebackAmount	The chargeback amount stated in the Ethoca alert.	Number
Alert.ChargebackCurrency	The chargeback currency stated in the Ethoca alert. Example: USD	String
Alert.MerchantDescriptor	The merchant descriptor stated in the Ethoca alert.	String
TransactionDetails.TransactionId	Card scheme transaction ID	String
TransactionDetails.CreditCardBin	Card bin as received from Ethoca	String
TransactionDetails.AuthTransactionDate	Transaction authorization date as received from Ethoca	String
TransactionDetails.AuthCode	Authorization code for the transaction.	String
TransactionDetails.ChargebackReasonCode	The chargeback reason code	String
TransactionDetails.TransactionAmount	The amount in the original transaction as received from Ethoca	Number
TransactionDetails.TransactionCurrency	The currency in the original transaction as received from Ethoca	String

External RDR Case

Example External RDR Case Parameters

{
  "ClientId": 12125,
  "ClientName": "Test client",
  "EventType": "RDR External Alert",
  "EventDateUTC": "2024-05-12T03:58:33.3912547Z",
  "EventCorrelationId": "dc6e4d32-d48e-4ab5-a5c0-87c3d3a463a2",
  "RDREvent": {
    "ReportedAmount": 48.86,
    "ReportedCurrency": "USD",
    "Date": "2024-05-12T00:00:00",
    "ChargebackReasonCode": "10.4",
    "Status": "Accepted"
  },
  "TransactionDetails": {
    "TransactionDate": "2023-03-09T00:00:00",
    "TransactionAmount": 48.86,
    "TransactionCurrency": "USD",
    "ProcessorName": "123",
    "MaskedCardNumber": "5***********1919",
    "CreditCardBin": "554506",
    "ARN": "74424653068213152629736",
    "AuthCode": "25478"
  }
}

Description of External RDR Case Parameters

Field	Description	Type
ClientId	The ID assigned to your account by Nuvei.	Number
ClientName	Client name as it appears in the Control Panel.	String
EventType	The RDR external alert.	String
EventDateUTC	The event in UTC.	String
EventCorrelationId	The event ID.	Number
ReportedAmount	The chargeback amount as reported in the RDR case.	String
ReportedCurrency	The chargeback currency as reported in the RDR case.	String
Date	The event date.	String
ChargebackReasonCode	The chargeback reason code as reported in the RDR case.	String
Status	The result of the case: “Accepted” or “Declined”.	String
TransactionDate	Date and time of the original transaction as reported in the RDR case.	String
TransactionAmount	Amount of the original transaction as reported in the RDR case.	String
TransactionCurrency	Currency of the original transaction as reported in the RDR case.	String
ProcessorName	Merchant CAID as provided in the RDR case.	String
MaskedCardNumber	The masked 16-character debit or credit card Number, which shows the first digit and last four digits of the card.	String
MaskedCardNumber	Example: 1***********2453	String
CreditCardBin	The first six digits of the card.	String
ARN	The Acquirer Reference Number associated with the original transaction.	String
TransactionDetails.AuthCode	Authorization code for the transaction.	String

Control Panel Event DMNs