@clavisco/pinpad
v0.0.1
Published
**Token**: `PinPad` > Engloba un conjunto de funcionalidades y servicios para el uso e implementacion del pinpad.
Downloads
26
Readme
Acerca de @clavisco/pinpad
Token: PinPad
Engloba un conjunto de funcionalidades y servicios para el uso e implementacion del pinpad.
¿Qué resuelve?
Habilita un entorno general que permite comunicarse con los servicios del pinpad y realizar los procesos correctos de transaccionalidad.
Dependencias
Resumen de version
Características (Features)
- Respaldo de transacciones incompletas
Servicio de pinpad
Métodos disponibles
- RequestPaymentTransaction(_args: { charge: PinPad.Interfaces.ICharge }): Respuesta de tipo string otorgada por el servicio de pinpad al completar una solicitud de transaccion
- charge: Objeto definido del tipo PinPad.Interfaces.ICharge para aplicar un cargo o transaccion sobre pinpad
- VoidTransaction(_args: { transaction: PinPad.Interfaces.ICommitedTransaction }): Respuesta de tipo string otorgada por el servicio de pinpad al completar una solicitud de cancelación
- transaction: Objeto definido del tipo PinPad.Interfaces.ICommitedTransaction para aplicar una cancelacion o reversion de transaccion
- PrintVoidedVoucher(_args: { documentKey: string, rawData: string, headers?: HttpHeaders }): Repuesta del endpoint de impresion de voucher de cancelacion definido previamente
- documentKey: identificador del documento para buscar la data de cancelacion
- rawData: datos para crear el reporte previamente formateados mediante la funcion FormatVoidedRawData
- headers: otras cabeceras requeridas segun la implementación, estas cabeceras son opcionales
- FormatVoidedRawData(_args: { terminalId: string, amount: number, invoiceNumber: string, referenceNumber: string, systemTraceNumber: string, authorizationNumber: string, currency: string, creationDateTime: Date }): Resultado tipo string con los datos formateados para enviar a la función de voucher de cancelación
- terminalId: codigo de identificacion del terminal usado
- amount: monto de la transaccion a cancelar
- invoiceNumber número de factura utilizado para la transaccion actual
- referenceNumber número de referencia utilizado en el pinpad
- systemTraceNumber número de sistema utilizado en el pinpad
- authorizationNumber número de autorización facilitado por el pinpad
- currency: moneda utlizada para la transacción
- creationDateTime: fecha de creacion para mostrar en el voucher
- BackupTransactions(_args: { headers?: HttpHeaders }): Repuesta del endpoint de backup de transacciones incompletas definido previamente
- headers: otras cabeceras requeridas segun la implementación, estas cabeceras son opcionales
¿Cómo lo uso?
- Primero debemos cumplir las depencias mencionadas al inicio de este documento
- Ejecutar el comando `npm i @clavisco/pinpad en el directorio root del proyecto
- Importalo en el app.module.ts o en el modulo donde desee utilizarlo.
- Inyectar el servicio en el controlador donde queremos utlizar las funcionalidades de pinpad
constructor(private pinpadService: PinpadService)
- Ejemplo de implementación del componente en el template html, es requerido implementar este componente si queremos realizar el respaldo automatizado
<cl-pinpad></cl-pinpad>
- Debe agregar las siguientes configuraiones para poder utlizar los metodos de creacion, cancelacion, impresion de vouchers y respaldo de transacciones incompletas
Repository.Behavior.SetTokenConfiguration({ token: 'Share', setting: 'apiURL', value: 'example.clavisco.com' }); Repository.Behavior.SetTokenConfiguration({ token: 'PinPad', setting: 'apiURL', value: 'localhost:8080' }); Repository.Behavior.SetTokenConfiguration({ token: 'PinPad', setting: 'voidedVoucherPath', value: '/api/PPStoredTransaction' }); Repository.Behavior.SetTokenConfiguration({ token: 'PinPad', setting: 'backupTransactionsPath', value: '/api/PPStoredTransaction' });
- Puede agregar la siguiente configuración para definir el intervalo de tiempo entre sincronizacionde transacciones no completadas, si no la agrega el valor por defecto son 5 minutos (300000 ms)
Repository.Behavior.SetTokenConfiguration({ token: 'PinPad', setting: 'backupTransactionsInterval', value: '600000' });
- Ya con esto tenemos una implementación básica con el uso de pinpad y servicio de respaldo de transacciones
Clavis Consultores ©