VTOL Payment Bridge

Manual de Integración

Cambios por revisiones

Índice

1. Introducción

1.1 Acerca de este documento

El presente documento explica la forma en la que un e-commerce se puede integrar con VTOL Payment Bridge, para autorizar pagos a través de Internet.

1.2 ¿Qué es VTOL Payment Bridge?

Es un componente Web que permite a un sitio de eCommerce autorizar, a través de VTOL Server, los pagos de compras realizadas en Internet.

Cuando el cliente del eCommerce quiere pagar su compra con tarjeta, se hace una redirección segura hacia VTOL Payment Bridge, quién solicita los datos para efectuar el pago.

A continuación se muestra una imagen del formulario que solicita los datos para efectuar el pago con tarjeta.

Formulario de pago de VTOL Payment Bridge

Además, el formulario de VTOL Payment Bridge permitirá ingresar datos adicionales del titular de la tarjeta, como ser Fecha de nacimiento, Tipo y Número de Documento, y Dirección. Estos datos podrán ser enviados por el eCommerce a VPB en el mensaje de autorización de pago, o que VPB se los solicite al usuario en el formulario de ingreso de datos. Se mostrará una imagen como la siguiente:

Formulario de VPB con datos adicionales del tarjeta habiente

1.3 Ventajas

Algunas de las ventajas de usar VTOL Payment Bridge son:

1. Velocidad de integración con VTOL
2. Evitar implementar un formulario de ingreso de datos de tarjetas y sus correspondientes validaciones
3. Cumplir con las normas PCI ya que el e-commerce no tiene conocimiento de los datos sensibles de la tarjeta
4. Simplificar la conciliación con VTOL

1.4 Arquitectura

Como se observa en la figura, VPB recibe la petición de autorización del browser del cliente, con los datos de venta del e-commerce. Entre esos datos viaja el identificador de transacción generado por el e-commerce (transactionId).
VPB por su parte despliega una ventana segura para cargar los datos de la tarjeta. Una vez completados los datos, autoriza la transacción contra VTOL Server y responde a una dirección de callback, incluyendo el transactionId enviado en el requerimiento de autorización.
El e-commerce es quien posteriormente debe realizar la consulta del estado de la transacción pasando como parámetro su identificador en una invocación GET a VPB.
Por último y una vez que finalizó la operación con el cliente, el e-commerce realiza una invocación POST a VPB indicando la confirmación o cancelación de la transacción. VPB al recibir el requerimiento de confirmación o cancelación, envía un Commit o Rollback a VTOL Server.

1.5 Alcance

1.5.1 VTOL Payment Bridge

1. Proveer un marco de intercambio de información seguro para evitar ataques y fraudes. Utilización de protocolo https.
2. Autorizar mediante VTOL Server las transacciones de pago con tarjeta en Internet.
3. Facilitar los datos de transacciones autorizadas.
4. Brindar un mecanismo de conciliación entre el e-commerce y VTOL Server.

1.5.2 E-Commerce

1. Utilización de protocolo seguro https.
2. Consultar a VPB el estado y datos de la transacción autorizada.
3. Indicar a VPB si debe confirmar o cancelar la transacción.
4. Brindar a VPB información sobre confirmación o cancelación de una transacción cuando este lo requiera, mediante una invocación GET.

1.6 Alta disponibilidad

La versión actual de VTOL Payment Bridge no soporta alta disponibilidad. Es decir, que la aplicación actualmente está construida para trabajar como un nodo único.

2. Integración

En esta sección se detalla la manera de integrar el e-commerce con VTOL Payment Bridge.

2.1 Servicios brindados por VPB

VTOL Payment Bridge brinda los siguientes servicios:

2.1.1 Transacción en 1 fase (Venta)

VTOL Payment Bridge ofrece la posibilidad de realizar una transacción en una sola fase, llamada Venta (cargo). Directamente se realiza la transacción financiera. En esta modalidad VPB autoriza, verifica y captura todo de una vez.

2.1.1.1 Solicitud de Pago

Servicio: /authorizeForm

Para realizar una solicitud de Pago, se debe invocar un método POST al endpoint de VPB, enviando el atributo transactionType=sale.

Invocación:

En la invocación POST se envían los siguientes parámetros con los datos de la venta:

* Campos Condicionales:

Si additionalPayerData=False, entonces el eCommerce debe enviar obligatoriamente los siguientes campos:

• identificationType
• identificationNumber
• birthdate
• streetName
• streetNumber

Si additionalPayerData=True, entonces VPB deberá solicitar obligatoriamente los siguientes campos en el formulario:

