crowdproperty/modulr-hmac-php-client

0.4.1 2020-11-23 09:38 UTC

Requires

• php: >=5.4.0
• monolog/monolog: 1.*
• nesbot/carbon: ^1.26.3 || ^2.0

Requires (Dev)

• orchestra/testbench: ^v4.0
• phpunit/phpunit: ^8.3

GPL-3.0

README

A php client that handles HMAC auth to Modulr API

Installation

Installation is done via Composer:

composer require crowdproperty/modulr-hmac-php-client

Laravel

After updating composer, add the service provider to the providers array in config/app.php:

'providers' => [
    ...
    CrowdProperty\ModulrHmacPhpClient\ModulrServiceProvider::class,
    ...
];

Publish the package config to your application with the following artisan commands:

php artisan vendor:publish --provider="CrowdProperty\ModulrHmacPhpClient\ModulrServiceProvider" 

Other framework/no framework

You can use CrowdProperty\ModulrHmacPhpClient without laravel. You can call the class ModulrApi directly for example:

$api = new CrowdProperty\ModulrHmacPhpClient\ModulrApi();

$api->setApiPath('https://api-sandbox.modulrfinance.com/api-sandbox')
    ->setApiKey('API_KEY')
    ->setHmacSecret('HMAC_SECRET')
    ->setDebugMode(true);

...

$api->customers()->createCustomer((string) $customer);

Configuration

The vedor publish command will generate a modulr config file located in your config folder. You may changes these values in your .env file.

Available config options are:

MODULR_API_NAME - Not required

MODULR_API_KEY - API Key provided by Modulr Finance

MODULR_HMAC_SECRET - HMAC Secret provided by Modulr Finance

MODULR_ENVIRONMENT - Which envirnment to use. Defaults to sandbox

MODULR_DEBUG - Enable debug mode. Defaults to false

##Example

<?php
namespace App\Http\Controllers;

use CrowdProperty\ModulrHmacPhpClient\Facades\ModulrApi;
use CrowdProperty\ModulrHmacPhpClient\Model\Address;
use CrowdProperty\ModulrHmacPhpClient\Model\Associate;
use CrowdProperty\ModulrHmacPhpClient\Model\Customer;

class DemoController extends BaseController
{

    public function __construct()
    {
        $customer = new Customer();

        $customer->setTcsVersion(1);
        $customer->setExpectedMonthlySpend(0);
        $customer->setType('INDIVIDUAL');

        $associate = new Associate();
        $associate->setVerificationStatus('EXVERIFIED');
        $associate->setEmail('[e-mail]');
        $associate->setPhone('07777777777');
        $associate->setFirstName('First');
        $associate->setLastName('Last');
        $associate->setDateOfBirth('1970-01-18');
        $associate->setType('INDIVIDUAL');
        $associate->setApplicant(true);

        $address = new Address();
        $address->setAddressLine1('Address1');
        $address->setAddressLine2('Address2');
        $address->setPostCode('Postcode');
        $address->setPostTown('town');
        $address->setCountry('GB');

        $associate->setHomeAddress($address);

        $customer->setAssociates([$associate]);

        $response = ModulrApi::customers()->createCustomer((string) $customer);

        var_dump($response);
    }
}