...

Índice

Âncora
_Toc434487091 _Toc434487091

1. Introducción

Âncora
_Toc434487092 _Toc434487092

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.

Âncora
_Toc434487093 _Toc434487093

1.2 ¿Qué es VTOL Payment Bridge?

Es un componente Web que permite a un sitio de e-commerce autorizar contra VTOL Server los pagos de compras realizadas con tarjeta en Internet. 

Cuando el cliente del e-commerce eCommerce quiera 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

...

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

...

Image Removed

...

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:

Image Added

Formulario de VPB con datos adicionales del tarjeta habiente

Âncora
_Toc434487094 _Toc434487094

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

Âncora
_Toc434487095 _Toc434487095

1.4 Arquitectura

Image Added

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.

...

VTOL Payment Bridge es una aplicación pensada para ser integrada en el contenedor Web de Apache Tomcat versión 9.Descargas en: http://tomcat.

• Instalar y configurar el servidor Tomcat 9 como servicio. Link: tomcat.apache.org/download-

...

• 90.cgi
• Descargar JDK 1.8+

Âncora
_Toc434487102 _Toc434487102

2.2 Requerimientos mínimos

A continuación se detallan los requerimientos mínimos que son requeridos para poder instalar y ejecutar la aplicación.

Hardware

Software

...

Âncora
_Toc434487103 _Toc434487103

2.3 Instalación

La instalación de VTOL Payment Bridge consiste básicamente en incluir la carpeta que conforma la aplicación dentro del contenedor Web y configurar los archivos necesarios para lograr un intercambio de información segura. 

La entrega es básicamente en un archivo ZIP. Al descomprimirse se obtiene la siguiente estructura de carpetas:

...

Carpeta

...

Descripción

...

conf

...

Contiene archivos de configuración que deben ser copiados al contenedor Web:

• Synthesis.keystore: almacén de claves utilizado para transporte seguro HTTPS. Se debe copiar en la carpeta /conf del contenedor.

...

lib

...

Contiene la librería con el driver de base de datos que debe ser copiado en la carpeta /lib del contenedor.

...

scripts

...

Contiene los scripts para crear y popular la base de datos que utiliza la aplicación.

...

vtolweb

...

Es la aplicación VPB. La carpeta debe ser copiada al directorio /webapps del contenedor Web.

...

Es requisito fundamental configurar la transferencia por protocolo seguro.

...

• Descomentar y configurar el conector HTTPS

Es necesario configurar el conector de protocolo seguro agregando el archivo que contiene el certificado, así como también los cifrados utilizados.

...

<!-- Define a SSL HTTP/1.1 Connector on port 8443
This connector uses the JSSE configuration, when using APR, the
connector should be using the OpenSSL style configuration
described in the APR documentation -->
<Connector protocol="HTTP/1.1" SSLEnabled="true"
port="8443" emptySessionPath="false"
scheme="https" secure="true" clientAuth="false"
keystoreFile="${catalina.home}/conf/synthesis.keystore"
keystorePass="nosotros" sslProtocol = "TLS" server="Unavailable"
ciphers="TLS_ECDHE_RSA_WITH_RC4_128_SHA, TLS_ECDHE_ECDSA_WITH_RC4_128_SHA, TLS_ECDH_RSA_WITH_RC4_128_SHA,
SSL_RSA_WITH_RC4_128_SHA, TLS_ECDH_ECDSA_WITH_RC4_128_SHA, TLS_RSA_WITH_RC4_128_SHA, TLS_RSA_WITH_RC4_128_MD5,
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_256_CBC_SHA,
TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA, TLS_RSA_WITH_3DES_EDE_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA"/>

El archivo synthesis.keystore es el almacén de claves que contiene el certificado para lograr transporte seguro. Se encuentra disponible en la carpeta /vtolPaymentBridge/conf/ y debe ser copiado a la carpeta /conf del contenedor Web.

• Comentar la línea AprLifecycleListener

...

<!--APR library loader. Documentation at /docs/apr.html
<Listener className="org.apache.catalina.core.AprLifecycleListener" SSLEngine="on" />-->

...

Configurar las cookies de sesión secure y httpOnly

...

La conexión con base de datos se configura en el archivo \conf\context.xml de Tomcat, agregando el recurso datasource "jdbc/RSVTOL" de la siguiente manera:

...

<!-- Datasource Connection -->
<Resource name="jdbc/RSVTOL" auth="Container" type="javax.sql.DataSource" maxActive="100" maxIdle="30" maxWait="10000" username="[name]" password="[password]" driverClassName="[dbdriver]" url="[dburl]"/>

...

Variable

...

Descripción

...

[name]

...

Nombre del usuario de base de datos.

...

[password]

...

Contraseña para el usuario de base de datos configurado en [name]

...

[dbdriver]

...

Driver de conexión correspondiente al motor de base de datos utilizado.

