3.0.0 • Published 4 months ago

fraudlabspro-nodejs v3.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
4 months ago

npm npm

FraudLabs Pro Node.js SDK

This Node.js module enables user to easily implement fraud detection feature into their solution using the API from https://www.fraudlabspro.com.

Below are the features of this Node.js module:

  • Fraud analysis and scoring
  • IP address geolocation & proxy validation
  • Email address validation
  • Credit card issuing bank validation
  • Transaction velocity validation
  • Device transaction validation
  • Blacklist validation
  • Custom rules trigger
  • Email notification of fraud orders
  • Mobile app notification of fraud orders

This module requires an API key to function. You may subscribe for a free API key at https://www.fraudlabspro.com

Installation

To install this module type the following:

   npm install fraudlabspro-nodejs

Usage Example

Validate Order

Object Properties

Property NameProperty TypeDescription
ipstring(required) IP address of online transaction. It supports both IPv4 and IPv6 address format.
billing->first_namestring(optional) User's first name.
billing->last_namestring(optional) User's last name.
billing->addressstring(optional) Street address of billing address.
billing->citystring(optional) City of billing address.
billing->statestring(optional) State of billing address. It supports state codes, e.g. NY (New York), for state or province of United States or Canada. Please refer to State & Province Codes for complete list.
billing->zip_codestring(optional) Postal or ZIP code of billing address.
billing->countrystring(optional) Country of billing address. It requires the input of ISO-3166 alpha-2 country code, e.g. US for United States. Please refer to Country Codes for complete list.
billing->phonestring(optional) User's phone number.
billing->emailstring(optional) User's email address.
shipping->first_namestring(optional) Shipping user's first name.
shipping->last_namestring(optional) Shipping user's last name.
shipping->addressstring(optional) Street address of shipping address.
shipping->citystring(optional) City of shipping address.
shipping->statestring(optional) State of shipping address. It supports state codes, e.g. NY - New York, for state or province of United States or Canada. Please refer to State & Province Codes for complete list.
shipping->zip_codestring(optional) Postal or ZIP code of shipping address.
shipping->countrystring(optional) Country of shipping address. It requires the input of ISO-3166 alpha-2 country code, e.g. US for United States. Please refer to Country Codes for complete list.
order->order_idstring(optiopnal) Merchant identifier to uniquely identify a transaction. It supports maximum of 15 characters user order id input.
order->currencystring(optional) Currency code used in the transaction. It requires the input of ISO-4217 (3 characters) currency code, e.g. USD for US Dollar. Please refer to Currency Codes for complete list.
order->amountfloat(optional) Amount of the transaction.
order->quantityinteger(optional) Total quantity of the transaction.
order->order_memostring(optional) Merchant description of an order transaction. It supports maximum of 200 characters.
order->departmentstring(optional) Merchant identifier to uniquely identify a product or service department.
order->payment_gatewaystring(optional) The name of payment gateway used to capture the payment.
order->payment_modestring(optional) Payment mode of transaction. Valid values: creditcard, affirm, paypal, googlecheckout, bitcoin, cod, moneyorder, wired, bankdeposit, elviauthorized, paymitco, cybersource, sezzle, viabill, amazonpay, pmnts_gateway, giftcard, others.
order->bin_nostring(optional) First 6-9 digits of credit card number to identify issuing bank.
order->avs_resultstring(optional) The single character AVS result returned by the credit card processor. Please refer to AVS & CVV2 Response Codes for details.
order->cvv_resultstring(optional) The single character CVV2 result returned by the credit card processor. Please refer to AVS & CVV2 Response Codes for details.
items[]->skustring(optional) Product SKU of the transaction.
items[]->quantityinteger(optional) Product quantity of the transaction.
items[]->typestring(optional) Product type of the transaction.
usernamestring(optional) User's username.
flp_checksumstring(optional) Checksum for the device validation. Please visit Agent Javascript to learn about the use of this parameter.
const {FraudValidation} = require("fraudlabspro-nodejs");

