npm:ws-azul-mcmpos

README

API de conexion al Webservices de AZUL para consumir API MCM

Instalacion

    
        npm install ws-azul-mcmpos

Para consumir esta libreria es necesario instanciar la clase "APIMCMAzul" con los siguientes parametros:

Auth1: parametro de autenticacion 1 provisto por AZUL.
Auth2: parametro de autenticacion 2 provisto por AZUL
MerchantID: Merchant asignado por AZUL para realizar las transacciones.
TerminalID: Terminal asignado por AZUL para realizar las transacciones en ese POS.
URLMain: URL base a la que se realizara el request. Ejemplo: "pagos.azul.com.do" o "pruebas.azul.com.do"
URLCont: URL de contingencias en caso de que la URL principal no este funcionando. Ejemplo: "contpagos.azul.com.do"
TimeOut: Tiempo limite provisto por AZUL para cambiar de una URL a otra.

Nota: todos estos campos son requeridos para poder consumir la clase.

    
        const API = require('./APIAzulJS.js');
        
        let api = new API(Auth1,Auth2,MerchantId,TerminalId,URLMain,URLCont,TimeOut);
        
    // let api = new API("prueba","mcmtestprueba123","39000000000","0100000","pruebas.azul.com.do","contpruebas.azul.com.do",30000);

A continuacion, se listan los diferentes metodos que componen el API y los parametros segun su tipo

Sale

Este metodo se utiliza para realizar ventas, el mismo posee los siguientes parametros:

Amount (Requerido): Monto de la transaccion.
Itbis (Requerido): ITBIS de la transaccion, los dos ultimos digitos de la derecha son los decimales.
Tip (Requerido): Propina al establecimiento
OrderNumber (Requerido): numero de orden de la transaccion.
CreditCardNumber (Requerido): Numero de la tarjeta a debitar.
CreditCardExpiration (Requerido): Fecha de expiracion en formato mmaa.
CreditCardCVC (Requerido): Codigo de seguridad de la tarjeta.
Installment (Opcional): Solo aplica si el comercio posee esta funcionalidad, de no poseer la funcionalidad enviar null.
UseMultiMessaging (Opcional): Posee la funcionalidad para aplicar descuentos. Los posibles valores son 1 y 0. Colocar null si no aplica.
PromoData (Opcional): Define el descuento a aplicar al tarjetahabiente utilizando el BIN de la tarjeta utilizada en la transaccion. Colocar null o no enviar nada si no aplica

    
        api.Sale(100,18,10,123456,4000000000000077,1220,123).then((resp,err)=>{
         console.log(JSON.stringify(resp))
         console.log(JSON.stringify(err))
        })

Nota: Se debe considerar el call back que poseen todos los metodos.

Refund

Este metodo se utiliza para reversar ventas ya hechas de forma parcial o total, el mismo posee los siguientes parametros:

Amount (Requerido): Monto de la transaccion.
Itbis (Requerido): ITBIS de la transaccion, los dos ultimos digitos de la derecha son los decimales.
Tip (Requerido): Propina al establecimiento
OrderNumber (Requerido): numero de orden de la transaccion.
CreditCardNumber (Requerido): Numero de la tarjeta a debitar.
CreditCardExpiration (Requerido): Fecha de expiracion en formato mmaa.
CreditCardCVC (Requerido): Codigo de seguridad de la tarjeta.

    
        api.Refund(100,18,123456,4000000000000077,1220,123).then((resp,err)=>{
         console.log(JSON.stringify(resp))
         console.log(JSON.stringify(err))
        })

SaleCancellation

Este metodo se utiliza para reversar ventas ya hechas de forma total, el mismo posee los siguientes parametros:

Amount (Requerido): Monto total de la transaccion.
Itbis (Requerido): ITBIS de la transaccion, los dos ultimos digitos de la derecha son los decimales.
Tip (Requerido): Propina al establecimiento
OrderNumber (Requerido): numero de orden de la transaccion.
AuthorizationNumber (Requerido): numero de autorizacion de la transaccion original.
CreditCardNumber (Requerido): Numero de la tarjeta a debitar.
CreditCardExpiration (Requerido): Fecha de expiracion en formato mmaa.
CreditCardCVC (Requerido): Codigo de seguridad de la tarjeta.

    
        api.SaleCancellation(100,18,123456,"OK0000",4000000000000077,1220,123).then((resp,err)=>{
         console.log(JSON.stringify(resp))
         console.log(JSON.stringify(err))
        })

Echo

Este metodo se encarga de validar si el POS esta en operacion. Debido a que este metodo es solo de validacion solo es necesario llamar al metodo para recibir una respuesta.

    
        api.Echo().then((resp,err)=>{
         console.log(JSON.stringify(resp))
         console.log(JSON.stringify(err))
        })

