FraudLabs Pro PHP SDK to screen the order transaction for payment fraud.
Switch branches/tags
Clone or download
Latest commit 63322d1 Jul 6, 2018

README.md

FraudLabs Pro PHP SDK

This PHP 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 PHP 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 API key to function. You may subscribe a free API key at https://www.fraudlabspro.com

Usage Example

Validate Order

Object Properties

Property Name Property Type Description
ip string IP address of online transaction. It supports both IPv4 and IPv6 address format.
billing->firstName string User's first name.
billing->lastName string User's last name.
billing->username string User's username.
billing->password string User's password.
billing->email string User's email address.
billing->phone string User's phone number.
billing->address string Street address of billing address.
billing->city string City of billing address.
billing->state string 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->postcode string Postal or ZIP code of billing address.
billing->country string 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.
order->orderId string Merchant identifier to uniquely identify a transaction. It supports maximum of 15 characters user order id input.
order->note string Merchant description of an order transaction. It supports maximum of 200 characters.
order->amount float Amount of the transaction.
order->quantity integer Total quantity of the transaction.
order->currency string 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->department string Merchant identifier to uniquely identify a product or service department.
order->paymentMethod string Payment mode of transaction. Please see references section.
card->number string Billing credit card number or BIN number.
card->avs string The single character AVS result returned by the credit card processor. Please refer to AVS & CVV2 Response Codes for details.
card->cvv string The single character CVV2 result returned by the credit card processor. Please refer to AVS & CVV2 Response Codes for details.
shipping->address string Street address of shipping address.
shipping->city string City of shipping address.
shipping->state string 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->postcode string Postal or ZIP code of shipping address.
shipping->country string 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.
<?php
require_once 'lib/FraudLabsPro.php';

// Configures FraudLabs Pro API key
FraudLabsPro\Configuration::apiKey('YOUR_API_KEY');

// Order details
$orderDetails = [
	// IP parameter is optional, this library can detects IP address automatically
	'ip'		=> '146.112.62.105',

	'order'		=> [
		'orderId'		=> '67398',
		'note'			=> 'Online shop',
		'currency'		=> 'USD',
		'amount'		=> '79.89',
		'quantity'		=> 1,
		
		// Please refer reference section for full list of payment methods
		'paymentMethod'	=> FraudLabsPro\Order::CREDIT_CARD,
	],

	'card'		=> [
		'number'	=> '4556553172971283',
	],

	'billing'	=> [
		'firstName'	=> 'Hector',
		'lastName'	=> 'Henderson',
		'email'		=> 'hh5566@gmail.com',
		'phone'		=> '561-628-8674',

		'address'	=> '1766 Powder House Road',
		'city'		=> 'West Palm Beach',
		'state'		=> 'FL',
		'postcode'	=> '33401',
		'country'	=> 'US',
	],

	'shipping'	=> [
		'address'	=> '4469 Chestnut Street',
		'city'		=> 'Tampa',
		'state'		=> 'FL',
		'postcode'	=> '33602',
		'country'	=> 'US',
	],
];

// Sends the order details to FraudLabs Pro
$result = FraudLabsPro\Order::validate($orderDetails);

Get Transaction

Parameter Properties

Parameter Name Parameter Type Description
$id string FraudLabs Pro transaction ID or Order ID.
$type string ID type. Either: FraudLabsPrp::FLP_ID or FraudLabsPro::ORDER_ID
<?php
require_once 'lib/FraudLabsPro.php';

// Configures FraudLabs Pro API key
FraudLabsPro\Configuration::apiKey('YOUR_API_KEY');

$result = FraudLabsPro\Order::getTransaction('20170906MXFHSTRF', FraudLabsPro::FLP_ID);

Feedback

Object Properties

Property Name Property Type Description
id string Unique transaction ID generated from Validate function.
status string Perform APPROVE, REJECT, or REJECT_BLACKLIST action to transaction. Refer to reference section for status code.
note string Notes for the feedback request.
<?php
require_once 'lib/FraudLabsPro.php';

// Configures FraudLabs Pro API key
FraudLabsPro\Configuration::apiKey('YOUR_API_KEY');

FraudLabsPro\Order::feedback([
	'id'		=> '20170906MXFHSTRF',
	// Please refer to reference section for full list of feedback statuses
	'status'	=> FraudLabsPro\Order::APPROVE,
	'note'		=> 'This customer made a valid purchase before.',
]);

SMS Verification

Send SMS Verification

Object Properties

Property Name Property Type Description
tel string The recipient mobile phone number in E164 format which is a plus followed by just numbers with no spaces or parentheses.
mesg string The message template for the SMS. Add as placeholder for the actual OTP to be generated. Max length is 140 characters.
country_code string ISO 3166 country code for the recipient mobile phone number. If parameter is supplied, then some basic telephone number validation is done.
require_once 'lib/FraudLabsPro.php';

// Configures FraudLabs Pro API key
FraudLabsPro\Configuration::apiKey('YOUR_API_KEY');

// Send SMS Verification
FraudLabsPro\SMSVerification::sendsms([
	'tel'			=> '+15616288674',
	'mesg'			=> 'Hi, your OTP is <otp>.',
	'country_code'		=> 'US',
]);

Get SMS Verification Result

Object Properties

Property Name Property Type Description
tran_id string The unique ID that was returned by the Send SMS Verification that triggered the OTP sms.
otp string The OTP that was sent to the recipient’s phone.
require_once 'lib/FraudLabsPro.php';

// Configures FraudLabs Pro API key
FraudLabsPro\Configuration::apiKey('YOUR_API_KEY');

// Get SMS Verification result
FraudLabsPro\SMSVerification::verifysms([
	'tran_id'		=> 'UNIQUE_TRANS_ID',
	'otp'			=> 'OTP_RECEIVED',
]);

Reference

Payment Method

Payment Method
FraudLabsPro\Order::CREDIT_CARD
FraudLabsPro\Order::PAYPAL
FraudLabsPro\Order::GOOGLE_CHECKOUT
FraudLabsPro\Order::CASH_ON_DELIVERY
FraudLabsPro\Order::MONEY_ORDER
FraudLabsPro\Order::WIRE_TRANSFER
FraudLabsPro\Order::BANK_DEPOSIT
FraudLabsPro\Order::BITCOIN
FraudLabsPro\Order::OTHERS

Feedback Status

Feedback Status Description
FraudLabsPro\Order::APPROVE Approves an order that under review status.
FraudLabsPro\Order::REJECT Rejects an order than under review status.
FraudLabsPro\Order::REJECT_BLACKLIST Rejects and blacklists an order.

LICENCE

See the LICENSE file.