README

Dotpay is the most comprehensive online worldwilde payments solution dedicated for polish ecommerce. This repository comes with middlewares for payments implementation and validation layer.

Documentation

Are you interested in more details? Here's the complete documentation of API.

Using this library

Install

The source code is distributed via Composer and Packagist.

composer require krzysiekpiasecki/dotphpay

Payment Middleware

Custom domain payment handler must implement only the interface \Dotpay\Server\Handler\PaymentHandlerInterface. You have to use it at least for persisting client payments, before redirecting the client to the payment gateway.

class BusinessPaymentHandler implements \Dotpay\Server\Handler\PaymentHandlerInterface
{
    public function handle(Payment $payment)
    {
        // TODO: Implement handle() method.
    }
}

After implementing the handler, create PSR-15 compatible request object, for example using Zend Diactoros component.

$psrRequest = Zend\Diactoros\ServerRequestFactory::fromGlobals(
    $_GET,
    $_POST
);

At the end, call the payment middleware to execute your own payment handler and then to send a redirect response to the client using for example Zend Diactoros component.

$paymentMiddleware = new \Dotpay\Server\Payment();

$httpResponse = $paymentMiddleware->process(
    $psrRequest,
    new \Dotpay\Server\Handler\PaymentHandler(
        '747789',
        'Np3n4QmXxp6MOTrLCVs905fdrGf3QIGm',
        new BusinessPaymentHandler()
    )
);

$emitter = new \Zend\Diactoros\Response\SapiEmitter();
$emitter->emit($httpResponse);

URLC Middleware

Custom domain URLC handler must implement only the interface \Dotpay\Server\Handler\URLCHandlerInterface. You have to use it to confirm transaction complete or handle status changing.

class BusinessURLCHandler implements \Dotpay\Server\Handler\URLCHandlerInterface
{
    public function handle(\Dotpay\Response\URLC $URLC)
    {
        // TODO: Implement handle() method.
    }
}

After implementing the handler, create PSR-15 compatible request object, for example with Zend Diactoros component.

$psrRequest = \Zend\Diactoros\ServerRequestFactory::fromGlobals(
    $_POST
);

At the end, call the URLC middleware to execute your own URLC handler and then send a response "OK" to Dotpay, when the transaction was handled correctly, using for example Zend Diactoroscomponent.

$urlcMiddleware = new \Dotpay\Server\Payment();

$httpResponse = $urlcMiddleware->process(
    $psrRequest, 
    new \Dotpay\Server\Handler\URLCHandler(
        'Np3n4QmXxp6MOTrLCVs905fdrGf3QIGm',
        new BusinessURLCHandler()
    )
);

$emitter = new \Zend\Diactoros\Response\SapiEmitter();
$emitter->emit($httpResponse);

Error Code Middleware

Custom domain handler for getting error codes from Dotpay server must implement only the interface \Dotpay\Server\Handler\ErrorCodeHandlerInterface.

class BusinessErrorCodeHandler implements \Dotpay\Server\Handler\ErrorCodeHandlerInterface  {
    public function handle(string $errorCode)
    {
        // TODO: Implement handle() method with custom logic
    }
}

After implementing the handler, create PSR-15 compatible request object, for example with Zend Diactoros component.

$psrRequest = Zend\Diactoros\ServerRequestFactory::fromGlobals(
    $_GET
);

At the end, call the error code middleware to execute your own error code handler.

$errorCodeMiddleware = new \Dotpay\Server\ErrorCode();

$httpResponse = $errorCodeMiddleware->process(
     $psrRequest,
     new \Dotpay\Server\Handler\ErrorCodeHandler(
         new BusinessErrorCodeHandler()
     )
);

Validation layer

This library uses Symfony Validator component to validate the request. If you want, you can use validation layer provided by this library standalone. Example of validation is here:

use Symfony\Component\Validator\Validation;

$validator = Validation::createValidator();
$violations = $validator->validate('-1',
    new \Dotpay\Request\Validator\Constraint\IdConstraint()
);

if (0 !== count($violations)) {
    // there are errors, now you can show them
    foreach ($violations as $violation) {
        echo $violation->getMessage().'<br>';
        // Output: The value "-1" is not a valid 'id' parameter
    }
}

Additional resources

Dotpay Technical Manual For Payments Implementation
Using Symfony Validation component

krzysiekpiasecki / dotphpay

Maintainers

Details