Skip to main content
Version: 1.0

Merchant Evaluations


Endpoint Overview

Our Merchant Evaluations endpoint collects the outcomes of your investigations of merchants. These merchant evaluations are very important for the Merchant Fraud and AML product as they are used as labels and feedback mechanism to train and update our Machine Learning models.

Merchant evaluations are only applicable under the following circumstances:

  • you are using the Merchant Fraud product and/or the AML product
  • you have a risk team that evaluates merchant accounts

The merchant evaluations can be sent either individually or in batch.

Request Parameters

Request parameters in JSON format

"merchant": "eec1d18f-a714-491d-9721-4600ba7c44c3",
"evaluation": "fraudster",
"timestamp": 1646063615,
"comment": "Money launderer."

Request parameters: Field Reference Table

FieldData TypePayment Fraud (Issuer)Payment Fraud (Acquirer / Processor)Merchant Fraud / AMLDescription
The UTC time at which the transaction was made. When sending events in realtime, this will usually be 'now'. Only Unix Timestamps are accepted.
The name or identifier of the merchant. This field uniquely identifies the merchant, and should not be confused with the MID. Any name or unique identifier is accepted.
Outcome of the latest evaluation of the merchant. Valid values are:
- fraudster
- suspicious
- legitimate
The comment field is a free-form text field that can be used to provide additional information about merchant evaluations. This is information that is not yet covered by the categories that are defined as values for the evaluation field. So after having done an investigation on merchants, analysts often provide comments on why the merchant was closed down (or not). Example values are "suspected money launderer, large number of transactions from High Risk countries", or "blocked due to large number of refunds".

Response Parameters

200 OK Response
"created": 2,
"deleted": 0,
"errors": 2,
"ignored": 5,
"received": 0,
"updated": 0
Status CodeStatus MessageDescriptionSchema
200OKStandard response for successful HTTP requests.200 OK - Post-auth response
4xx, 500, 501, 502, 503, 504errorVarious error messages for unsuccessful HTTP requests.Problem response

Code samples

curl -X POST \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H 'Content-Type: application/json' \
--data-raw '{"data":[{"merchant":"eec1d18f-a714-491d-9721-4600ba7c44c3","evaluation":"suspicious","timestamp":1646063615,"comment":"No Action - False Alarm"}]}'