PinpadTransactionTotals

Este metodo muestra los totales por marca transados. Debido a que es un reporte de totales solo con invocar el metodo el proveera la respuesta.

    
        api.PinpadTransactionTotals().then((resp,err)=>{
         console.log(JSON.stringify(resp))
         console.log(JSON.stringify(err))
        })

PinpadSettle

Este metodo realiza el cierre de la terminal. Debido a que es una accion de cierre, solo hay que invocar dicho metodo para recibir la respuesta.

    
        api.PinpadSettle().then((resp,err)=>{
         console.log(JSON.stringify(resp))
         console.log(JSON.stringify(err))
        })

PinpadInit

Este metodo realiza el cierre de la terminal. A continuacion se listan los parametros requeridos para este metodo.

WaitForResponse (Requerido): Permite habilitar que la peticion de este request sea sincronico (1) o asincronico (0).

    
        api.PinpadInit(1).then((resp,err)=>{
         console.log(JSON.stringify(resp))
         console.log(JSON.stringify(err))
        })

MobilePayment

Este metodo utiliza para realizar cobros mobiles. A continuacion se listan los parametros requerimientos para este metodo:

Amount (Requerido): Monto total de la transaccion.
Itbis (Requerido): Monto total del impuesto.
Tip (Requerido): Monto total de la propina
OrderNumber (Requerido): Numero de orden de la transaccion
UseMultiMessaging (Requerido): Permite habilitar la funcionalidad de otorgar descuentos. Posibles valores 1 o 0. Enviar null si no aplica.
PromoData (Requerido): Define el descuento a aplicar al tarjetahabiente utilizando el BIN de la tarjeta utilizada en la transaccion. Colocar null o no enviar nada si no aplica.

    
        api.MobilePayment(100,18,10,123456).then((resp,err)=>{
         console.log(JSON.stringify(resp))
         console.log(JSON.stringify(err))
        })

GetLastTrx

Este metodo utiliza para buscar las ultimas transacciones. A continuacion se listan los parametros requerimientos para este metodo:

TrxType (Requerido): Tipo de transaccion ("Sale", "Refund", etc).

    
        api.GetLastTrx("Sale").then((resp,err)=>{
         console.log(JSON.stringify(resp))
         console.log(JSON.stringify(err))
        })

Conciliation

Este metodo se utiliza para realizar la conciliacion. A continuacion se listan los parametros necesarios:

Date (Requerido): Fecha en la que se desea realizar la conciliacion.

    
        api.Conciliation("2020-01-01").then((resp,err)=>{
         console.log(JSON.stringify(resp))
         console.log(JSON.stringify(err))
        })

HotelCheckIn

Este metodo utiliza para realizar el check in. A continuacion se listan los parametros requerimientos para este metodo:

Amount (Requerido): Monto total de la transaccion.
Itbis (Requerido): Monto total de impuestos.
Tip: Monto total de la propina.
OrderNumber (Requerido): Numero de orden de la transaccion.
CreditCardNumber (Requerido): Numero completo de la tarjeta.
CreditCardExpiration (Requerido): Fecha de expiracion de la tarjeta en formato mmaa.
CreditCardCVC (Requerido): Codigo de seguridad de la tarjeta.
FolioNumber (Requerido): Numero de folio. Este campo se usara en el check out.
Duration (Requerido): Duracion de la reservacion en dias, debe coincidir con lo indicado en CheckInDate y CheckOutDate.
CheckInDate (Requerido): Fecha en que se realiza el check-in.
CheckOutDate (Requerido): Fecha en que se realiza el check out.
Installment: Cuotas de la transaccion. Esto solo aplica para tarjetas las cuales posean esta funcionalidad.
UseMultiMessaging: Permite habilitar la funcionalidad de otorgar descuentos. 1 para habilitarlo 0 o null para no utilizar este campo.
PromoData: Permite definir el descuento que desea aplicar al tarjetahabiente utilizando el BIN de la tarjeta en la transaccion.
IndustryId: Tipo de industria que esta realizando el checkin ("Hotel", "RentCar", etc).
RoomRate:
RoomTax: Impuestos para esa habitacion.
RoomNo: Numero de habitacion.
ReferenceNo: Numero de referencia.
ProgramIndicator:
CardHolderName: Nombre del tarjetahabiente.
PPIIndicator:
ExtraCharges: Cargos extras.
VisaNoShow:

    
        api.HotelCheckIn(100,18,10,123456,4000000000000077,1220,123,1004,1,"2020-01-01","2020-01-02").then((resp,err)=>{
         console.log(JSON.stringify(resp))
         console.log(JSON.stringify(err))
        })

