bancard-checkout-js

Biblioteca de referencia desarrollada por Bancard que permite ingresar la información de una tarjeta para realizar un pago o un catastro de un medio de pago en un e-commerce sin salir del mismo. La información sensible de la tarjeta es ingresada siempre en Bancard, embebido con el look and feel del comercio sin ninguna redirección.

Precondición

Como precondición para utilizar esta biblioteca y poder integrar el servicio de vPOS, el comercio debe estar registrado y habilitado por Bancard contando con acceso al Portal de comercios así como acceso al servicio de vPOS.

Pasos para realizar la integración

Generar un process_id o alias_token válido
Incluir bancard-checkout.js
Inicializar contenedor con código JavaScript

0. Generar un process_id o alias_token válido

Process_id: Como primer paso se debe invocar al servicio create_single_buy o create_new_card_request para realizar un pago o catastrar una tarjeta respectivamente. El servicio de vPOS retornará un process_id válido para realizar la integración con esta biblioteca.
Alias_token: Al consumir la operación de pago con alias token, y tratarse de una tarjeta de débito, el servicio devolverá que el pago necesita confirmación por parte del cliente, el cual deberá ingresar su PIN. Una vez consumida dicha operación, el alias_token será válido para poder realizar la integración con la bibloteca.

Por más detalles, consultar documentación en el Portal de comercios.

1. Incluir bancard-checkout.js

Para utilizar la biblioteca bancard-checkout.js se debe incluir la misma utilizando, por ejemplo, el siguiente código:

<script src="https://github.com/Bancard/bancard-checkout-js/raw/master/bancard-checkout.js"></script>

2. Inicializar contenedor con código JavaScript

Para montar el formulario de pago o catastro en el sitio web, se debe ejecutar Bancard.Checkout.createForm o Bancard.Cards.createForm, según sea un pago o un catastro, indicando el id del contenedor, process_id y un conjunto de opciones que incluyen los estilos asociados al elemento embebido. En el caso de querer montar el PIN pad para confirmar un pago con alias token, se debe ejecutar Bancard.Confirmation.loadPinPad, indicando el id del contenedor, el alias_token y las opciones de configuración elegidas.

El [PROCESS_ID] es el hash resultante de haber invocado a la operación de la API de vPOS.

El [ALIAS_TOKEN] es el hash que identifica a una tarjeta obtenida a través de la operación de listar tarjetas de un usuario de la API de vPOS .

Nota:

La opción de catastro de tarjeta es soportada a partir de la versión 2.0.0.
La opción de confirmación es soportada a partir de la versión 2.1.0.

Ejemplo de invocación

Pago:

   window.onload = function() {
      Bancard.Checkout.createForm('iframe-container', '[PROCESS_ID]', options);
   };

Catastro:

   window.onload = function() {
      Bancard.Cards.createForm('iframe-container', '[PROCESS_ID]', options);
   };

Confirmación:

   window.onload = function() {
      Bancard.Confirmation.loadPinPad('iframe-container', '[ALIAS_TOKEN]', options);
   };

Preautorización:

   window.onload = function() {
      Bancard.Preauthorization.createForm('iframe-container', '[PROCESS_ID]', options);
   };

Modificar estilos

Puede modificarse la información de estilos del contenedor con atributros ya definidos. La lista completa es:

- name: button-background-color
  text: Color fondo del botón
  type: color
  default: '#5CB85C'
- name: button-border-color
  text: Color borde del botón
  type: color
  default: '#4CAE4C'
- name: button-text-color
  text: Color texto del botón
  type: color
  default: '#FFFFFF'
- name: form-background-color
  text: Color fondo de formulario
  type: color
  default: '#FFFFFF'
- name: form-border-color
  text: Color del borde del formulario
  type: color
  default: '#DDDDDD'
- name: header-background-color
  text: Color fondo de encabezado
  type: color
  default: '#F5F5F5'
- name: header-text-color
  text: Color texto de encabezado
  type: color
  default: '#333333'
- name: hr-border-color
  text: Color de linea separadora
  type: color
  default: '#EEEEEE'
- name: input-background-color
  text: Color fondo de campos
  type: color
  default: '#FFFFFF'
- name: input-border-color
  text: Color borde de campos
  type: color
  default: '#CCCCCC'
- name: input-placeholder-color
  text: Color del placeholder
  type: color
  default: '#999999'
- name: input-text-color
  text: Color texto de campos
  type: color
  default: '#555555'
- name: label-kyc-text-color
  text: Color texto de tu-eres-tu
  type: color
  default: '#000000'

En caso de no indicar un valor para un atributo, será utilizado el atributo configurado en el Portal de Comercios.

Ejemplo completo del código HTML y JavaScript

<html>
  <head>
    <script src="https://github.com/Bancard/bancard-checkout-js/raw/master/bancard-checkout-1.0.0.js"></script>
  </head>

  <script type="text/javascript">
    window.onload = function () {

      var styles = {
        'input-background-color' : '#453454',
        'input-text-color': '#B22222',
        'input-border-color' : '#CCCCCC',
        'input-placeholder-color' : '#999999',
        'button-background-color' : '#5CB85C',
        'button-text-color' : '#FFFFFF',
        'button-border-color' : '#4CAE4C',
        'form-background-color' : '#999999',
        'form-border-color' : '#DDDDDD',
        'header-background-color' : '#F5F5F5',
        'header-text-color' : '#333333',
        'hr-border-color' : '#B22222'
      };

      options = {
        styles: styles
      }

      Bancard.Checkout.createForm('iframe-container', '[PROCESS_ID]', options);
    };
  </script>

  <body>

    <h1>iFrame vPos</h1>

    <div style="height: 130px; width: 100%; margin: auto" id="iframe-container"/>

  </body>
</html>

iFrame

Acceder al código fuente y builds de la biblioteca

Puedes ver el código fuente de la biblioteca y aportar con comentarios, pull requests o directamente ver como está implementada. Para acceder a este proyecto puedes ir directamente a bancard-connectors

Si quieres acceder a los builds de esta biblioteca puedes hacerlo desde la carpeta de builds

Ej. bancard-checkout-1.0.0.js

Bancard / bancard-checkout-js

readme