• identificationType
• identificationNumber
• birthdate
• streetName
• streetNumber

Ejemplo:

{
   "ecommerce": {
      "company": "1",
      "store": "1"
   },
   "transactionType": "sale",
   "autoCommit": false,
   "additionalCardHolder": false,
   "transactionId": 1569441914224,
   "orderDescription": "El total de su compra es de $110.99. Ha elegido pagar en Pesos Argentinos (ARS)",
   "amount": "110.90",
   "currency": "$",
   "interestAmount": "0",
   "userId": "",
   "posTicket": "",
   "ecommerceCustomField": "",
   "cardHolder": {
      "identificationType": "1",
      "identificationNumber": "32058821",
      "birthdate": "22/07/1986",
      "phone": "3425340300",
      "deliveryAddress": {
         "streetName": "25 de mayo",
         "streetNumber": "3587",
         "complement": "2B",
         "zipCode": "3000"
      }
   },
   "url": {
      "callbackUrlError": "https://localhost:8843/emulatorEcommerce/callbackErrorURL.jsp",
      "callbackUrlSuccessful": "https://localhost:8843/emulatorEcommerce/callbackOKURL.jsp",
      "callbackUrlCancel": "https://localhost:8843/emulatorEcommerce/callBackCancel.jsp",
      "checkTransactionStatus": "http://localhost:8280/emulatorEcommerce/service/checkStatusReturnRandom.html"
   },
   "formData": {
      "merchantName": "My Company",
      "merchantImageURL": "https://ip/image.png"
   },
   "paymentData": {
      "payments": "1",
      "plan": "0"
   },
   "cardValidation": {
      "brand": "VISA",
      "provider": "VI",
      "bank": "BANCO GALICIA"
   },
   "customerData": {
      "customerId": "100",
      "customerIP": "10.90.100.101",
      "customerName": "Juan Carlos",
      "customerLastName": "Rodriguez",
      "customerIdentificationType": "1",
      "customerIdentificationNumber": "32123456"
   }
}

Respuesta:

La respuesta se realiza en la dirección de callback especificada por el eCommerce.

Se responden los siguientes campos:

Ejemplo de respuesta:

{
   "transactionType": "Sale",
   "ecommerce": {
      "company": "C1",
      "store": "1"
   },
   "transactionId": "1580408171332",
   "responseCode": "00",
   "status": "Pending"
}

2.1.1.2 Consultar Estado de Transacción

Servicio: /checkTransactionStatus

VPB permite consultar el estado y los datos de una operación, a través de una invocación GET a la URL de VPB.

Invocación:

En la invocación GET se envían los siguientes parámetros de la operación:

Los campos se envían en formato json "Nombre del campo":"valor"

Ejemplo:

{
   "transactionId": "1580409092436",
   "ecommerce": {
      "company": "C1",
      "store": "1"
   }
}

Respuesta:

La respuesta retorna los siguientes campos:

Los campos se responden en formato json "Nombre del campo":"valor"

Ejemplo de respuesta:

{ 
   "amount":"100.00",
   "providerCode":"Visa",
   "ticket":"4",
   "authorizationCode":"123456",
   "store":"1",
   "transactionDate":"2020-01-30 15:31:57.417",
   "authorizationStatus":"Pending",
   "responseCode":"00",
   "node":"0000000001",
   "displayMessage":"esta es una prueba de impresion",
   "currency":"$",
   "company":"C1",
   "id":114,
   "responseMessage":"APROBADA",
   "vtolTrxId":"30012015321300000110"
}

2.1.1.3 Cierre de Transacción

Servicio: /closeTransaction

VPB permite cerrar la transacción para confirmarla o cancelarla, a través de un método POST a la URL de VPB.

Invocación:

En la invocación POST se envían los siguientes parámetros de la operación:

Los campos se envían en formato json "Nombre del campo":"valor"

Ejemplo:

{
   "transactionId": "1580408171332",
   "ecommerce": {
      "company": "C1",
      "store": "1"
   },
   "action": "commit"
}

Respuesta:

La respuesta sólo retorna un código HTTP 200.

2.1.2 Transacción en 2 fases (Autorización y Captura)

VTOL Payment Bridge ofrece la posibilidad de realizar transacciones en dos pasos, primero se realiza una autorización, y luego se genera la captura. Son operaciones llamadas de dos fases.

La autorización es una reserva de fondos en la tarjeta del comprador. Esto significa que al realizar la misma, todavía no se generó un cobro al cliente en su tarjeta. Nunca aparece en el resumen de cuenta del tarjeta habiente. Solo cuando se realice una captura el cliente verá el pago.

