Datapoints
The Fraugster API accepts a payment transaction as a JSON object where each key/value pair represents a datapoint. A datapoint carries specific information about the transaction itself and the customer. The Fraugster Engine receives your datapoints and enriches every transaction with additional ones. As a result, each transaction gets a score that contributes to the approval process.
Datapoint types
Each datapoint has a name and a specific data type. Data type mismatches result
in a server response with the code 400
(bad request).
We support the following basic data types, as well as composite ones derived from one or more basic types.
Basic data types
Type | Description | Examples |
---|---|---|
string | A sequence of characters representing textual data. | "2662 Main Street" “3456" |
float | A numeric value with floating decimal points. | 23.15 |
timestamp | An RFC3339-encoded UTC timestamp. The timezone accepts either the character "Z" to indicate UTC or a time offset in the format "+02:00" or "-07:30". |
|
date | The date part of an RFC3339 -encoded UTC timestamp. The timezone accepts either the character "Z" to indicate UTC or a time offset in the format "+02:00" or "-07:30". |
|
integer | A whole number without a fractional component. Can be positive, negative, or zero. | 42 |
enum | A set of values of the same data type. | ["EU", "DE", "IT"] |
boolean | A logical data type with values true or false . | false |
Composite data types
Type | Description | Examples |
---|---|---|
shopping_cart_item | A collection of datapoints representing an item in the shopping cart of the customer. | { "item_id": "DF42", "item_desc": "Belt"} |
custom | A collection of custom datapoints. It can contain any information about a product, customer, or business model that is not collected by Fraugster datapoints. Can be sent with each transaction and used for rule creation by Fraud Management SaaS users. | { “test”: true, “n”: 42 } |
Required datapoints
The Fraugster API currently supports around 170 datapoints. The number of datapoints you submit in the API request depends on your needs, available data, and the Fraugster product you use. The more data the Fraugster Engine receives, the more accurate the scoring outcome is going to be.
That said, the datapoints mentioned below are required. If you don't include all
of them in your request, the server responds with the status code 400
(bad request).
Datapoint | Type | Description | Example |
---|---|---|---|
trans_id | string | Your primary unique reference for the transaction. | "43d72xfdil915889fu" |
trans_ts | timestamp | The transaction timestamp as reported by the client. | "2006-01-02T15:04:05Z" |
trans_amt | float | The transaction amount in the original currency. | 23.15 |
trans_currency | string | ISO-3 currency code in which trans_amt is given. | "EUR" |
seller_id | string | The ID of the merchant. | "ABG826" |