library pingyo

limely/pingyo

Installation

Application uses Composer to install and update:, _(*1)

curl -s http://getcomposer.org/installer | php
php composer.phar require limely/pingyo:1.*

Usage

Enum fields will be converted to integer automatically. Dates will be converted to JS Date objects automatically., _(*2)

Step 1. Create Source Details object, _(*3)

$source_details = new PingYo\SourceDetails();
$source_details->address = 'asd';
$source_details->clientuseragent = 'asd';
$source_details->creationurl = 'http://www.url.com';

Step 2. Create Application Details object, _(*4)

$application_details = new PingYo\ApplicationDetails();

$application_details->title = TitleTypes::MR;
$application_details->firstname = "John";
$application_details->lastname = "Smith";
$application_details->dateofbirth = "1994-09-01";
$application_details->email = "johnsmith@domain.com";
$application_details->homephonenumber = "+12345678900";
$application_details->mobilephonenumber = "07123456789";
$application_details->workphonenumber = "+12345678900";

$application_details->employername = "Test Corp";
$application_details->jobtitle = "Construction Worker";
$application_details->employmentstarted = "2014-09-01";
$application_details->employerindustry = PingYo\EmployerIndustryTypes::ConstructionManufacturing;
$application_details->incomesource = PingYo\IncomeSourceTypes::EmployedFullTime;
$application_details->payfrequency = PingYo\PayFrequencyTypes::LastWorkingDayMonth;
$application_details->payamount = 100;
$application_details->incomepaymenttype = PingYo\IncomePaymentTypes::RegionalDirectDeposit;
$application_details->nextpaydate = "2014-10-01";
$application_details->followingpaydate = "2014-10-10";
$application_details->loanamount = 10000;
$application_details->nationalidentitynumber = null;
$application_details->nationalidentitynumbertype = PingYo\NationalIdentityNumberTypes::NationalInsurance;
$application_details->consenttocreditsearch = true;
$application_details->consenttomarketingemails = true;
$application_details->residentialstatus = PingYo\ResidentialStatusTypes::HomeOwner;

$application_details->housenumber = "122";
$application_details->housename = null;
$application_details->addressstreet1 = "Test Street";
$application_details->addresscity = "Test City";
$application_details->addresscountrycode = "GB";
$application_details->addresscounty = "County Test";
$application_details->addressmovein = "2014-08-01";
$application_details->addresspostcode = "BT602EW";

$application_details->bankaccountnumber = "12345678";
$application_details->bankcardtype = PingYo\BankCardTypes::VisaDebit;
$application_details->bankroutingnumber = "123456";
$application_details->monthlymortgagerent = 600;
$application_details->monthlycreditcommitments = 100;
$application_details->otherexpenses = 250;
$application_details->minimumcommissionamount = 0;
$application_details->maximumcommissionamount = 0;
$application_details->applicationextensions = ["x"=>"hello","y"=>"world"];

Step 3. Create Application object and attach ApplicationDetails and SourceDetails objects, _(*5)

$application = new PingYo\Application();
$application->affiliateid = 'TEST';
$application->timeout = 120;
$application->testonly = true;
$application->setApplicationDetails($application_details);
$application->setSourceDetails($source_details);

Step 4. Validate, _(*6)

$validation_result = $application->validate();
if($validation_result)
{
    //prevalidation OK
    //next step
}
else
{
    var_dump($validation_result);
    //$validation_result contains validation problems
}

Step 5. Send Application, _(*7)

$application_status = $application->send();
if($application_status===false)
{
    //validation problems
    //step 4 missed?
}
else
{
    //next step
}

Step 6. Check Application Result, _(*8)

if($application_status->httpcode=202)
{
    //all fine, server validation passed
    //next step
}
else
{
    //check problems
    var_dump($application_status->errors);
    var_dump($application_status->message);
}

Step 7. Take Redirect Url. You can wait for result in loop or use async requests, _(*9)

while ($application_status->percentagecomplete!=100)
{   
    $application_status->refresh();
    sleep(2);
}
$final_status = $application_status->status;
switch($final_status){
    case 'LenderMatchFound':
        $redirect_location = $application_status->redirectionurl;
    break;
    case 'Unknown':
        //some action
    break;
    case 'Resurrecting':
        //some action
    break;
    case 'Processing':
        //some action
    break;
    case 'LenderMatchFound':
        //some action
    break;
    case 'ConditionalLenderMatchFound':
        //some action
    break;
    case 'NoLenderMatchFound':
        //some action
    break;
    case 'Rejected':
        //some action
    break;
    case 'Withdrawn':
        //some action
    break;
    case 'Erred':
        //some action
    break;
}

Or Async method:, _(*10)

//get and save correlationid for async requests
$corrid = $application_status->correlationid;

//....
//async requests code
$application_status=PingYo\Status::CreateFromCorrelationId($corrid);
$application_status->refresh();
if($application_status->percentagecomplete==100)
{
    //action
}
else
{
    //do nothing, next request can take action
    //or read problems
    $status = $application_status->status;
    $problem = $application_status->message;
}

LOGGER SUPPORT

Install Monolog Logger (https://github.com/Seldaek/monolog) or any other Psr3 logger, _(*11)

$logger = new Logger("PingYo");
$logger->pushHandler(new StreamHandler("pingyo.log"));

$application = new PingYo\Application();
$application->attachLogger($logger);

//...
//for async requests
$application_status=PingYo\Status::CreateFromCorrelationId($corrid,$logger);

RUNNING TESTS

phpunit.phar --bootstrap tests/Bootstrap.php tests/PingYo/basictest, _(*12)