2.1.2.1 Autorización de Pago

Servicio: /authorizeForm

El pedido de autorización es un servicio que valida la información de la tarjeta que se envía, para verificar si se puede continuar con el proceso de pago y reservar los fondos del tarjeta habiente.

Para realizar una autorización, se debe invocar un método POST a la URL de VPB, enviando el atributo transactionType=authorization.

Invocación:

En la invocación POST se envían los siguientes parámetros con los datos de la autorización:

* Campos Condicionales:

Si additionalPayerData=False, entonces el eCommerce debe enviar obligatoriamente los siguientes campos:

• identificationType
• identificationNumber
• birthdate
• streetName
• streetNumber

Si additionalPayerData=True, entonces VPB deberá solicitar obligatoriamente los siguientes campos en el formulario:

• identificationType
• identificationNumber
• birthdate
• streetName
• streetNumber

Ejemplo:

{
   "ecommerce": {
      "company": "1",
      "store": "1"
   },
   "transactionType": "authorization",
   "autoCommit": false,
   "additionalCardHolder": false,
   "transactionId": 1569441914255,
   "orderDescription": "El total de su compra es de $110.99. Ha elegido pagar en Pesos Argentinos (ARS)",
   "amount": "110.90",
   "currency": "$",
   "interestAmount": "0",
   "userId": "",
   "posTicket": "",
   "ecommerceCustomField": "",
   "cardHolder": {
      "identificationType": "1",
      "identificationNumber": "32058821",
      "birthdate": "22/07/1986",
      "phone": "3425340300",
      "deliveryAddress": {
         "streetName": "25 de mayo",
         "streetNumber": "3587",
         "complement": "2B",
         "zipCode": "3000"
      }
   },
   "url": {
      "callbackUrlError": "https://localhost:8843/emulatorEcommerce/callbackErrorURL.jsp",
      "callbackUrlSuccessful": "https://localhost:8843/emulatorEcommerce/callbackOKURL.jsp",
      "callbackUrlCancel": "https://localhost:8843/emulatorEcommerce/callBackCancel.jsp",
      "checkTransactionStatus": "http://localhost:8280/emulatorEcommerce/service/checkStatusReturnRandom.html"
   },
   "formData": {
      "merchantName": "My Company Name",
      "merchantImageURL": "https://IP/companyImage.png"
   },
   "paymentData": {
      "payments": "1",
      "plan": "0"
   },
   "cardValidation": {
      "brand": "VISA",
      "provider": "VI",
      "bank": "BANCO GALICIA"
   },
   "customerData": {
      "customerId": "100",
      "customerIP": "10.90.100.101",
      "customerName": "Juan Carlos",
      "customerLastName": "Messi",
      "customerIdentificationType": "1",
      "customerIdentificationNumber": "32123456"
   }
}

Respuesta:

La respuesta se realiza en la dirección de callback, especificada en el POST inicial. De esta manera se devuelve el control al eCommerce.

Retorna los siguientes campos:

Los campos se envían en formato json "Nombre del campo":"valor"

Ejemplo de respuesta:

{
   "transactionType": "Authorization",
   "ecommerce": {
      "company": "C1",
      "store": "13"
   },
   "transactionId": "1581605477722",
   "responseCode": "00",
   "status": "Pending"
}

2.1.2.2 Consultar Estado de Transacción

Servicio: /checkTransactionStatus

VPB permite consultar el estado y los datos de una autorización, a través de una invocación GET a la URL de VPB.

La invocación a este servicio es el mismo que en las operaciones de una fase: Consultar Estado de Transacción

2.1.2.3 Captura de Pago

Servicio: /closeTransaction

Esta operatoria se utiliza exclusivamente luego de haber realizado un Pedido de Autorización en 2 pasos.

Para poder confirmar definitivamente el pago al cliente, es necesario capturar los fondos que se reservaron. Es posible realizar la captura por el monto total o de forma parcial.

Capturar el monto total de una reserva

Para hacer la captura por el monto total, se realizará una invocación POST a la URL de VPB, sin informar el monto, y enviando el atributo action=commit. 

Invocación:

En la invocación POST se envían los siguientes parámetros con los datos de la captura:

Ejemplo:

{
   "transactionId": "1581605477722",
   "ecommerce": {
      "company": "C1",
      "store": "13"
   },
   "action": "commit"
}

Respuesta:

La respuesta sólo retorna un código HTTP 200.

Capturar un monto distinto al reservado

