README

Introduction

Integrate your Laravel application with Redsys, the lead payment gateway in Spain.

This package provides:

Redsys integration with Redirection and REST methods
Associate Redsys request with Eloquent models
Associate Redsys card tokens with Eloquent models
Management for Redsys notifications (payment confirmation)
Advanced custom Redsys requests that cover all features
Fake gateway for local testing

You'll be able to create a payment request, redirect the user to the payment gateway and process Redsys response with just a few lines of code:

public function createPaymentAndRedirect()
{
    $redsysRequest = $yourModel->createRedsysRequest(
        productDescription: 'Product description',
        payMethod: PayMethod::Bizum,
    );
    return $redsysRequest->redirect();
}

If you are not using Laravel, check our other package creagia/redsys-php for just a Redsys PHP library.

Support us

Installation

You can install the package via composer:

composer require creagia/laravel-redsys

After that, you should publish and run the migrations:

php artisan vendor:publish --tag="redsys-migrations"
php artisan migrate

Next, you should publish the config file with:

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

Finally, you should define, at least, the required options in your .env file:

REDSYS_ENVIRONMENT
REDSYS_MERCHANT_CODE
REDSYS_KEY

This is the content of the published config file:

return [
    /**
     * Used to define the service URL. Possible values 'test', 'production' or 'local'.
     *
     * It's recommended to use 'local' during your development to enable a local gateway to test your
     * application without need to expose it.
     */
    'environment' => env('REDSYS_ENVIRONMENT'),

    /**
     * Values sent to Redsys.
     */
    'tpv' => [
        'terminal' => env('REDSYS_TERMINAL', 1),
        'currency' => \Creagia\Redsys\Enums\Currency::EUR,
        'merchantCode' => env('REDSYS_MERCHANT_CODE'), // Default test code: 999008881
        'key' => env('REDSYS_KEY'), // Default test key: sq7HjrUOBfKmC576ILgskD5srU870gJ7
    ],

    /**
     * Prefix used by the package routes. 'redsys' by default.
     */
    'routes_prefix' => env('REDSYS_ROUTE_PREFIX', 'redsys'),

    /**
     * Route names for successful and unsuccessful confirm pages. Redsys redirects to these routes
     * after the payment is finished. By default, this package provides two neutral views.
     */
    'successful_payment_route_name' => env('REDSYS_SUCCESSFUL_ROUTE_NAME', null),
    'unsuccessful_payment_route_name' => env('REDSYS_UNSUCCESSFUL_ROUTE_NAME', null),
    
    /**
     * Use an automatic prefix for the order number with the current year and month.
     */
    'order_num_auto_prefix' => true,

    /**
     * Redsys order number should be unique. Here you can set an order number prefix if you need it.
     * This prefix must be an integer number.
     */
    'order_num_prefix' => env('REDSYS_ORDER_NUM_PREFIX', 0),
];

Introduction

This packages integrates redsys-php with your Laravel application. You can use it in two different ways:

Associating requests with Eloquent models
Creating standalone Redsys requests

Associate requests with Eloquent models

Add the CanCreateRedsysRequests trait and implement the RedsysPayable class to the model you would like make payable.

Typically, this model would be something like Order for a full ecommerce or cart system, but you can associate payments with multiple Eloquent models if you prefer it.

You should implement your getTotalAmount and paidWithRedsys methods. The first one will return the computed total amount for the payment in cents. The second will be executed when Redsys confirms the payment was successful.

use Creagia\LaravelRedsys\Concerns\CanCreateRedsysRequests;
use Creagia\LaravelRedsys\Contracts\RedsysPayable;

class YourModel extends Model implements RedsysPayable
{
    use CanCreateRedsysRequests;

    public function getTotalAmount(): int
    {
        return 199_99;
    }

    public function paidWithRedsys(): void
    {
        // Notify user, change status to paid, ...
    }
}

Create request:

use Creagia\Redsys\Enums\PayMethod;

$redsysRequest = $yourModel->createRedsysRequest(
    productDescription: 'Product description',
    payMethod: PayMethod::Card,
);

Custom Redsys requests

If you prefer to not associate a Redsys request to an Eloquent model, or you need to create a more complex request, you can create a custom request easily.

This way you can totally customize the request and implement every Redsys feature available. The request input parameters are defined with a RequestParameters object that implements all the available parameters

use Creagia\LaravelRedsys\RequestBuilder;

$redsysRequestBuilder = RequestBuilder::newRequest(
    new \Creagia\Redsys\Support\RequestParameters(
        transactionType: \Creagia\Redsys\Enums\TransactionType::Autorizacion,
        productDescription: 'Description',
        amountInCents: 123_12,
        currency: Currency::EUR,
        payMethods: \Creagia\Redsys\Enums\PayMethod::Card,
    )
);

The RequestBuilder has some middle methods to help you create your requests. You can associate your custom request with an eloquent model using the associateWithModel() method and interact with credit card tokens with requestingCardToken() or usingCardToken() methods. Check the Credential-On-File requests section to know more about it.

After creating the request you should continue on the next section to send the request to Redsys.

Sending requests to Redsys

From all the integration methods available on Redsys, you can implement 'Redirection' and 'REST' methods.

Once you created your Redsys request, you should send it either with redirection:

use Creagia\Redsys\Enums\PayMethod;

public function redirection()
{
    $redsysRequest = $yourModel->createRedsysRequest(
        productDescription: 'Product description',
        payMethod: PayMethod::Card,
    );
    return $redsysRequest->redirect();
}

or send it as a POST request:

use Creagia\Redsys\Enums\Currency;
use Creagia\Redsys\Enums\TransactionType;
use Creagia\LaravelRedsys\RequestBuilder;
use Illuminate\Database\Eloquent\Model;