Oracle: oracle.jdbc.driver.OracleDriver

MSSQL: net.sourceforge.jtds.jdbc.Drive

La librería que contiene el driver se encuentra disponible en la carpeta /vtolPaymentBridge/lib y debe ser copiada a la carpeta /lib del contenedor Web.

...

[dburl]

...

URL de conexión con la base de datos.

Ejemplo Oracle

...

Se debe crear la base de datos para la aplicación y contar con usuario que tenga permisos de OWNER sobre la misma. Luego con dicho usuario se deben ejecutar los scripts para crear y popular la base de datos. Los archivos scripts se encuentran disponibles en la carpeta \vtolpaymentBridge\scripts. 

...

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

...

VTOL Payment Bridge brinda los siguientes servicios:

...

Para realizar solicitud de Pago el browser del cliente debe hacer una invocación POST a la URL de VPB.

...

Notar que la URL es sobre protocolo seguro HTTPS.

En la invocación se envía el parámetro data con los datos de la venta del e-commerce.

...

<html>

<body>

<form id="authorize"

name="authorize" action="https://10.4.14.56:8080/web-vtol/service/authorizeForm.html" method="post">

<input type="hidden" name="data"  id="data"

value="transactionId=transactionId|amount=110.99|promocionBanco=promo_all|orderDescription=El total de su compra es de $110.99. Ha elegido pagar en Pesos Argentinos (ARS)|aditionalData=|userID=juanc@sts.com|callbackErrorURL=http://localhost:8080/emulatorEcommerce/callbackErrorURL.jsp|callbackOKURL=http://localhost:8080/emulatorEcommerce/callbackOKURL.jsp|callBackCancel=http://localhost:8080/emulatorEcommerce/callBackCancel.jsp|payments=1|currency=$|[email protected]|cardId=NotDefined|plan=0|nombre=Andres|apellido=Bohinc|localidad=|domicilio=|provincia=|pais=|ipAdress=127.0.0.1)|message=Mensaje"/>

<form>

<script type="text/javascript">

document.authorize.submit();

</script>

</body>

</html>

El parámetro data está formado por una serie de campos respetando el siguiente formato:

...

Para separar los campos se utiliza el separador | (pipe)

...

Campo

...

Tipo

...

Obligatorio

...

Descripción

...

amount

...

Numérico

...

Obligatorio

...

Importe total a pagar

...

transactionId

...

Numérico

...

Obligatorio

...

• Correr desde la consola el instalador con el comando:

                cmd: java -jar vtol-payment-bridge-installer-3.8.0.3-SNAPSHOT.jar

• Aceptar la licencia
• Ingresar la  ruta de la JDK
• Ingresar la ruta donde está instalado Tomcat 9
• Seleccionar si desea realizar la instalación completa.

Image Added

Solo para Instalación completa

• Ingresar la ruta del certificado de seguridad

• Ingresar el password del certificado de seguridad

Image Added

• Ingresar las credenciales de conexión a la base de datos SQL SERVER.

Image Added

Para instalación completa y parcial

• Se desplegará la siguiente imagen:

Image Added

• La finalización de la instalación se informa mediante un mensaje de "Terminado". Oprimir "Aceptar".
• Presionar el botón "Salir" para salir del instalador.

• Dentro del directorio NNNN se creó la carpeta con la nueva versión instalada de VTOL Payment Bridge.
• A continuación, lo que se debe realizar es ejecutar los scripts en la base de datos. Ver el apartado 2.5 Creación de base de datos

Âncora
_Toc434487107 _Toc434487107

Âncora
25 25

2.5 Creación de Base de Datos

Se debe crear la base de datos para la aplicación y contar con usuario que tenga permisos de OWNER sobre la misma. Luego con dicho usuario se deben ejecutar los scripts para crear y popular la base de datos.

Los archivos scripts se encuentran disponibles en la ruta \vtolpaymentBridge\scripts. 

El usuario OWNER será el que se utilice para conectar la aplicación.

Âncora
_Toc434487108 _Toc434487108

3. Integración

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

Âncora
_Toc381043093 _Toc381043093

Âncora
_Toc434487110 _Toc434487110

3.2 Servicios brindados por VPB

VTOL Payment Bridge brinda los siguientes servicios:

3.2.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.

3.2.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.

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

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 el dirección de callback, especificada por el eCommerce. Los campos se envían en formato json "Nombre del campo":"valor".

Se responden los siguientes campos:

Ejemplo de respuesta:

{
	"transactionId":"1567105313489",
	"company":"55",
	"store":"1",
	"transactionType":"sale"
}

Âncora
checkTransactionStatus checkTransactionStatus

3.2.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":"1567105313489",
	"company":"1",
	"store":"1"
}

Respuesta:

La respuesta retorna los siguientes campos:

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

Ejemplo de respuesta:

{  
   "amount":"110.99",
   "providerCode":"Visa",
   "ticket":"27",
   "authorizationCode":"123456",
   "store":1,
   "transactionDate":"2019-08-29 16:02:13.743",
   "responseCode":"000",
   "node":"0000000005",
   "displayMessage":"esta es una prueba de impresion",
   "currency":"$",
   "company":1,
   "id":1350,
   "responseMessage":"APROBADA",
   "vtolTrxId":"29081916021600000277",
   "status":"Commit"
}

3.2.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:

{
	"company":"1",
	"store":"1",
	"transactionType":"sale",
	"transactionId":"1567105313489",
	"action":"commit"
}

Respuesta:

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

3.2.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.

3.2.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.

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

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:

{
    "transactionId":"1567105313489",
    "company":"55",
    "store":"1",
	"transactionType":"authorization"
}

3.2.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

3.2.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. 

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

Invocación:

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

Ejemplo:

{
    "company":"1",
    "store":"1",
    "transactionId":"1567105313489",
	"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.

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

Invocación:

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

Ejemplo:

{
    "company":"1",
    "store":"1",
    "transactionId":"1567105313489",
	"amount":500.22,
	"action":"commit"
}

Respuesta:

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

3.2.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.

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

Invocación:

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

Ejemplo:

{
    "company":"1",
    "store":"1",
    "transactionId":"1567105313489",
	"action":"rollback"
}

Respuesta:

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

3.2.4 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.

3.2.4.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:

3.2.4.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.

...

VPB permite consultar el estado y los datos de una autorización, a través de una invocación GET a la URL: ¡Error! Referencia de hipervínculo no válida.
La invocación se realiza enviando el parámetro data que incluye el campo transaccionId encriptado. El cual se envía con el siguiente formato: transactionId=<valor>

Ejemplo de invocación GET con el campo ya encriptado:

...

Campo

...

Tipo

...

Descripción

...

responseCode

...

Numérico

...

Código de Respuesta de la transacción. Ver sección Códigos de Respuesta.

...

message

...

Alfanumérico

...

Descripción del Código de Respuesta

...

status

...

Alfanumérico

...

Estado de la transacción. Puede ser:

Initialized: Inicializada

Cancel: Cancelada por el usuario.

Authorize: autorizando

Rejected: rechazada

Pending: Pendiente de confirmación.

Commit: Confirmada

Rollback: Cancelada.

...

node

...

Numérico

...

Código de nodo de VTOL Server utilizado para la autorización.

...

transactionId

...

Numérico

...

Identificador de la transacción.

...

amount

...

Numérico

...

Importe total de la operación.

...

currency

...

Alfanumérico

...

Tipo de moneda.

...

ticket

...

Numérico

...

Ticket generado en VTOL Server

...

authorizationCode

...

Numérico

...

Código de autorización de la transacción, en caso de que haya sido aprobada.

...

vtolTrxId

...

Numérico

...

Identificador de la transacción en VTOL Server.

...

providerCode

...

Alfanumérico

...

Código de autorizador. Ejemplo: Banamex

...

displayMessage

...

Alfanumérico

...

Mensaje adicional enviado por el autorizador y que debe ser visualizado.

Para separar los campos se utiliza el separador | (pipe)

3.2.3 Cierre de Transacción

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

La invocación a este servicio se realiza enviando el parámetro data, conteniendo los siguientes campos encriptados:

...

Campo

...

Tipo

...

Obligatorio

...

Descripción

...

transactionId

...

Numérico

...

Obligatorio

...

Identificador de la transacción.

...

action

...

Alfanumérico

...

Obligatorio

...

Commit: Confirmada

Rollback: Cancelada.

...

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.

...

Se debe poder realizar una invocación GET a una URL especifica del e-commerce, pasando el parámetro data que contiene el campo transactionId encriptado. El cual se envía con el siguiente formato: transactionId=<valor>
VPB debe conocer la URL del servicio para poder realizar la consulta.

Ejemplo de invocación con el dato encriptado:

...

Campo

...

Tipo

...

Descripción

...

status

...

Alfanumérico

...

Estado de la transacción. Puede ser:

Commit: Confirmada

Rollback: Cancelada.

...

transactionId

...

Numérico

...

Identificador de la transacción.

Para separar los campos se utiliza el separador | (pipe)

...

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:

3.2.4.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.

Âncora
_Toc381043096 _Toc381043096

Âncora
_Toc434487111 _Toc434487111

3.3 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.

Âncora
_Toc381043097 _Toc381043097

3.3.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"
}

Âncora
_Códigos_de_respuesta _Códigos_de_respuesta

Âncora
_Toc434487112 _Toc434487112

3.4 Códigos de Respuesta

...

3.4.1 Códigos recibidos de VTOL Server

...

Códigos de respuesta por validación en VPB

...