This package provides an API for the MaxMind minFraud Score, Insights, and Factors web services.
MaxMind has tested this API with Node.js versions 8 and 10. We aim to support active LTS versions of Node.js, as well as the latest stable release.
yarn add @maxmind/minfraud-api-node
If you are not able to use yarn
, you may also use npm
:
npm install @maxmind/minfraud-api-node
Documentation for this API can be found here
To use this API, first create a new Client
object. The constructor
takes your MaxMind account ID and license key. For example:
const client = new minFraud.Client("1234", "LICENSEKEY");
Then create a new Transaction
object. This represents the transaction that
you are sending to minFraud. Each transaction property is instantiated by creating
a new instance of each property's class. For example:
const transaction = new minFraud.Transaction({
device: new minFraud.Device({
ipAddress: '8.8.8.8',
}),
email: new minFraud.Email({
address: 'foo@bar.com',
domain: 'bar.com',
}),
})
If Transaction instantiation fails, an ArgumentError
is thrown. This is usually
due to invalid property values, a missing Device object, or a Device object
with either an invalid or missing IP Address.
After creating the Transaction object, you can send a Score, Insights, or Factors request, which returns a Promise that contains the corresponding model:
// minFraud Score
client.score(transaction).then(scoreResponse => ...);
// minFraud Insights
client.insights(transaction).then(insightsResponse => ...);
// minFraud Factors
client.factors(transaction).then(factorsResponse => ...);
If the request fails, an error object will be returned in the catch in the form of:
{
code: string
error: string
}
Thrown by the request and transaction models:
ArgumentError
- Thrown when invalid data is passed to the Transaction and Transaction property constructors.
In addition to the response errors returned by the web API, we also return:
{
code: 'SERVER_ERROR',
error: <string>
}
{
code: 'HTTP_STATUS_CODE_ERROR',
error: <string>
}
{
code: 'INVALID_RESPONSE_BODY',
error: <string>
}
import { URL } from 'url'; // Used for `order.referrerUri
import * as minFraud from '@maxmind/minfraud-api-node';
// const minFraud = require('@maxmind/minfraud-api-node');
// client is reusable
const client = new minFraud.Client("1234", "LICENSEKEY");
let transaction;
try {
transaction = new minFraud.Transaction({
// device is required
device: new minFraud.Device({
ipAddress: "8.8.8.8",
}),
event: new minFraud.Event({
shopId: 'shop',
time: new Date(Date.now()),
transactionId: 'txn1234',
type: minFraud.Constants.EventType.PayoutChange,
}),
account: new minFraud.Account({
userId: 'user123',
username: 'userperson',
}),
email: new minFraud.Email({
address: 'foo@bar.com',
domain: 'bar.com',
}),
billing: new minFraud.Billing({
address: '123 Robot Ave.',
address2: 'Suite 10011',
city: 'Waltham',
company: 'Robots Inc.',
country: 'US',
firstName: 'Robot',
lastName: 'Bar',
phoneCountryCode: '1',
phoneNumber: '321-321-3211',
postal: '12345',
region: 'MA',
}),
shipping: new minFraud.Shipping({
address: '123 Robot Ave.',
address2: 'Suite 10011',
city: 'Waltham',
company: 'Robots Inc.',
country: 'US',
deliverySpeed: minFraud.Constants.DeliverySpeed.Expedited,
firstName: 'Robot',
lastName: 'Bar',
phoneCountryCode: '1',
phoneNumber: '321-321-3211',
postal: '12345',
region: 'MA',
}),
payment: new minFraud.Payment({
declineCode: 'A',
processor: minFraud.Constants.Processor.ConceptPayments,
wasAuthorized: true,
}),
creditCard: new minFraud.CreditCard({
avsResult: 'A',
bankName: 'Foo Bank',
bankPhoneCountryCode: '1',
bankPhoneNumber: '123-123-1234',
cvvResult: 'B',
issuerIdNumber: '123456',
last4digits: '1234',
token: 'a_token',
}),
order: new minFraud.Order({
affiliateId: 'robotnet',
amount: 22.99,
currency: 'USD',
discountCode: 'COUPONS',
hasGiftMessage: true,
isGift: true,
referrerUri: new URL('https://robots.com/swarms'),
subaffiliateId: 'swarm',
}),
shoppingCart: [
new minFraud.ShoppingCartItem({
category: 'screws',
itemId: 'sc123',
price: 9.99,
quantity: 100,
}),
new minFraud.ShoppingCartItem({
category: 'screws',
itemId: 'sc123',
price: 9.99,
quantity: 100,
}),
],
customInputs: [
new minFraud.CustomInput('key', 'value'),
new minFraud.CustomInput('key_2', true),
new minFraud.CustomInput('key_3', 100),
]
})
} catch(error) {
// handle the error
}
client.score(transaction as minFraud.Transaction).then(response => {
console.log(response.riskScore) // 50
console.log(response.ipAddress.risk) // 50
});
Please report all issues with this code using the GitHub issue tracker.
If you are having an issue with the minFraud service that is not specific to the client API, please see our support page.
Patches and pull requests are encouraged. Please include unit tests whenever possible.
This API uses Semantic Versioning.
This software is Copyright (c) 2019 by MaxMind, Inc.
This is free software, licensed under the Apache License, Version 2.0.