cokecancino/laravel-flow

Laravel package para la integraciĆ³n de pagos con Flow (https://www.flow.cl)

1.2.2 2017-12-22 02:06 UTC

This package is auto-updated.

Last update: 2023-01-04 12:27:42 UTC


README

Total Downloads Latest Stable Version License

Paquete para Laravel que implementa la integración de pagos con Flow.

Probado con Laravel 5.1 y 5.5

Instalación

Paso 1: Instalar a través de Composer

$ composer require cokecancino/laravel-flow

Paso 2: Agregar el Service Provider

En el archivo config/app.php, agregar la siguiente línea al array providers:

'providers' => [
    …
    CokeCancino\LaravelFlow\FlowServiceProvider::class,
    …
],

Paso 3: Agregar el alias

En el mismo archivo, agregar la siguiente línea al array aliases:

'aliases' => [
    …
    'Flow' => CokeCancino\LaravelFlow\Facades\Flow::class,
    …
],

Paso 4: Publicar el archivo de configuración

$ php artisan vendor:publish --provider="CokeCancino\LaravelFlow\FlowServiceProvider" --force

Paso 5: Configura tu .env o modifica tu config/flow.php

…
FLOW_URL_PAGO=http://flow.tuxpan.com/app/kpf/pago.php
FLOW_COMERCIO=emailFlow@comercio.com

Utilización

Este paquete actúa como un Service Provider para el Kit de Integración de Flow, por lo tanto, me limitaré a ejemplificar solo las diferencias de su utilización dentro de Laravel.

Importante: Excluye la protección CSRF para las páginas de éxito, fracaso y confirmación, ya que Flow no sabrá qué token CSRF enviar a tus rutas.

Proyecto de demostración

Antes de ver los ejemplos que vienen a continuación, quizás prefieras echarle un vistazo al proyecto de demostración del paquete implementado en Laravel 5.5, o bien analizarlo en conjunto para una mayor comprensión de cómo utilizarlo.

Formulario de compra

View: resources/views/index.blade.php

@extends('layouts._master')

@section('content')
    <form method="POST" action="{{ route('orden') }}">
        <input type="hidden" name="_token" value="{{ csrf_token() }}">
        Orden n°: <input type="text" name="orden" id="orden" placeholder="1000" required><br>
        Monto: <input type="text" name="monto" id="monto" placeholder="20000" required><br>
        Descripción: <input type="text" name="concepto" id="concepto" placeholder="Pago de orden n° 1000" required><br>
        Email pagador (opcional): <input type="email" name="pagador" id="pagador" placeholder="usuario@email.com"><br>
        <br>
        <button type="submit">Aceptar</button>
    </form>
@endsection

Creando una nueva orden

Controller: Http/Controllers/FlowController.php

<?php

namespace App\Http\Controllers;

use Flow;

use Illuminate\Http\Request;

class FlowController extends Controller
{
    /**
     * Creando una nueva orden
     *
     * @param Request $request
     * @return \Illuminate\View\View
     */
    public function orden(Request $request)
    {
        $orden = [
            'orden_compra'  => $request->input('orden'),
            'monto'         => $request->input('monto'),
            'concepto'      => $request->input('concepto'),
            'email_pagador' => $request->input('pagador'),

            // Opcional: Medio de Pago (Webpay = 1, Servipag = 2, Multicaja = 3, Todos = 9)
            //'medio_pago'    => $request->input('medio_pago'),
        ];

        // Genera una nueva orden de pago, Flow la firma y retorna un paquete de datos firmados
        $orden['flow_pack'] = Flow::new_order($orden['orden_compra'], $orden['monto'], $orden['concepto'], $orden['email_pagador']);

        // Si desea enviar el medio de pago usar la siguiente línea
        //$orden['flow_pack'] = Flow::new_order($orden['orden_compra'], $orden['monto'], $orden['concepto'], $orden['email_pagador'], $orden['medio_pago']);

        return view('orden', $orden);
    }
…

View: resources/views/orden.blade.php

@extends('layouts._master')

@section('content')
    <!-- Formulario HTML que envía la nueva orden -->
    Confirme su orden antes de proceder al pago vía Flow<br>
    <br>
    Orden n°: {{ $orden_compra }}<br>
    Monto: {{ $monto }}<br>
    Descripción: {{ $concepto }}<br>
    Email pagador (opcional): {{ $email_pagador }}<br>
    <br>
    <form method="POST" action="{{ config('flow.url_pago') }}">
        <input type="hidden" name="_token" value="{{ csrf_token() }}">
        <input type="hidden" name="parameters" value="{{ $flow_pack }}">
        <button type="submit">Pagar en Flow</button>
    </form>
@endsection

Página de éxito

Controller: Http/Controllers/FlowController.php

/**
     * Página de éxito del comercio
     *
     * Esta página será invocada por Flow cuando la transacción resulte exitosa
     * y el usuario presione el botón para retornar al comercio desde Flow.
     *
     * @return \Illuminate\View\View
     */
    public function exito()
    {
        // Lee los datos enviados por Flow
        Flow::read_result();

        // Recupera los datos enviados por Flow
        $orden = [
            'orden_compra'  => Flow::getOrderNumber(),
            'monto'         => Flow::getAmount(),
            'concepto'      => Flow::getConcept(),
            'email_pagador' => Flow::getPayer(),
            'flow_orden'    => Flow::getFlowNumber(),
        ];

        return view('flow.exito', $orden);
    }
…

View: resources/views/flow/exito.blade.php

@extends('layouts._master')

@section('content')
    <h1>Página de éxito de comercio</h1>
    Su pago se ha realizado con éxito<br>
    <br>
    Orden de compra: {{ $orden_compra }}<br>
    Monto: {{ $monto }}<br>
    Descripción: {{ $concepto }}<br>
    Pagador: {{ $email_pagador }}<br>
    Flow orden n°: {{ $flow_orden }}<br>
    <br>
    Gracias por su compra
@endsection

Página de fracaso

Controller: Http/Controllers/FlowController.php

/**
     * Página de fracaso del comercio
     *
     * Esta página será invocada por Flow cuando la transacción no se logre pagar
     * y el usuario presione el botón para retornar al comercio desde Flow.
     *
     * @return \Illuminate\View\View
     */
    public function fracaso()
    {
        // Lee los datos enviados por Flow
        Flow::read_result();

        // Recupera los datos enviados por Flow
        $orden = [
            'orden_compra'  => Flow::getOrderNumber(),
            'monto'         => Flow::getAmount(),
            'concepto'      => Flow::getConcept(),
            'email_pagador' => Flow::getPayer(),
            'flow_orden'    => Flow::getFlowNumber(),
        ];

        return view('flow.fracaso', $orden);
    }
…

View: resources/views/flow/fracaso.blade.php

@extends('layouts._master')

@section('content')
    <h1>Página de fracaso de comercio</h1>
    Su pago ha sido rechazado<br>
    <br>
    Orden de compra: {{ $orden_compra }}<br>
    Monto: {{ $monto }}<br>
    Descripción: {{ $concepto }}<br>
    Pagador: {{ $email_pagador }}<br>
    Flow orden n°: {{ $flow_orden }}<br>
    <br>
    <a href="{{ url('/') }}">Intente nuevamente</a>
@endsection

Página de confirmación

Controller: Http/Controllers/FlowController.php

/**
     * Página de confirmación del comercio
     *
     * @return void
     */
    public function confirmacion()
    {
        try {
            // Lee los datos enviados por Flow
            Flow::read_confirm();
        } catch (Exception $e) {
            // Si hay un error responde false
            echo Flow::build_response(false);
            return;
        }

        // Recupera los valores de la orden
        $flow_status  = Flow::getStatus();      // El resultado de la transacción (EXITO o FRACASO)
        $orden_numero = Flow::getOrderNumber(); // N° de orden del comercio
        $monto        = Flow::getAmount();      // Monto de la transacción
        $orden_flow   = Flow::getFlowNumber();  // Si $flow_status = 'EXITO' el n° de orden de Flow
        $pagador      = Flow::getPayer();       // El email del pagador

        /**
         * Aquí puede validar la orden
         *
         * Si acepta la orden responder Flow::build_response(true)
         * Si rechaza la orden responder Flow::build_response(false)
         */
        if ($flow_status == 'EXITO') {
            // La transacción fue aceptada por Flow
            // Aquí puede actualizar su información con los datos recibidos por Flow
            echo Flow::build_response(true); // Comercio acepta la transacción
        } else {
            // La transacción fue rechazada por Flow
            // Aquí puede actualizar su información con los datos recibidos por Flow
            echo Flow::build_response(false); // Comercio rechaza la transacción
        }
    }
…

Routes

Route::get('/', function () {
    return view('index');
});
Route::post('orden', 'FlowController@orden')->name('orden');

Route::post('flow/exito', 'FlowController@exito')->name('flow.exito');
Route::post('flow/fracaso', 'FlowController@fracaso')->name('flow.fracaso');
Route::post('flow/confirmacion', 'FlowController@confirmacion')->name('flow.confirmacion');
…

Licencia

Este paquete cuenta con licencia conforme a los términos de la Licencia MIT.