Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/freshworkstudio/transbank-web-services
DEPREACDO: Transbank Web Services SDK. Webpay OneClick, PatPass y Transacción Normal unsando SOAP
https://github.com/freshworkstudio/transbank-web-services
credit-card webpay webpay-oneclick webservice
Last synced: about 2 months ago
JSON representation
DEPREACDO: Transbank Web Services SDK. Webpay OneClick, PatPass y Transacción Normal unsando SOAP
- Host: GitHub
- URL: https://github.com/freshworkstudio/transbank-web-services
- Owner: freshworkstudio
- License: mit
- Created: 2016-06-24T00:54:04.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2021-10-29T20:29:06.000Z (almost 3 years ago)
- Last Synced: 2024-04-26T04:34:43.883Z (5 months ago)
- Topics: credit-card, webpay, webpay-oneclick, webservice
- Language: PHP
- Homepage:
- Size: 545 KB
- Stars: 107
- Watchers: 21
- Forks: 44
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# DEPRECADO:
Este SDK ya no tiene sentido, ya que Transbank lazó su nueva API REST y este SDk usa la antigua metodología REST.
Transbank ya no acepta integraciones SOAP, y felizmente, ahora estoy a cargo del SDK Oficial de TBK, así que les recomiendo utilizar ese SDK ahora: https://github.com/TransbankDevelopers/transbank-sdk-php
Pueden encontrar toda la documentación en transbankdevelopers.cl
# Transbank WebServices SDK
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](http://freshworkstudio.com) y [simplepay.cl](http://simplepay.cl). También incluye integración con Laravel.
*Leelo en inglés: [English](README.en.md)*
# Nuevo:
- En la versión `1.2.0` se incluye integración con Laravel
- Se creó un [**generador de certificados**](#generador-de-certificados) que usa las instrucciones oficiales, sin que tengas que correr los comandos en tu máquina.
# Se necesita ayuda:
- Este SDK no tiene soporte para el API REST de Webpay. Por falta de tiempo, no lo he podido hacer, pero si me quieres ayudar, deja un issue, o contactame de alguna forma :). Encantado de recibir apoyo.
# Índice
* [Instalación](#instalación)
* [Inicio rápido](#inicio-rápido)
* [Video Tutorial | Implementar Webpay Plus Normal](#video-tutorial--implementar-webpay-plus-normal)
* [Tienda de ejemplo usando Webpay OneClick y WebPay Plus](#tienda-de-ejemplo-webpay-oneclick)
* [Ejemplos](#ejemplos)
* [Implemetación de distintos servicios](#implemetación-de-distintos-servicios)
* [Webpay Plus Normal](#webpay-plus-normal)
* [Inicio de la transacción](#inicio-de-la-transacción)
* [Retorno a URL intermedia](#retorno-a-url-intermedia)
* [Retorno a URL final](#retorno-a-url-final)
* [Webpay Plus Captura Diferida](#webpay-plus-captura-diferida)
* [Inicio de la transacción diferida](#inicio-de-la-transacción-diferida)
* [Capturar monto total o parcial de la transacción](#capturar-monto-total-o-parcial-de-la-transacción)
* [Anulaciones](#anulaciones)
* [OneClick](#oneclick)
* [Inscripción del cliente](#inscripción-del-cliente)
* [Finalizar la inscripción](#finalizar-la-inscripción)
* [Realizar cargo a la tarjeta de crédito](#realizar-cargo-a-la-tarjeta-de-crédito)
* [Reversar un cargo](#reversar-un-cargo)
* [Desuscribir tarjeta](#desuscribir-tarjeta)
* [PatPass](#patpass)
* [init](#init)
* [response](#response)
* [Laravel](#laravel)
* [Logs](#logs)
* [CertificationBag](#certificationbag)
* [Pasar a producción](#pasar-a-producción)
* [Generador de certificados](#generador-de-certificados)
* [Datos de prueba](#datos-de-prueba)
* [Tarjeta de crédito VISA (Será aprobada)](#tarjeta-de-crédito-visa-será-aprobada)
* [Tarjeta de crédito MASTERCARD (Será rechazada)](#tarjeta-de-crédito-mastercard-será-rechazada)
* [Tarjeta de débito](#tarjeta-de-débito)
* [Credenciales del banco](#credenciales-del-banco)
* [Licencia](#licencia)
# Instalación
```bash
composer require freshwork/transbank
```
# Inicio rápido
### Video tutorial | Implementar Webpay Plus Normal
[](https://www.youtube.com/watch?v=VavxN-a9SIk)
[Ver screencast](https://www.youtube.com/watch?v=VavxN-a9SIk)
### Tienda de ejemplo Webpay OneClick y Webpay Plus
Tienda de prueba desarrollada en Laravel que ocupa Webpay OneClick y Webpay Plus.
[https://github.com/freshworkstudio/demo-store](https://github.com/freshworkstudio/demo-store)
# Ejemplos
En la carpeta `example` se encuentran algunos ejemplos de uso. Iremos sumando más con el tiempo
Para correr los ejemplos:
```php
git clone [email protected]:freshworkstudio/transbank-web-services.git
cd transbank-web-services/
php -S localhost:8888 -t examples
```
Ahora solo debes abrir tu navegador web en http://localhost:8888/
# Implemetación de distintos servicios
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
# Credenciales
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
## Webpay Plus Normal
Transacción normal con Webpay. (Pago tarjeta de crédito y débito)
### Inicio de la transacción
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
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);
```
### Retorno a URL intermedia
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
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);
```
### Retorno a URL final
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.
## Webpay Plus Captura diferida
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.
### Inicio de la transacción diferida
Para iniciar una transacción de captura diferida se utiliza el mismo flujo de [Webpay Plus Normal](#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
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](#webpay-plus-normal), es decir, [retornamos a URL intermedia](#retorno-a-url-intermedia) y luego [retornamos a URL final](#retorno-a-url-final).
### Capturar monto total o parcial de la transacción
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
capture($authCode, 'Orden824201', 5000); // Código de autorización, identificador de la orden y monto
```
## Anulaciones
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
nullify($authCode, $authorizedAmount, 'Orden824201', 2000); // Solo se anularán $2.000 y quedará un balance de $8.000
```
## OneClick
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.
### Inscripción del cliente
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
initInscription('username', '[email protected]', 'http://misitio.cl/webpayresponse');
// Utilidad para generar formulario y realizar redirección POST
echo RedirectorHelper::redirectHTML($response->urlWebpay, $response->token);
```
### Finalizar la inscripción
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
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.
### Realizar cargo a la tarjeta de crédito
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
tbkToken;
try {
$response = $oneClick->authorize(1000, $buyOrder, 'username', $authToken);
} catch (\Exception $e) {
// No se pudo realizar el cargo
}
var_dump($response);
```
### Reversar un cargo
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
codeReverseOneClick('20110715115550003');
$response = $oneClick->codeReverseOneClick($buyOrder);
```
### Desuscribir tarjeta
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
removeUser($userToken, $username);
```
## PatPass
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` .
### init
```php
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', '[email protected]',
'987654321', '2017-12-01', '[email protected]');
$response = $patpass->init('http://test.dev/response', 'http://test.dev/thanks');
echo RedirectorHelper::redirectHTML($response->url, $response->token);
```
### response
```php
$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);
```
# Laravel
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.
## Instalación
### Laravel > 5.5
Si usas Laravel 5.5 o superior, no debes hacer nada. El Service Provider se incluye automáticamente usando Auto-Discovery de Laravel.
### Si usas Laravel < 5.5
Debes agregar este Service Provider en el array de `$providers` en `config/app.php`
```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"`
## Usando en Laravel
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`) .
```php
// 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');
```
```php
// 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
}
}
```
```php
// app\Http\Middleware\VerifyCsrfToken.php
'más datos', 'otros_datos']);
```
# CertificationBag
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
setEnvironment(CertificationBag::INTEGRATION);
$oneClickService = new WebpayOneClickWebService($bag);
```
# Pasar a producción
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](https://transbankdevelopers.cl/documentacion/como_empezar#credenciales-en-webpay)
## Generador de certificados
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/](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)
```php
//Eliminar esta
$bag = CertificationBagFactory::integrationWebpayNormal();
...
```
Y reemplazarla por esta:
```php
//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.
# Datos de prueba
Estos son los datos de tarjetas para que puedas probar en el ambiente de integración.
##### TARJETA DE CRÉDITO VISA (SERÁ APROBADA)
> **Número:** 4051885600446623
> **CVV:** 123
> **Fecha de expiración:** cualquiera
##### TARJETA DE CRÉDITO MASTERCARD (SERÁ RECHAZADA)
> **Número:** 5186059559590568
> **CVV:** 123
> **Fecha de expiración:** cualquiera
##### TARJETA DE DÉBITO
> **Número**: cualquiera
#### CREDENCIALES DEL BANCO
> **RUT:** 11.111.111-1
> **Contraseña:** 123
Biblioteca desarrollada por [Simplepay](https://simplepay.cl)
Powered by [Freshwork Studio](https://freshworkstudio.com)
---
# Licencia y Postalware
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,