var flp = new FraudValidation('YOUR API KEY');

params = {
	ip: '146.112.62.105',
	billing: {
            last_name: 'Henderson',
            first_name: 'Hector',
            address: '1766 Powder House Road',
            city: 'West Palm Beach',
            state: 'FL',
            zip_code: '33401',
            country: 'US',
            phone: '561-628-8674',
            email: 'hh5566@gmail.com',
        },
        shipping: {
            last_name: 'John',
            first_name: 'Doe',
            address: '4469 Chestnut Street',
            city: 'Tampa',
            state: 'FL',
            zip_code: '33602',
            country: 'US',
        },
        order: {
            order_id: '67398',
            currency: 'USD',
            amount: '79.89',
            quantity: 1,
            order_memo: 'Online shop',
            department: 'Online Store',
            payment_gateway: 'stripe',
            payment_mode: 'creditcard',
            bin_no: '455655',
            avs_result: 'Y',
            cvv_result: 'M',
        },
        items: [{
            sku: '10001',
            quantity: 1,
            type: 'physical'
	}],
        username: 'hh5566',
        flp_checksum: ''
};
flp.validate(params, (err, data) => {
	if (!err) {
		console.log(data);
	}
});

Get Transaction

Parameter Properties

Parameter NameParameter TypeDescription
idstring(required) FraudLabs Pro transaction ID or Order ID.
id_typestring(optional) ID type. Valid values: fraudlabspro_id, user_order_id
const {FraudValidation} = require("fraudlabspro-nodejs");

var flp = new FraudValidation('YOUR API KEY');

params = {
	id: '20170906MXFHSTRF',
	id_type: 'fraudlabspro_id',
};
flp.getTransaction(params, (err, data) => {
	if (!err) {
		console.log(data);
	}
});

Feedback

Object Properties

Property NameProperty TypeDescription
idstring(required) Unique transaction ID generated from Validate function.
actionstring(required) Perform APPROVE, REJECT, or REJECT_BLACKLIST action to transaction.
notestring(optional) Notes for the feedback request.
const {FraudValidation} = require("fraudlabspro-nodejs");

var flp = new FraudValidation('YOUR API KEY');

params = {
	id: '20170906MXFHSTRF',
	action: 'APPROVE',
	note: 'This customer made a valid purchase before.',
};
flp.feedback(params, (err, data) => {
	if (!err) {
		console.log(data);
	}
});

SMS Verification

Send SMS Verification

Object Properties

Property NameProperty TypeDescription
telstring(required) The recipient mobile phone number in E164 format which is a plus followed by just numbers with no spaces or parentheses.
mesgstring(required) The message template for the SMS. Add as placeholder for the actual OTP to be generated. Max length is 140 characters.
otp_timeoutinteger(optional) Timeout feature for OTP value in seconds. Default is 3600 seconds(1 hour). Max timeout is 86400 seconds(24 hours).
country_codestring(optional) ISO 3166 country code for the recipient mobile phone number. If parameter is supplied, then some basic telephone number validation is done.
const {SMSVerification} = require("fraudlabspro-nodejs");

var sms = new SMSVerification('YOUR API KEY');

params = {
	tel: '+123456789',
	mesg: 'Hi, your OTP is <otp>.',
	otp_timeout: 3600,
	country_code: 'US',
};
sms.sendSMS(params, (err, data) => {
	if (!err) {
		console.log(data);
	}
});

Get SMS Verification Result

Object Properties

Property NameProperty TypeDescription
tran_idstring(required) The unique ID that was returned by the Send SMS Verification that triggered the OTP sms.
otpstring(required) The OTP that was sent to the recipient’s phone.
const {SMSVerification} = require("fraudlabspro-nodejs");

var sms = new SMSVerification('YOUR API KEY');

params = {
	tran_id: 'UNIQUE_TRANS_ID',
	otp: 'OTP_RECEIVED',
};
sms.verifyOTP(params, (err, data) => {
	if (!err) {
		console.log(data);
	}
});