Librería para la integración de Webpay Plus, Webpay OneClick y Webpay Patpass. Esta librería es mantenida por Gonzalo De Spirito de freshworkstudio.com y simplepay.cl. También incluye integración con Laravel.
Leelo en inglés: English
- En la versión
1.2.0se incluye integración con Laravel - Se creó un generador de certificados que usa las instrucciones oficiales, sin que tengas que correr los comandos en tu máquina.
- Instalación
- Inicio rápido
- Ejemplos
- Implemetación de distintos servicios
- Laravel
- Logs
- CertificationBag
- Pasar a producción
- Datos de prueba
- Licencia
composer require freshwork/transbank 
Tienda de prueba desarrollada en Laravel que ocupa Webpay OneClick y Webpay Plus.
https://github.com/freshworkstudio/demo-store
En la carpeta example se encuentran algunos ejemplos de uso. Iremos sumando más con el tiempo
Para correr los ejemplos:
git clone git@github.com:freshworkstudio/transbank-web-services.git
cd transbank-web-services/
php -S localhost:8888 -t examplesAhora solo debes abrir tu navegador web en http://localhost:8888/
Transbank cuenta con distintos productos para implementar pagos en comercios y otras aplicaciones.
En esta documentación podrás encontrar detalles sobre:
- Webservices Webpay Plus con Autorización y Captura Simultánea (Normal)
- Webservices Webpay Plus con Autorización y Captura diferida
- Webpay OneClick
- PatPass
Las credenciales (certificados) para los ambientes de integración se encuentran incluidos en esta librería para simplificar su implementación. Se actualiza constantemente con el repositorio oficial que mantiene esta información: https://github.com/TransbankDevelopers/transbank-webpay-credenciales
Transacción normal con Webpay. (Pago tarjeta de crédito y débito)
Para comenzar con el flujo de pago, debes informar a Transbank cuanto y qué pagará tu cliente, así como también la URL de retorno intermedia que se utilizará para que puedas validar que el pago se hizo correctamente y la URL final, que se utilizará para que puedas mostrar los detalles del pago y orden.
Luego de informarle a Transbank de esta transacción, te entregará un TOKEN y una URL. Con estos datos deberás redireccionar al usuario a dicha URL (Webpay) a través de una petición HTTP POST (Es obligación que sea a través de POST) lo cual puedes hacer a través de un formulario HTML.
<?php
use Freshwork\Transbank\CertificationBagFactory;
use Freshwork\Transbank\TransbankServiceFactory;
use Freshwork\Transbank\RedirectorHelper;
include 'vendor/autoload.php';
// Obtenemos los certificados y llaves para utilizar el ambiente de integración de Webpay Normal.
$bag = CertificationBagFactory::integrationWebpayNormal();
$plus = TransbankServiceFactory::normal($bag);
// Para transacciones normales, solo puedes añadir una linea de detalle de transacción.
$plus->addTransactionDetail(10000, 'Orden824201'); // Monto e identificador de la orden
// Debes además, registrar las URLs a las cuales volverá el cliente durante y después del flujo de Webpay
$response = $plus->initTransaction('http://test.dev/response', 'http://test.dev/thanks');
// Utilidad para generar formulario y realizar redirección POST
echo RedirectorHelper::redirectHTML($response->url, $response->token); Luego de que el usuario haya pagado, Webpay redireccionará al cliente a tu página brevemente, para que tu puedas validar la transacción.
Para ello, te enviará un TOKEN en el cuerpo de una petición HTTP POST, bajo la llave token_ws ($_POST['token_ws']), sin embargo no deberás preocuparte de esto, ya que el método getTransactionResult se encarga internamente de capturar este valor.
Al ejecutar dicho método (getTransactionResult) pediremos a Transbank información sobre el pago y su estado. Deberemos comprobar este último y además validar que la orden no haya sido pagada anteriormente.
Si todo ha funcionado correctamente, deberás hacerle saber a Transbank que has comprobado la Transacción (o de lo contrario se reversará el pago) haciendo uso de acknowledgeTransaction y luego redireccionar al cliente nuevamente a Webpay de la misma forma anterior, para que este pueda recibir su voucher.
<?php
use Freshwork\Transbank\CertificationBagFactory;
use Freshwork\Transbank\TransbankServiceFactory;
use Freshwork\Transbank\RedirectorHelper;
include 'vendor/autoload.php';
$bag = CertificationBagFactory::integrationWebpayNormal();
$plus = TransbankServiceFactory::normal($bag);
$response = $plus->getTransactionResult();
// Comprueba que el pago se haya efectuado correctamente
if (
$response->detailOutput->responseCode == 0
/* Comprueba que la orden no haya sido pagada */
) {
$plus->acknowledgeTransaction();
}
// Redirecciona al cliente a Webpay para recibir el Voucher
return RedirectorHelper::redirectBackNormal($response->urlRedirection); En esta página deberás mostrar la mayor cantidad de información que fue obtenida en el paso anterior al invocar getTransactionResult y además detalles de la orden.
En esta modalidad, se retiene el valor de la compra del saldo de la tarjeta de crédito del cliente, reservando cupo pero sin realizar la transacción definitivamente hasta que el comercio confirma la compra (vía captura diferida) y lo comunique a Transbank.
Para iniciar una transacción de captura diferida se utiliza el mismo flujo de Webpay Plus Normal, sin embargo, los certificacdos son los que informan a Transbank que se iniciará una transacción con captura diferida, por tanto varia únicamente en estos.
<?php
use Freshwork\Transbank\CertificationBagFactory;
use Freshwork\Transbank\TransbankServiceFactory;
use Freshwork\Transbank\RedirectorHelper;
include 'vendor/autoload.php';
// Obtenemos los certificados y llaves para utilizar el ambiente de integración de Webpay Diferido
$bag = CertificationBagFactory::integrationWebpayDeferred();
$plus = TransbankServiceFactory::deferred($bag);
// Para transacciones normales, solo puedes añadir una linea de detalle de transacción.
$plus->addTransactionDetail(10000, 'Orden824201'); // Monto e identificador de la orden
// Debes además, registrar las URLs a las cuales volverá el cliente durante y después del flujo de Webpay
$response = $plus->initTransaction('http://test.dev/response', 'http://test.dev/thanks');
// Utilidad para generar formulario y realizar redirección POST
echo RedirectorHelper::redirectHTML($response->url, $response->token); Los siguientes pasos son tal cual Webpay Plus Normal, es decir, retornamos a URL intermedia y luego retornamos a URL final.
Luego de terminar el flujo inicial, tendremos 7 días calendario máximos para realizar la captura, ya que superado ese tiempo la retención de la tarjeta de crédito será reversada y el cupo liberado.
Podemos capturar el monto total o parcial retenido, y para ello deberemos especificar el código de autorización entregado durante el flujo inicial y además el identificador de la orden.
<?php
use Freshwork\Transbank\CertificationBagFactory;
use Freshwork\Transbank\TransbankServiceFactory;
include 'vendor/autoload.php';
// Obtenemos los certificados y llaves para utilizar el ambiente de integración de Webpay Diferido
$bag = CertificationBagFactory::integrationWebpayDeferred();
$plus = TransbankServiceFactory::captureNullify($bag);
$authCode = 'this-auth-code-is-an-example';
// Puedes capturar el monto total o parcial
$plus->capture($authCode, 'Orden824201', 5000); // Código de autorización, identificador de la orden y monto Solo las transacciones Webpay (Normal o Captura diferida) realizadas con tarjeta de crédito pueden ser anuladas mediante servicios web.
Las anulaciones pueden ser totales o parciales y estas últimas, solo están permitidas en la modalidad de Venta Normal (VN).
Para realizar una anulación necesitaremos conocer el monto autorizado previamente, el código de autorización y el identificador de la orden.
<?php
use Freshwork\Transbank\CertificationBagFactory;
use Freshwork\Transbank\TransbankServiceFactory;
include 'vendor/autoload.php';
// Obtenemos los certificados y llaves para utilizar el ambiente de integración de Webpay Normal
$bag = CertificationBagFactory::normal();
$plus = TransbankServiceFactory::captureNullify($bag);
$authorizedAmount = '10000';
$authCode = 'this-auth-code-is-an-example';
// Puedes capturar el monto total o parcial
$plus->nullify($authCode, $authorizedAmount, 'Orden824201', 2000); // Solo se anularán $2.000 y quedará un balance de $8.000 Permite al tarjetahabiente realizar pagos en el comercio sin la necesidad de ingresar cada vez información de la tarjeta de crédito al momento de realizar la compra.
Para poder hacer uso de OneClick, el usuario debe inscribir su tarjeta de crédito y para ello, se le informará a Transbank el nombre de usuario (o identificador único) del cliente, su correo electrónico y además una URL de retorno (a la cual volverá el usuario luego de finalizar su inscripción) usando el método initInscription y este devolverá un TOKEN y una URL.
El usuario deberá ser redireccionado a dicha URL usando una petición HTTP POST, usando como dato el token que se nos proporcionó.
<?php
use Freshwork\Transbank\CertificationBagFactory;
use Freshwork\Transbank\TransbankServiceFactory;
use Freshwork\Transbank\RedirectorHelper;
include 'vendor/autoload.php';
// Obtenemos los certificados y llaves para utilizar el ambiente de integración de Webpay OneClick.
$certificationBag = CertificationBagFactory::integrationOneClick();
$oneClick = TransbankServiceFactory::oneclick($certificationBag);
// Informamos a Transbank que se iniciará un proceso de inscripción para un usuario
$response = $oneClick->initInscription('username', 'user@company.cl', 'http://misitio.cl/webpayresponse');
// Utilidad para generar formulario y realizar redirección POST
echo RedirectorHelper::redirectHTML($response->urlWebpay, $response->token);
El usuario, tras finalizar el proceso en Webpay, será redireccionado a la URL de retorno que informamos anteriormente.
En dicha redirección se te enviará un TOKEN en el cuerpo de una petición HTTP POST (redirección), bajo la llave TBK_TOKEN ($_POST['TBK_TOKEN']), sin embargo no deberás preocuparte de esto, ya que el método finishInscription se encarga internamente de capturar este valor.
Con este método (finishInscription) pediremos a Transbank información sobre la inscripción y el identificador del usuario para realizar los cobros posteriores, pero también deberemos validar si la inscripción se hizo de forma éxitosa.
<?php
use Freshwork\Transbank\CertificationBagFactory;
use Freshwork\Transbank\TransbankServiceFactory;
include 'vendor/autoload.php';
// Obtenemos los certificados y llaves para utilizar el ambiente de integración de Webpay OneClick.
$certificationBag = CertificationBagFactory::integrationOneClick();
$oneClick = TransbankServiceFactory::oneclick($certificationBag);
$response = $oneClick->finishInscription($token);
if($response->responseCode == 0)
// Inscripción exitosa
}
var_dump($response); 
Es de suma importancia que asocies el token provisto por Transbank (tbkUser) a tu cliente, porque este servirá para realizar los cobros posteriores.
Para realizar un cargo a la tarjeta de crédito previamente inscrita, deberás hacer uso del método autorize con el token asociado a tu cliente provisto por Tranbank en el paso anterior, el nombre de usuario o identificador único de tu cliente, monto y número de orden (en un formato especial).
<?php
use Freshwork\Transbank\CertificationBagFactory;
use Freshwork\Transbank\TransbankServiceFactory;
include 'vendor/autoload.php';
// Obtenemos los certificados y llaves para utilizar el ambiente de integración de Webpay OneClick.
$certificationBag = CertificationBagFactory::integrationOneClick();
$oneClick = TransbankServiceFactory::oneclick($certificationBag);
// Identificador único de la compra generado por el comercio. Debe ser timestamp [yyyymmddhhMMss] + un correlativo de tres dígitos.
// Ej: Para la tercera transacción realizada el día 15 de julio de 2011 a las 11:55:50 la orden de compra sería: 20110715115550003.
$buyOrder = date('ymdhis') . str_pad(1, 3, '0', STR_PAD_LEFT);
// Token provisto por Transbank para identificar a tu cliente
$authToken = '9bf43307-6fa0-4b3b-888d-f36b6d040162'; //$user->tbkToken;
try {
$response = $oneClick->authorize(1000, $buyOrder, 'username', $authToken);
} catch (\Exception $e) {
// No se pudo realizar el cargo
}
var_dump($response); 
En ciertos casos, vamos a necesitar reversar un cargo y para ello deberemos utilizar el método codeReverseOneClick junto con el número de la orden.
<?php
use Freshwork\Transbank\CertificationBagFactory;
use Freshwork\Transbank\TransbankServiceFactory;
include 'vendor/autoload.php';
// Obtenemos los certificados y llaves para utilizar el ambiente de integración de Webpay OneClick.
$certificationBag = CertificationBagFactory::integrationOneClick();
$oneClick = TransbankServiceFactory::oneclick($certificationBag);
// Ej: $response = $oneClick->codeReverseOneClick('20110715115550003');
$response = $oneClick->codeReverseOneClick($buyOrder); Si tu cliente desea desuscribir su tarjeta, deberás informar a Transbank haciendo uso del método removeUser con el token asociado a él y su nombre de usuario o identificador único.
<?php
use Freshwork\Transbank\CertificationBagFactory;
use Freshwork\Transbank\TransbankServiceFactory;
include 'vendor/autoload.php';
// Obtenemos los certificados y llaves para utilizar el ambiente de integración de Webpay OneClick.
$certificationBag = CertificationBagFactory::integrationOneClick();
$oneClick = TransbankServiceFactory::oneclick($certificationBag);
$response = $oneClick->removeUser($userToken, $username); Una transacción de autorización de PatPass por Webpay, corresponde a una solicitud de inscripción de pago recurrente con tarjetas de crédito en donde el primer pago se resuelve al instante, y los subsiguientes quedan programados para ser ejecutados mes a mes. PatPass cuenta con fecha de caducidad o termino, la cual debe ser proporcionada junto a otros datos para esta transacción. La transacción puede ser realizada en Dólares y Pesos, para este último caso es posible enviar el monto en UF y Webpay realizará la conversión a pesos al momento de realizar el cargo al tarjetahabiente.
El proceso de Patpass es el mismo que en una transacción Normal o Mall, pero aca se debe completar la información de la inscripción addInscriptionInfo antes de llamar al método init
Notar que esta clase se recomienda el uso del metodo init y no initInscription .
<?php
use Freshwork\Transbank\CertificationBagFactory;
use Freshwork\Transbank\TransbankServiceFactory;
use Freshwork\Transbank\RedirectorHelper;
include 'vendor/autoload.php';
$bag = CertificationBagFactory::integrationPatPass();
$patpass = TransbankServiceFactory::patpass($bag);
$patpass->addTransactionDetail(1000, '50'); //Amount & BuyOrder
//Id del servicio a contratar, Rut cliente, Nombre, Apellido, Segundo apellido, Email cliente, Celular Cliente, Fecha termino contrato, Email comercio
$patpass->addInscriptionInfo('serviceID', '11.111.111-5', 'Gonzalo', 'De Spirito', 'Zúñiga', 'gonzalo@email.com',
'987654321', '2017-12-01', 'contacto@comercio.cl');
$response = $patpass->init('http://test.dev/response', 'http://test.dev/thanks');
echo RedirectorHelper::redirectHTML($response->url, $response->token);
$response = $patpass->getTransactionResult();
//If everything goes well (check stock, check amount, etc) you can call acknowledgeTransaction to accept the payment. Otherwise, the transaction is reverted in 30 seconds.
//Si todo está bien, peudes llamar a acknowledgeTransaction. Si no se llama a este método, la transaccion se reversará en 30 segundos.
$plus->acknowledgeTransaction();
//Redirect back to Webpay Flow and then to the thanks page
return RedirectorHelper::redirectBackNormal($response->urlRedirection); Si estás usando laravel para integrar esta librería, te alegará saber que incluimos un ServiceProvider para que tu integración sea más simple y ordenada.
Si usas Laravel 5.5 o superior, no debes hacer nada. El Service Provider se incluye automáticamente usando Auto-Discovery de Laravel.
Debes agregar este Service Provider en el array de $providers en config/app.php
$providers = [
...
\Freshwork\Transbank\Laravel\WebpayServiceProvider::class
]Opcionalmente, puedes crear el archivo de configuración config/webpay.php usando este comando:
php artisan vendor:publish --provider=\Freshwork\Transbank\Laravel\WebpayServiceProvider
La gracia de esta integración, en que puedes usar los servicios (webpay normal, patpass, one click, etc) usando el sistema de dependencias de Laravel.
Por ejemplo, en el método de un controller, solo es necesario agregar el servicio (ej: WebpayNormal) y el service provider se encarga de crear el CertificationBag (de integración si el ambiente de laravel es local o los certificados de producción si el ambiente es production) .
// routes/web.php
Route::get('/checkout', 'CheckoutController@initTransaction')->name('checkout');
Route::post('/checkout/webpay/response', 'CheckoutController@response')->name('checkout.webpay.response');
Route::post('/checkout/webpay/finish', 'CheckoutController@finish')->name('checkout.webpay.finish');// app\Http\Controllers\CheckoutController.php
namespace App\Http\Controllers;
use Freshwork\Transbank\WebpayNormal;
class CheckoutController extends Controller
{
public function initTransaction(WebpayNormal $webpayNormal)
{
$webpayNormal->addTransactionDetail(1500, 'order-' . rand(1000, 9999));
$response = $webpayNormal->initTransaction(route('checkout.webpay.response'), route('checkout.webpay.finish'));
// Probablemente también quieras crear una orden o transacción en tu base de datos y guardar el token ahí.
return RedirectorHelper::redirectHTML($response->url, $response->token);
}
public function response(WebpayPatPass $webpayPatPass)
{
$result = $webpayPatPass->getTransactionResult();
session(['response' => $result]);
// Revisar si la transacción fue exitosa ($result->detailOutput->responseCode === 0) o fallida para guardar ese resultado en tu base de datos.
return RedirectorHelper::redirectBackNormal($result->urlRedirection);
}
public function finish()
{
dd($_POST, session('response'));
// Acá buscar la transacción en tu base de datos y ver si fue exitosa o fallida, para mostrar el mensaje de gracias o de error según corresponda
}
}// app\Http\Middleware\VerifyCsrfToken.php
<?php
namespace App\Http\Middleware;
use Illuminate\Foundation\Http\Middleware\VerifyCsrfToken as Middleware;
class VerifyCsrfToken extends Middleware
{
/**
* Indicates whether the XSRF-TOKEN cookie should be set on the response. * * @var bool
*/ protected $addHttpCookie = true;
/**
* The URIs that should be excluded from CSRF verification. * * @var array
*/ protected $except = [
'/checkout/webpay/response', //Agregar esta línea. Cambiar a tu ruta
'/checkout/webpay/finish', //Agregar esta línea. Cambiar a tu ruta
];}Para pasar a producción, se debe cambiar el APP_ENV=production en el .env o crear un TBK_ENV=production.
Si TBK_ENV no existe, se usará APP_ENV
Por defecto, el sistema buscará los certificados de producción en la carpeta: storage/app/certs/
Webpay Normal
Llave privada: storage/app/certs/normal/client.key
Certificado: storage/app/certs/normal/client.crt
Webpay OneClick
Llave privada: storage/app/certs/oneclick/client.key
Certificado: storage/app/certs/oneclick/client.crt
Webpay PatPass
Llave privada: storage/app/certs/patpass/client.key
Certificado: storage/app/certs/patpass/client.crt
Webpay Captura Diferida
Llave privada: storage/app/certs/deferred/client.key
Certificado: storage/app/certs/deferred/client.crt
Para el proceso de certificación con Transbank, muchas veces se solicitan los registros de las transacciones realizadas y esta biblioteca provee una utilidad para facilitar dicho proceso.
Haciendo uso de TransbankCertificationLogger debes especificar la ruta donde almacenar dichos registros y establecer su instancia en LoggerFactory
Otra opción es crear tu propia implementación haciendo uso de la interfaz LoggerInterface.
<?php
use Freshwork\Transbank\Log\LoggerFactory;
use Freshwork\Transbank\Log\TransbankCertificationLogger;
include 'vendor/autoload.php';
LoggerFactory::setLogger(new TransbankCertificationLogger('/dir/to/save/logs'));
// ...
Internamente se generan varios registros, entre ellos:
-
Los datos de entrada al llamar a un método de SOAP
-
El XML generado y firmado
-
El XML recibido
-
El objeto recibido
-
Errores como por ejemplo, la falla de validación del certificado.
Si necesitas logear más información, puedes usar:
LogHandler::log($data, $level = LoggerInterface::LEVEL_INFO, $type = null)
<?php
use Freshwork\Transbank\Log\LogHandler;
use Freshwork\Transbank\Log\LoggerInterface;
LogHandler::log('Comenzando proceso de pago', LoggerInterface::LEVEL_INFO);
LogHandler::log('Error!!', LoggerInterface::LEVEL_ERROR, 'mensajes_internos');
LogHandler::log(['datos' => 'más datos', 'otros_datos']); Es una clase utilizada envolver certificados y llaves privadas con la finalidad de facilitar el manejo de los mismos a través de la biblioteca.
Es obligatorio y necesario el uso de CertificationBag ya que contiene todos los datos necesarios para cifrar la comunicación con Transbank y validar las respuestas de este.
<?php
use Freshwork\Transbank\CertificationBag;
use Freshwork\Transbank\CertificationBagFactory;
// Integración / Desarrollo
$bag = new CertificationBag(
'path/to/cert/597020000000.key',
'path/to/cert/597020000000.crt',
null,
CertificationBag::INTEGRATION
);
// Producción
$bag = new CertificationBag(
'path/to/cert/597020000001.key',
'path/to/cert/597020000001.crt',
null,
CertificationBag::PRODUCTION
);
//También se puede crear usando la clase CertificationBagFactory, que permite crear instancias de CertificationBag de manera más simple
CertificationBagFactory::production('path/to/cert/597020000001.key', 'path/to/cert/597020000001.crt');
//O si queremos crear un certification bag que venga con los certificados de integración para webpaynormal
CertificationBagFactory::integrationWebpayNormal();
Teniendo una CertificationBag, se puede crear una instancia de los servicios de Webpay, por ejemplo: WebpayOneClickWebService
<?php
use Freshwork\Transbank\CertificationBag;
use Freshwork\Transbank\WebpayOneClickWebService;
$bag = new CertificationBag(
'/path/to/597020000000.key',
'/path/to/597020000000.crt'
);
$bag->setEnvironment(CertificationBag::INTEGRATION);
$oneClickService = new WebpayOneClickWebService($bag); Para pasar a producción, es importante destacar que Transbank solicitará crear un par de llaves (privada y pública) utilizando el código de comercio como Common Name (CN).
Transbank te enviará las instrucciones para que generes este certificado, una vez que hayas pasado el proceso de certificación, aunque las puedes encontrar acá: https://transbankdevelopers.cl/documentacion/como_empezar#credenciales-en-webpay
Para realizar este proceso de manera más simple, creé una app web que te permite crear tus certificados de producción en un simple formulario. Puedes ingresar acá: https://certificados.digitalpartner.cl/
Una vez que les envíes los certificados que generaste, debes esperar a que te confirmen que efectivamente los cargaron en sus servidores.
Finalmente, tras recibir esta confirmación, ya puedes usar tu implementación en modo producción (con dinero real). En el código de tu proyecto, el único cambio que debes realizar es el cambio de los certificados del CertificationBag.
Ejemplo: Si estás implementando Webpay Normal, debes eliminar esta línea ( o la que estés usando para crear el CertificationBag)
//Eliminar esta
$bag = CertificationBagFactory::integrationWebpayNormal();
... Y reemplazarla por esta:
//Reemplazar por esta
$bag = CertificationBagFactory::production('tu/llave/privada.key', 'path/a/tu/ceriticado_publico.crt');
... Lo importante es solo cambiar el CertificationBag que usas, en vez de usar el de integración, debes crear uno para el ambiente de producción.
Estos son los datos de tarjetas para que puedas probar en el ambiente de integración.
Número: 4051885600446623
CVV: 123
Fecha de expiración: cualquiera
Número: 5186059559590568
CVV: 123
Fecha de expiración: cualquiera
Número: cualquiera
RUT: 11.111.111-1
Contraseña: 123
Biblioteca desarrollada por Simplepay
Powered by Freshwork Studio
Puedes usar este paquete gratuitamente sin ninguna restricción, aunque como está de moda, implementamos una licencia 'Postalware'. Si usas este paquete en producción y te gusta como funciona, Agradeceríamos bastante si nos envías una postal de tu ciudad/comuna, una nota de agradecimiento o un súper8.
Dirección
Nombre: Gonzalo De Spirito
General Bustamante 24. Oficina N, Providencia.
Chile,