HotelCheckOut

Este metodo utiliza para realizar el check out. A continuacion se listan los parametros requerimientos para este metodo:

Amount (Requerido): Monto total de la transaccion.
Itbis (Requerido): Monto total de impuestos.
Tip: Monto total de la propina.
OrderNumber (Requerido): Numero de orden de la transaccion.
CreditCardNumber (Requerido): Numero completo de la tarjeta.
CreditCardExpiration (Requerido): Fecha de expiracion de la tarjeta en formato mmaa.
CreditCardCVC (Requerido): Codigo de seguridad de la tarjeta.
AuthorizationCode (Requerido): Este campo debemos introducir el numero de aprobacion que recibimos en el response del checkin.
FolioNumber (Requerido): Numero de folio. El mismo que se uso en el checkin.
Duration (Requerido): Duracion de la reservacion en dias, debe coincidir con lo indicado en CheckInDate y CheckOutDate.
CheckInDate (Requerido): Fecha en que se realiza el check-in.
CheckOutDate (Requerido): Fecha en que se realiza el check out.
Installment: Cuotas de la transaccion. Esto solo aplica para tarjetas las cuales posean esta funcionalidad.
UseMultiMessaging: Permite habilitar la funcionalidad de otorgar descuentos. 1 para habilitarlo 0 o null para no utilizar este campo.
PromoData: Permite definir el descuento que desea aplicar al tarjetahabiente utilizando el BIN de la tarjeta en la transaccion.
OriginalCardMasked: Tarjeta original enmascarada.
OriginalTrxTerminalId: TerminalID de la transaccion original.
OriginalTrxAmount: Monto total de la transccion original.
IndustryId: Tipo de industria que esta realizando el checkin ("Hotel", "RentCar", etc).
RoomRate:
RoomTax: Impuestos para esa habitacion.
RoomNo: Numero de habitacion.
ReferenceNo: Numero de referencia.
ProgramIndicator:
CardHolderName: Nombre del tarjetahabiente.
PPIIndicator:
ExtraCharges: Cargos extras.
VisaNoShow:
OriginalTerminalId:
UseAlternateCard:

    
        api.HotelCheckOut(100,18,10,123456,4000000000000077,1220,123,"OK0000",1005,1,"2020-01-01","2020-01-02").then((resp,err)=>{
         console.log(JSON.stringify(resp))
         console.log(JSON.stringify(err))
        })

HotelAdditionalAuth

Este metodo utiliza para realizar autorizacion adicional. A continuacion se listan los parametros requerimientos para este metodo:

Amount (Requerido): Monto total de la transaccion.
Itbis (Requerido): Monto total de impuestos.
Tip: Monto total de la propina.
OrderNumber (Requerido): Numero de orden de la transaccion.
CreditCardNumber (Requerido): Numero completo de la tarjeta.
CreditCardExpiration (Requerido): Fecha de expiracion de la tarjeta en formato mmaa.
CreditCardCVC (Requerido): Codigo de seguridad de la tarjeta.
AuthorizationCode (Requerido): Este campo debemos introducir el numero de aprobacion que recibimos en el response del checkin.
FolioNumber (Requerido): Numero de folio. El mismo que se uso en el checkin.
Duration (Requerido): Duracion de la reservacion en dias, debe coincidir con lo indicado en CheckInDate y CheckOutDate.
CheckInDate (Requerido): Fecha en que se realiza el check-in.
CheckOutDate (Requerido): Fecha en que se realiza el check out.
Installment: Cuotas de la transaccion. Esto solo aplica para tarjetas las cuales posean esta funcionalidad.
UseMultiMessaging: Permite habilitar la funcionalidad de otorgar descuentos. 1 para habilitarlo 0 o null para no utilizar este campo.
PromoData: Permite definir el descuento que desea aplicar al tarjetahabiente utilizando el BIN de la tarjeta en la transaccion.
IndustryId: Tipo de industria que esta realizando el checkin ("Hotel", "RentCar", etc).
RoomRate:
RoomTax: Impuestos para esa habitacion.
RoomNo: Numero de habitacion.
ReferenceNo: Numero de referencia.
ProgramIndicator:
CardHolderName: Nombre del tarjetahabiente.
PPIIndicator:
ExtraCharges: Cargos extras.
VisaNoShow:
OriginalTerminalId:

    
        api.HotelAdditionalAuth(100,18,10,123456,4000000000000077,1220,123,"OK0000",1003,1,"2020-01-01","2020-01-02").then((resp,err)=>{
         console.log(JSON.stringify(resp))
         console.log(JSON.stringify(err))
        })