public function cancellation(Model $yourModel)
{
    $redsysRequest = RequestBuilder::newRequest(new RequestParameters(
        amountInCents: $yourModel->getTotalAmount(),
        currency: Currency::EUR,
        order: '1446068581',
        transactionType: TransactionType::Anulacion,
    ))->associateWithModel($yourModel);

    return $redsysRequest->post();
}

Keep in mind that the REST integration mode is not available for all features and is not always enabled by default. Always check the Redsys documentation and your account configuration if you are not sure if you can use it or something is not working.

Redsys response

Redsys notification with the request result will be automatically managed by the package. For successful payments, the package will run the paidWithRedsys method from your model.

Redirect users back

In the redirection method, when the client has finished, Redsys will redirect they to your website. By default, this package serves a successful or unsuccessful route with a pretty simple view. You can override redirect routes on the config file:

'successful_payment_route_name' => env('REDSYS_SUCCESSFUL_ROUTE_NAME', null),
'unsuccessful_payment_route_name' => env('REDSYS_UNSUCCESSFUL_ROUTE_NAME', null),

Credential-On-File (token) requests

Credential-On-File requests uses authorized stored card data to create future requests after an initial one. This is useful for a few use cases like subscriptions with recurring payments or installments for individual payments.

While you can create Credential-On-File with a custom Redsys request as defined on Redsys documentation, this packages provides some helpers to make it easier.

Credential-On-File transactions require an initial request where you ask for a card token. After that, you can create new requests with the card token stored on your application.

Prepare your Eloquent model

Use the InteractsWithRedsysCards concern on the model you want to associate with Redsys card tokens. Typically this model will be User, Team or Subscription, for example.

use Creagia\LaravelRedsys\Concerns\InteractsWithRedsysCards;

class Team extends Model
{
    use InteractsWithRedsysCards;

    ...
}

Initial request

use Creagia\Redsys\Enums\CofType;
use Creagia\Redsys\Enums\PayMethod;

/**
 * Use this example to associate the request and card easily to Eloquent models
 */
public function initialRequest()
{
    $redsysRequest = $yourProductModel->createRedsysRequest(
        productDescription: 'Product description',
        payMethod: PayMethod::Card,
    )->requestingCardToken(
        CofType::Recurring
    )->storeCardOnModel(
        $yourPayingModel // User, Team, ...
    );
    
    return $redsysRequest->redirect();
}

/**
 * Use this example for a custom request, optionally associating the request to Eloquent models
 */
public function initialCustomRequest()
{
    $redsysRequest = RequestBuilder::newRequest(new RequestParameters(
        amountInCents: 19_99,
        currency: Currency::EUR,
        transactionType: TransactionType::Autorizacion,
    ))->associateWithModel(
        $yourProductModel
    )->requestingCardToken(
        CofType::Recurring
    )->storeCardOnModel(
        $yourPayingModel // User, Team, ...
    );
    return $redsysRequest->redirect();
}

Future requests

use Creagia\Redsys\Enums\Currency;
use Creagia\Redsys\Enums\TransactionType;
use Creagia\LaravelRedsys\RequestBuilder;
use Illuminate\Database\Eloquent\Model;
use Creagia\Redsys\Enums\CofType;

public function renewSubscription(Model $yourProductModel, Model $yourPayingModel)
{
    $redsysCard = $yourPayingModel->redsysCards->last();  // User, Team, ...
    
    $redsysRequest = RequestBuilder::newRequest(new RequestParameters(
        amountInCents: $yourProductModel->getTotalAmount(),
        currency: Currency::EUR,
        transactionType: TransactionType::Autorizacion,
    ))
        ->associateWithModel(
            $yourProductModel
        )->usingCard(
            CofType::Recurring, 
            $redsysCard,
        );

    return $redsysRequest->post();
}

Local Gateway

LaravelRedsys provides a practical local gateway to test your app locally without need to expose it. When your environment config is defined to local, your Redsys payments will redirect to your local app instead of the test or production Redsys url.

You'll be able to test authorised and denied payments selected the response code between the available options.

For your security, this feature is only available if your app is set to local environment too, apart from the package config.

Unsuccessful or abandoned payments

Unsuccessful payments won't execute any method, unlike the successful ones.

Users can abandon the payment on the Redsys side, and we wouldn't get notified on that. Because of that, you should take care of pending/cancelled/abandoned payments on your application.

Events

The package will fire some events you can listen to:

RedsysNotificationEvent

This event is fired when Redsys tries to notify you with a result from a payment. This event doesn't contain the RedsysPayment model because it's fired before processing the request.

The event has one property with the request inputs from Redsys: $fields.

RedsysSuccessfulEvent

This event is fired when a successful notification from Redsys is processed.

The event has two properties:

$redsysPayment: the processed RedsysPayment model.
$notificationData: array with the successful notification data.

RedsysUnsuccessfulEvent

This event is fired when an unsuccessful notification from Redsys is processed.

The event has two properties:

$redsysPayment: the processed RedsysPayment model.
$errorMessage: string with the error message from Redsys.

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

creagia / laravel-redsys

Maintainers

Details

README

Introduction

Support us

Installation

Usage

Introduction

Associate requests with Eloquent models

Custom Redsys requests

Sending requests to Redsys

Redsys response

Redirect users back

Credential-On-File (token) requests

Prepare your Eloquent model

Initial request

Future requests

Local Gateway

Unsuccessful or abandoned payments

Events

RedsysNotificationEvent

RedsysSuccessfulEvent

RedsysUnsuccessfulEvent

Testing

Changelog

Contributing

Security Vulnerabilities

Credits

License