Para hacer la captura por un monto distinto (mayor o menor) al reservado, se realizará una invocación POST a la URL de VPB, informando el monto con el importe definitivo, y enviando el atributo action=commit.

Invocación:

En la invocación POST se envían los siguientes parámetros con los datos de la captura:

Ejemplo:

{
   "transactionId": "1581605477722",
   "ecommerce": {
      "company": "C1",
      "store": "13"
   },
   "amount":500.22,
   "action": "commit"
}

Respuesta:

La respuesta sólo retorna un código HTTP 200.

2.1.2.4 Cancelar una Autorización de Pago

Servicio: /closeTransaction

Para realizar la cancelación de una autorización, se debe invocar un método POST a la URL de VPB, enviando el atributo action=rollback.

Invocación:

En la invocación POST se envían los siguientes parámetros con los datos de la cancelación:

Los campos se envían en formato json "Nombre del campo":"valor"

Ejemplo:

{
   "transactionId": "1581605477722",
   "ecommerce": {
      "company": "C1",
      "store": "13"
   },
   "action": "rollback"
}

Respuesta:

La respuesta sólo retorna un código HTTP 200.

2.1.3 Devoluciones

VTOL Payment Bridge ofrece la posibilidad de realizar devoluciones de un pago. La operación original debe ser menor a 30 días.

La Devolución de una Transacción de dos pasos, se hace por el monto efectivamente capturado (en el 2do paso).

A través de este método se realizan devoluciones totales o parciales. Para ello la transacción debe estar en estado Acreditada.

2.1.3.1 Realizar devolución total del pago

Servicio: /refunds

Se debe invocar un método POST a la URL de VPB, sin informar el monto, y enviando el atributo transactionType=refund.

Si no se informa el monto, la devolución se hará por el total de la orden.

Invocación:

2.1.3.2 Realizar devolución parcial del pago

Servicio: /refunds

Se debe invocar un método POST a la URL de VPB, enviando el atributo transactionType=refund.

Es posible realizar devoluciones parciales (incluso más de una por orden, siempre y cuando no se supere el monto de la misma).

Se debe indicar el monto a devolver, en el campo amount.

Respuesta:

La respuesta se realiza en la dirección de callback, especificada por el eCommerce en la operación de devolución.

Se responden los siguientes campos:

Ejemplo:

{
   "transactionType": "Refund",
   "ecommerce": {
      "company": "C1",
      "store": "13"
   },
   "transactionId": "1581607736373"
}

2.1.3.3 Cierre de transacción

Servicio: /closeTransaction

VPB permite cerrar la transacción de Devolución para confirmarla o cancelarla, a través de un método POST a la URL de VPB. Esta operación se debe llevar a cabo para poder cerrar la transacción.

Invocación:

En la invocación POST se envían los siguientes parámetros de la operación:

Los campos se envían en formato json "Nombre del campo":"valor"

Ejemplo:

{
   "transactionId": "11445878985",
   "ecommerce": {
      "company": "1",
      "store": "1"
   },
   "action": "commit"
}

Respuesta:

La respuesta sólo retorna un código HTTP 200.

2.2 Servicios brindados por el E-Commerce

El e-commerce debe brindar la posibilidad de realizar la consulta de estado de la transacción para que VPB pueda consultar si debe confirmar o cancelar la operación contra VTOL Server, en caso de producirse alguna desincronización de estados.

2.2.1 Consultar estado de transacción

VPB debe poder realizar una invocación GET a un servicio que disponibiliza el e-commerce. VPB debe conocer la URL del servicio para poder realizar la consulta. Dicha URL será informada por el e-commerce en el mensaje de Solicitud de Pago.

Servicio: /getTransactionStatus

Invocación:

En la invocación GET se envían los siguientes parámetros de la operación dentro de la URL:

Ejemplo:

https://www.e-commerce.com/service/getTransactionStatus.html?transactionId=1567105313489&company=1&store=1

Respuesta:

La respuesta retornará los siguientes campos:

Los campos se responden en formato json "Nombre del campo":"valor"

Ejemplo de respuesta:

200:{
	"company":"1",
	"store":"1",	
	"transactionId":"1567105313489",
	"status":"Commit"
}

2.3 Códigos de Respuesta

VPB responde a cada transacción que recibe para autorizar con un código de respuesta y una descripción del mismo, indicando cual fue el resultado de la operación. 

A continuación se detallan las respuestas posibles.

2.3.1 Códigos recibidos de VTOL Server

Nota: La respuesta con código '099' representa un error en el procesamiento interno de VTOL, independientemente de la interacción con el Centro Autorizador

Códigos de respuesta por validación en VPB