README

🛡️ Fraud Checker BD Courier

A powerful framework-agnostic PHP package to analyze customer delivery behavior across top Bangladeshi courier services. (Fully supports Laravel out-of-the-box!)

📌 Introduction

E-commerce businesses in Bangladesh often face significant losses due to fraudulent orders and high return rates. Fraud Checker BD Courier protects your bottom line by instantly analyzing a customer's track record across major logistics providers (Steadfast, Pathao, and RedX).

By checking a simple phone number, you get immediate insights into a customer's success and cancellation ratios, helping you decide whether to approve, verify, or reject cash-on-delivery (COD) shipments.

🎯 Key Capabilities

🔍 Multi-Courier Analytics: Fetch delivery histories simultaneously from Steadfast, Pathao, and RedX.
📊 Aggregated Statistics: Get a unified view of total deliveries, successes, cancellations, and percentages.
📱 Smart Number Validation: Built-in strictly enforced validation for standard Bangladeshi mobile numbers (e.g., 017XXXXXXXX).
🏗️ Framework-Agnostic Core: Completely decoupled from Laravel. Use it in any native PHP, Symfony, or CodeIgniter project.
⚡ Laravel Friendly: Simple Facade access and effortless Laravel auto-discovery integration are still included!

💻 Requirements

PHP: ^8.2.0
Guzzle: ^7.8

📦 Installation

1. Install via Composer:

composer require azmolla/fraud-checker-bd-courier

2. Laravel Users - Publish Configuration File:

php artisan vendor:publish --tag="config"

(This will create a config/fraud-checker-bd-courier.php file in your application directory.)

(Note: Laravel Auto-Discovery is fully supported. If you are using Laravel 5.4 or older, you will need to manually register the Service Provider and Facade in config/app.php.)

🧩 Setup & Usage

Usage in Laravel

Add credentials to your .env file just like before:

PATHAO_USER="your_pathao_email@example.com"
PATHAO_PASSWORD="your_pathao_password"
STEADFAST_USER="your_steadfast_email@example.com"
STEADFAST_PASSWORD="your_steadfast_password"
REDX_PHONE="your_redx_login_phone_number"
REDX_PASSWORD="your_redx_password"

Checking a customer's fraud probability is a one-liner using the provided Facade.

use FraudCheckerBdCourier;

// Input a standard 11-digit Bangladeshi mobile number
$report = FraudCheckerBdCourier::check('01712345678');

dd($report);

Usage in Pure PHP (or Non-Laravel Frameworks)

Since Version 1.2.0, this package is completely decoupled from Laravel. You can instantiate it using the FraudCheckerConfig class:

require 'vendor/autoload.php';

use Azmolla\FraudCheckerBdCourier\Config\FraudCheckerConfig;
use Azmolla\FraudCheckerBdCourier\Cache\FileTokenCache;
use Azmolla\FraudCheckerBdCourier\Services\SteadfastService;
use Azmolla\FraudCheckerBdCourier\Services\PathaoService;
use Azmolla\FraudCheckerBdCourier\Services\RedxService;
use Azmolla\FraudCheckerBdCourier\FraudCheckerBdCourierManager;

// 1. Setup Configuration
$config = new FraudCheckerConfig([
    'steadfast' => [
        'user' => 'your_steadfast_email@example.com',
        'password' => 'your_steadfast_password'
    ],
    'pathao' => [
        'user' => 'your_pathao_email@example.com',
        'password' => 'your_pathao_password'
    ],
    'redx' => [
        'phone' => 'your_redx_login_phone_number',
        'password' => 'your_redx_password'
    ]
]);

// 2. Setup Cache for RedX tokens (defaults to sys_get_temp_dir()/fraud_checker_cache)
$cache = new FileTokenCache(__DIR__ . '/cache');

// 3. Initialize Services
$steadfastService = new SteadfastService($config);
$pathaoService = new PathaoService($config);
$redxService = new RedxService($config, $cache);

// 4. Initialize Manager
$fraudChecker = new FraudCheckerBdCourierManager($steadfastService, $pathaoService, $redxService, $config);

// 5. Check Number
$report = $fraudChecker->check('01712345678');
print_r($report);

📈 Structural Response Example

The package returns a highly structured array indicating individual and aggregated network metrics:

[
    'steadfast' => ['success' => 3, 'cancel' => 1, 'total' => 4, 'success_ratio' => 75.0],
    'pathao'    => ['success' => 5, 'cancel' => 2, 'total' => 7, 'success_ratio' => 71.43],
    'redx'      => ['success' => 20, 'cancel' => 5, 'total' => 25, 'success_ratio' => 80.0],

    // The summary across all supported couriers
    'aggregate' => [
        'total_success'    => 28,
        'total_cancel'     => 8,
        'total_deliveries' => 36,
        'success_ratio'    => 77.78,
        'cancel_ratio'     => 22.22
    ]
]

🛠️ Advanced Usage (SOLID Design)

For granular control, the package is architected using SOLID principles. Every courier class adheres to Azmolla\FraudCheckerBdCourier\Contracts\CourierServiceInterface, guaranteeing a uniform getDeliveryStats(string $phoneNumber): array signature.

Instantiating Individual Services

If you only need to run analytics against a single courier, avoid the Facade overhead and use the specific service classes directly:

use Azmolla\FraudCheckerBdCourier\Services\PathaoService;
use Azmolla\FraudCheckerBdCourier\Services\SteadfastService;
use Azmolla\FraudCheckerBdCourier\Services\RedxService;

$steadfastData = (new SteadfastService())->getDeliveryStats('01712345678');
$redxData      = (new RedxService())->getDeliveryStats('01712345678');
$pathaoData    = (new PathaoService())->getDeliveryStats('01712345678');

📱 Phone Validation Helper

Numbers are strictly validated against ^01[3-9][0-9]{8}$ to prevent unnecessary API failures.

✅ Valid: 01712345678, 01876543219
❌ Invalid: +8801712345678, 1234567890, 02171234567

You can manually trigger this validation check:

use Azmolla\FraudCheckerBdCourier\Helpers\CourierDataValidator;

CourierDataValidator::checkBdMobile('01712345678');
// Throws InvalidArgumentException if formatting fails

🧪 Testing

The package includes an extensive test suite built with orchestra/testbench and phpunit. API calls are safely mocked, meaning you do not need live .env credentials to confidently run tests locally.

composer test
# Or if you don't have scripts defined:
./vendor/bin/phpunit

🙏 Acknowledgments

Special thanks to S. Ahmad for the initial inspiration and discovering the API endpoints.

‍💻 Created By

Abiruzzaman Molla

📧 Email: abiruzzaman.molla@gmail.com
🐙 GitHub: @AbiruzzamanMolla

☕ Support Me

If you find this project useful, you can buy me a coffee!

If you find this package helpful in fighting fraudulent orders, please consider starring the repository! ⭐

azmolla / fraud-checker-bd-courier

Maintainers

Package info

Statistics

Security