README

Omnifraud ·

An easy to use, consistent fraud prevention library for PHP 7.1+. Inspired by Omnipay.

Omnifraud is an ecommerce fraud prevention library for PHP. The project aims to provide a clear and consistent API for interacting with different fraud prevention, risk assessment, and liability shifting services.

Motivation
Installation
Basic Example
Fraud Services / Drivers
- The Null Driver
Usage

Motivation

There are a lot of risk assessment services out there and, although some details differ, the flow is almost always the same.

Generate a random session ID
Insert JavaScript tracking code into front end with aforementioned session ID
On checkout, send a request to risk assessment service with session ID and order information

We created Omnifraud to satiate our own needs. The benefits of using the Omnifraud library are:

Learn one interface, use throughout projects with different providers.
Clean separation. Easily swap providers without touching a single line of checkout code.
Documentation in popular risk assessment services isn't always clear. Put in your API key and go.

Installation

Usually all you'll need to do is install the service you need. For example:

composer require omnifraud/signifyd

Each package already requires omnifraud/common, so you don't need to require it.

To install ALL supported services:

composer require omnifraud/omnifraud

Basic Example

<?php

use Omnifraud\Omnifraud;

/** @var \Omnifraud\Contracts\ServiceInterface $fraudService */
$fraudService = Omnifraud::create('Signifyd', [
    'api_key' => 'XXX',
]);

// Build request, with data from the current sale
$request = new Omnifraud\Request\Request();

$request->getPurchase()->setId('1');
$request->getPurchase()->setTotal(25100);
$request->getPurchase()->setCurrencyCode('CAD');

$request->getAccount()->setEmail('jane@example.com');
//...

// Send the request to the service
$response = $fraudService->validateRequest($request);

// Does it need to be updated later?
if ($response->isPending()) {
    // Queue for later update
    $this->queueFraudUpdate($response->getRequestUid());
}

if ($response->isGuaranteed()) {
    // The order is guaranteed by our fraud service
    // ...
}

if ($response->getScore() < 10.0) {
    // That's a pretty bad score. Let's bail!
    // ...
}

Note: See MakesTestRequest@makeTestRequest() for a full example of a request. Services may differ in which fields are optional and which are required, but every service can handle a completely full request.

Fraud Services / Drivers

All drivers implement ServiceInterface.

The following services are officially supported right now:

Service	Composer Package	Alias	Maintainer
Kount	omnifraud/kount	Kount	LXRandCo
Signifyd	omnifraud/signifyd	Signifyd	LXRandCo
Null	omnifraud/common	Null	LXRandCo

Note: Interested in contributing your own implementation? We'd love to include it! Add it to the above list and send a PR.

The `Null` Driver

The Null driver does nothing. What else were you expecting?

Usage

The lifecycle of the fraud request looks like this:

User visits www.example.com
User is assigned a random session ID or reuses existing session ID (via local storage, cookies, etc.)
User attempts checkout with payment
Both failed and successful payments are reported to fraud service
Once checkout succeeds, a score is given to the fraud request (either synchronously or asynchronously) and is saved alongside the order

In order of implementation, this translates into:

Instantiation of a driver
Front-end JavaScript implementation
Creation of a fraud "request"
On checkout, recording order, session, account, and payment info in the request
Storing the response and fraud score in the database, or queuing for later retrieval if asynchronous

The Session ID

It's entirely up to you to generate a session ID and re-use the same one throughout the aforementioned fraud request lifecycle. Most services have no opinion on what it looks like, but to be safe accross most vendors you should ensure it:

is alphanumeric
is of reasonable length (more than 255 might be overkill)
has some uniqueness properties (tip: don't do things like crc32(time()))
does not change between page loads
is shared between client/server

Once you have your random session ID, toss it into a cookie and use it for both the front-end tracker and the back-end fraud requests.

Instantiation

Instantiation of a driver is incredibly straightforward.

You can create them yourself, passing all configs necessary as the first and only constructor argument.

<?php

use Omnifraud\Kount\KountService;

/** @var \Omnifraud\Contracts\ServiceInterface $fraudService */
$fraudService = new KountService([
    'apiKey' => 'XXX',
    'merchantId' => '123456',
]);

Or, use the static create() method offered by Omnifraud\Omnifraud. The first parameter is the alias of the driver (detailed in the table above), and the second is the same configuration array you would normally supply.

<?php

use Omnifraud\Omnifraud;

/** @var \Omnifraud\Contracts\ServiceInterface $fraudService */
$fraudService = Omnifraud::create('Kount', [
    'apiKey' => 'XXX',
    'merchantId' => '123456',
]);

As every driver is an implementation of Omnifraud\Contracts\ServiceInterface, you should be careful to ensure that you typehint this contract instead of any concrete implementations. Doing anything else would defeat the purpose of this library.

Front-end Implementation

All services expose a trackingCode(string $pageType, string $sessionId) method which returns a stringified snippet of JavaScript. You can call this method to insert the code necessary to instrument the front-end tracking of your fraud service. The two required parameters are a constant to specify the type of page we're inserting the snippet into, and the clients session ID.

<script>
<?= $fraudService->trackingCode(ServiceInterface::PAGE_CHECKOUT, $request->cookies->get('session_id')); ?>
</script>

Be sure to pass the appropriate constant as some services will differentiate between the two types of pages. It can be one of these two values:

ServiceInterface::PAGE_ALL
ServiceInterface::PAGE_CHECKOUT

Quite simply, the return string is an IIFE including the session ID. To help clarify how this works let's take a peak at the SignifydService. Its trackingCode() method will return the following JavaScript snippet:

(function(sid) {
    var script = document.createElement('script');
    script.setAttribute('src', 'https://cdn-scripts.signifyd.com/api/script-tag.js');
    script.setAttribute('data-order-session-id', sid);
    script.setAttribute('id', 'sig-api');

    document.body.appendChild(script);
})("{{ $sessionId }}");

Note: {{ $sessionId }} will be replaced with the sessionId Argument.

By default, anything you pass as $sessionId will be quoted and escaped (via json_encode). If you wish to pass raw JS (i.e. a variable name, global function, etc.), take advantage of the third, optional bool $quote parameter of trackingCode by setting it to false.

Services Methods

The interface is quite self-explanatory and you are encouraged to familiarize yourself with it by looking at ServiceInterface.php. All methods are typehinted in both their arguments and returns.

The methods exposed by all services are:

public function validateRequest(Request $request): ResponseInterface;
public function updateRequest(Request $request): ResponseInterface;
public function cancelRequest(Request $request): void;
public function logRefusedPayment(Request $request): void;
public function getRequestExternalLink(string $requestUid): ?string;
public function trackingCode(string $pageType, string $sessionId, bool $quote = true): string;

Creating Requests

In order to communicate with all services in a consistent way, all implementations accept a Request object throughout.

Services may differ in which fields are considered optional and which are required, but every service can accept a completely filled request. It is recommended to always fill out the Request object for the initial validateRequest and let the driver decide what fields need keeping/discarding.

Requests are containers for the following plain-old-PHP objects:

Account
Address (used for both shipping and billing)
Payment
Product
Purchase
Session

A complete Request would look similar to this:

<?php
use Omnifraud\Request\Request;
use Omnifraud\Request\Data\Account;
use Omnifraud\Request\Data\Address;
use Omnifraud\Request\Data\Payment;
use Omnifraud\Request\Data\Product;
use Omnifraud\Request\Data\Purchase;
use Omnifraud\Request\Data\Session;

$request = new Request();

$purchase = new Purchase();
$purchase->setId('1'); // Unique identifier for this sale
$purchase->setCreatedAt(new \DateTime('2017-09-02 12:12:12')); // Date the order was created at
$purchase->setCurrencyCode('CAD'); // ISO 4217 currency code
$purchase->setTotal(56025); // Total amount of the purchase, NO DECIMAL POINT.
$request->setPurchase($purchase);

$product1 = new Product();
$product1->setSku('SKU1'); // Product unique identifier
$product1->setName('Product number 1'); // Product name
$product1->setUrl('http://www.example.com/product-1'); // Product page
$product1->setImage('http://www.example.com/product-1/cover.jpg'); // Image of the product
$product1->setQuantity(1); // Quantity purchased
$product1->setPrice(6025); // Price of the product, NO DECIMAL POINT.
$product1->setWeight(100); // Weight in grams
$product1->setIsDigital(false); // Is this a digital product
$product1->setCategory('Category1'); // Category name
$product1->setSubCategory('Sub Category 1'); // Sub category name
$purchase->addProduct($product1);

$payment = new Payment();
$payment->setBin(457173); // First six numbers of the card
$payment->setLast4('9000'); // Last four numbers of the card
$payment->setExpiryMonth(9); // Expiration month 1-12
$payment->setExpiryYear(2020); // Expiration year
$payment->setAvs('Y'); // AVS response code, see http://www.emsecommerce.net/avs_cvv2_response_codes.htm
$payment->setCvv('M'); // CVV response code, see http://www.emsecommerce.net/avs_cvv2_response_codes.htm
$request->setPayment($payment);

$account = new Account(); // Customer account
$account->setId('ACCOUNT_ID'); // Account identifier
$account->setUsername('username'); // Username
$account->setEmail('test@example.com'); // Email address
$account->setPhone('1234567890'); // Phone number
$account->setCreatedAt(new \DateTime('2017-01-01 01:01:01')); // Account creation date
$account->setUpdatedAt(new \DateTime('2017-05-12 02:02:02')); // Account last edition date
$account->setLastOrderId('LAST_ORDER_ID'); // Previous sale identifier
$account->setTotalOrderCount(5); // Total number of orders made by this customer in the past
$account->setTotalOrderAmount(128700); // Total amount purchased by this customer, NO DECIMAL POINT.
$request->setAccount($account);

$session = new Session();
$session->setIp('1.2.3.4'); // Browser IP address
$session->setId('SESSION_ID'); // Session ID (same that was passed to the frontend code
$request->setSession($session);

$shippingAddress = new Address();
$shippingAddress->setFullName('John Shipping'); // Shipping name
$shippingAddress->setStreetAddress('1 shipping street');
$shippingAddress->setUnit('25');
$shippingAddress->setCity('Shipping Town');
$shippingAddress->setState('Shipping State');
$shippingAddress->setPostalCode('12345');
$shippingAddress->setCountryCode('US'); // ISO Alpha-2 country code
$shippingAddress->setPhone('1234567891'); // Use as main phone number
$request->setShippingAddress($shippingAddress);

$billingAddress = new Address();
$billingAddress->setFullName('John Billing'); // Name on the card
$billingAddress->setStreetAddress('1 billing street');
$billingAddress->setUnit('1A');
$billingAddress->setCity('Billing Town');
$billingAddress->setState('Billing State');
$billingAddress->setPostalCode('54321');
$billingAddress->setCountryCode('CA'); // ISO Alpha-2 country code
$billingAddress->setPhone('0987654321');
$request->setBillingAddress($billingAddress);

Alternative

If you're not a fan of creating all the objects necessary for a Request yourself, you can simply pass everything as a multidimensional array through the constructor of Request.

<?php
use Omnifraud\Request\Request;

$request = new Request([
    'session' => [
        'id' => 'ABC123',
        'ip' => '127.0.0.1',
    ],
    'purchase' => [
        'id' => 1,
        'createdAt' => new \DateTime('2017-09-02 12:12:12'),
        // ...
    ],
    // "products" is an array of products
    'products' => [
        [
            'sku' => 'SKU1',
            'url' => 'http://www.example.com/product-1',
            'price' => 6025,
            'category' => 'Shoes',
            // ...
        ],
        [
            'sku' => 'SKU99',
            'url' => 'http://www.example.com/product-99',
            'price' => 2050,
            'category' => 'Hats',
            // ...
        ],
    ],
    'payment' => [
        'bin' => '457173',
        'last4' => '9000',
        'avs' => 'Y',
        'cvv' => 'M',
        // ...
    ],
    // ...
]);

Responses

The Response interface exposes a few concise methods.

public function getRequestUid(): string; - the UID generated by the service for this request. Useful for future updates (see async responses below), cancellations, and generating URLs to the web-view of this fraud request
public function isPending(): bool; - whether or not this response contains a ready response. Some services will require extra time to manually review a request before giving a score + guarantee.
public function getScore(): ?float; - if not pending, will contain a score from 0 to 100 (0 = worst, 100 = best)
public function isGuaranteed(): bool; - if supported by the service, determines whether or not the liability for this order can be shifted to the service. Typically called "Chargeback guarantee".

Asynchronous Responses

When you get a response that's pending (isPending() === true above), you're not yet capable of retrieving it's score and guarantee. In this case you should make note of the request UID and try fetching the status again later.

For example, you could dispatch a background job with the order ID and request ID, and try updating it again at a later date.

if ($response->isPending()) {
    $this->dispatchForLaterUpdate($response->getRequestUid(), $order->id);
}

omnifraud / omnifraud

Maintainers

Details

README

Omnifraud ·

Table of Contents

Motivation

Installation

Basic Example

Fraud Services / Drivers

The `Null` Driver

Usage

The Session ID

Instantiation

Front-end Implementation

Services Methods

Creating Requests

Alternative

Responses

Asynchronous Responses

omnifraud / omnifraud

Maintainers

Details

README

Omnifraud ·

Table of Contents

Motivation

Installation

Basic Example

Fraud Services / Drivers

The Null Driver

Usage

The Session ID

Instantiation

Front-end Implementation

Services Methods

Creating Requests

Alternative

Responses

Asynchronous Responses

The `Null` Driver