tb-payments v1.0.6

tb-payments

Módulo que ofrece servicios de pago, registro de tarjetas de crédito, devoluciones, etc…. Para ello utiliza servicios de terceros ofrecidos a través de distintos módulos.

Instalación:

Para utilizar los servicios de pago es necesario tener instalada la librería tb-payments junto con la librería del servicio que se vaya a utilizar, como por ejemplo tb-payments-globalonepay, y tener una cuenta creada para dicho servicio.

Además es importante inicializar la librería en el archivo "boot.js" dentro de app. Para ello incluir la siguiente linea dentro de la función Boot:

App.payments.init();

Configuración del servicio:

- Servicios disponibles:

Para poder utilizar un servicio se utilizarán los identificadores de cada uno de ellos. Por ahora los servicios disponibles son:

• GlobalOnePay
  • Nombre de módulo: tb-payments-globalonepay
  • Identificador: "globalonepay"
  • Página web

- Configuración desde interfaz administrativa:

Por el momento no la opción de configuración a través de la interfaz de administración no está disponible.

- Configuración manual

La configuración manual se realiza en el archivo "config.json".

Para ello hay que añadir el objeto "paymentsOptions", si no se tenía anteriormente, y agregar un objeto con la configuración del servicio que se vaya a utilizar. Al completarlo, debería quedar de la siguiente manera:

"paymentsOptions":{
  <paymentService>:{
    …
    …
  }
}

• Ejemplo:

"paymentsOptions":{
  "globalOnePay":{
    "terminalId": "myTerminalId",
    "sharedSecret": "mySharedSecret",
    "mcp": <True, False. Flag que indica si soporta multiples monedas>,
    "url": <Url del servicio>,
    "port": <Puerto de comunicacion del servicio>
  }
}

Al completarlo, debería quedar de la siguiente manera:

"paymentsOptions":{
  "globalOnePay":{
    "terminalId": "99089",
    "sharedSecret": "123456789XX",
    "mcp": true,
    "url": myServiceUrl,
    "port": myServicePort
  }
}

Funcionalidades

- Registrar una tarjeta:

• REST Api:

Petición:

Parámetros del query:

Parámetros del body:

Respuesta:

Ejemplo:

POST: https://a2server.a2system.net:1234/api/v1/srv/payments/register?service=globalonepay

• BODY:

 {
   "data": {
     "merchantRef":"1234567890123459",
     "cardNumber":myCardNumber,
     "cardExpiry":"1220",
     "cardType":"MASTERCARD",
     "cardHolderName":"Messi",
     "cvv": "231"  
   }
 }

• Código Javascript:

Parámetros:

Respuesta:

Ejemplo:

var service = "globalonepay";

var data = {
  merchantRef:"1234567890123459",
  cardNumber:myCardNumber,
  cardExpiry:"1220",
  cardType:"MASTERCARD",
  cvv: "231",
  cardHolderName:"Messi" 
};

App.payments.forService(service)
  .then(client => client.register(data))
  .then(resp => console.log(resp))
  .catch(err => console.log(err));

- Desregistrar una tarjeta:

• REST Api:

Petición:

Parámetros del query:

Parámetros del body:

Respuesta:

Ejemplo:

POST: https://a2server.a2system.net:1234/api/v1/srv/payments/unregister?service=globalonepay

• BODY:

 {
   "data": {
     "merchantRef":"1234567890123459",
     "reference": "L190394333"
   }
 }

• Código Javascript:

Parámetros:

Respuesta:

Ejemplo:

var service = "globalonepay";

var data = {
  merchantRef:"1234567890123459",
  reference:L190394333
};

App.payments.forService(service)
  .then(client => client.unregister(data))
  .then(resp => console.log(resp))
  .catch(err => console.log(err));

- Pago:

• REST Api:

Petición:

Parámetros del query:

Parámetros del body:

Respuesta:

Ejemplo:

POST: https://a2server.a2system.net:1234/api/v1/srv/payments/pay?service=globalonepay

• BODY:

 {
   "data": {
     "orderId"        : "19827391827392",
     "amount"         : "289",
     "currency"       : "USD",
     "cardNumber"     : myCardNumber,
     "cardType"       : "MASTERCARD",
     "cardExpiry"     : "1220",
     "cardHolderName" : "Messi" ,
     "cvv"            : "124" 
   }
 }

• Código Javascript:

Parámetros:

Respuesta:

Ejemplo:

var service = "globalonepay";

var data = {
 orderId        : "19827391827392",
 amount         : "289",
 currency       : "USD",
 cardNumber     : myCardNumber,
 cardType       : "MASTERCARD",
 cardExpiry     : "1220",
 cardHolderName : "Messi" ,
 cvv            : "124" 
};

App.payments.forService(service)
  .then(client => client.pay(data))
  .then(resp => console.log(resp))
  .catch(err => console.log(err));

- Pago con una tarjeta registrada:

• REST Api:

Petición:

Parámetros del query:

Parámetros del body:

Respuesta:

Ejemplo:

POST: https://a2server.a2system.net:1234/api/v1/srv/payments/payRegistered?service=globalonepay

• BODY:

 {
   "data": {
     "orderId"        : "19827391827393",
     "amount"         : "289",
     "currency"       : "USD",
     "cardNumber"     : "2967535088608700"
   }
 }

• Código Javascript:

Parámetros:

Respuesta:

Ejemplo:

var service = "globalonepay";

var data = {
 orderId        : "19827391827393",
 amount         : "289",
 currency       : "USD",
 cardNumber     : "2967535088608700"
};

App.payments.forService(service)
  .then(client => client.payRegistered(data))
  .then(resp => console.log(resp))
  .catch(err => console.log(err));

- Devolución:

• REST Api:

Petición:

Parámetros del query:

Parámetros del body:

Respuesta:

Ejemplo:

POST: https://a2server.a2system.net:1234/api/v1/srv/payments/refund?service=globalonepay

• BODY:

 {
   "data": {
      "paymentRef" : "DG5Z3SB3QJ",
      "amount"     : "53"
   }
 }

• Código Javascript:

Parámetros:

Respuesta:

Ejemplo:

var service = "globalonepay";

var data = {
 paymentRef : "DG5Z3SB3QJ",
 amount     : "53"
};
var options = {
  operator : "Someone",
  reason   : "My reason"
}
App.payments.forService(service)
  .then(client => client.refund(data, options))
  .then(resp => console.log(resp))
  .catch(err => console.log(err));