Instalación

Instalar el paquete usando:

Repositorio

URL: https://github.com/mobbexco/nodejs

Uso

Configuración

El paquete debe ser configurado utilizando la clave API de la aplicación y el Token de Acceso de la entidad dentro de un objeto:

En caso de necesitar utilizar el Audit Key, simplemente se agrega al objeto junto con la clave API y el Token de Acceso:

Checkout

Crear

Para crear un checkout se utiliza checkout.create pasando como argumento el objeto del checkout (Ver documentación sobre Checkout):

Split

Checkout con Split

Para realizar un checkout con modalidad split se utiliza checkout.split:

Liberar Fondos

Para liberar fondos retenidos durante una operación de tipo Split simplemente se utiliza checkout.release:

Ordenes de Pago

Crear

Para crear una Orden de Pago se utiliza paymentOrder.create pasando como argumento el objeto de la orden de pago (Ver documentación de Órdenes de Pago):

Métodos de Pago y Cuotas

Listado de Métodos de Pago

Para listar los métodos de pago se utiliza sources.list pasando como argumentos el código de acceso y el total:

Códigos de Barra o Insertados

Crear

Se utiliza paymentCode.create pasando como argumentos el código y un objeto con los parámetros:

Fidelización

Para utilizar el módulo de fidelización es necesario configurar un Audit Key. Esto se puede realizar ya sea agregandolo al objeto de configurations.configure o utilizando configurations.setAuditKey('AUDIT-KEY')

Búsqueda de Cuenta

Se utiliza loyalty.search pasando como argumento un objeto con la referencia:

Creación de Cuenta

Se utiliza loyalty.create pasando como argumento el objeto con los parámetros de la nueva cuenta:

Balance de Cuenta

Se utiliza loyalty.balance pasando como argumento un objeto con la credencial:

Carga de puntos

Se utiliza loyalty.charge pasando como argumento el objeto con la información necesaria:

Suscripciones

Crear

Para crear una suscripción se utiliza subscriptions.create pasando como argumento el objeto con la nueva suscripción (ver documentación sobre Suscripciones):

Editar

Para editar una suscripción se pasan como argumentos el ID y un objeto con los cambios:

Obtener todas

Para obtener todas las suscripciones:

Buscar

Para buscar una suscripción:

Activar

Para activar una suscripción:

Eliminar

Para eliminar una suscripción:

Suscriptores

Para los ejemplos ID es el ID de la suscripción y SID el ID del suscriptor

Crear

Para crear un nuevo suscriptor se utiliza subscribers.create pasando como argumentos el ID de la suscripción y un objeto con el nuevo suscriptor:

Obtener todos los suscriptores de una suscripción

Para obtener todos los usuarios de una suscripción, se pasa como argumento el ID de la suscripción:

Buscar

Para buscar un suscriptor se pasan como argumentos el ID de la suscripción y del suscriptor:

Editar

Para editar un suscriptor se pasan como argumentos el ID de la suscripción y del suscriptor y un objeto con los nuevos parámetros. (Los parámetros son opcionales):

Suspender y Activar

Para suspenderlo y activarlo se pasan como argumentos el ID de la suscripción y del suscriptor:

Cambiar Agenda

Para cambiar su agenda se pasan como argumentos el ID de la suscripción y del suscriptor y un objeto con la fecha de inicio:

Mover Suscriptor a otra Suscripción

Para moverlo a otra suscripción se pasan como argumentos el ID de la suscripción y del suscriptor y un objeto con el ID de la nueva suscripción:

Dev Connect

Crear Solicitud

Para crear una solicitud se utiliza devConnect.create pasando como argumento el objeto con el url de retorno:

Obtener Credenciales

Para obtener credenciales se utiliza devConnect.get pasando como argumento el ID de la solicitud:

Transacciones

Listar transacciones

Se utiliza transactions.get pasando como argumento la referencia de la factura o pago:

Listado y Búsqueda de Transacciones

Se utiliza transactions.search pasando como argumento el objeto con los parámetros de búsqueda. Por defecto se realiza un POST request, pero si se quiere realizar un GET request, se agrega 'get' como segundo parametro:

Devolución / Anulación

Se utiliza transactions.refund pasando como argumento el ID de la transacción:

Devolución Parcial

Se utiliza transactions.partialRefund pasando como argumentos el ID de la transacción y el total:

Capturar Operación

Se utiliza transactions.capture pasando como argumentos el ID de la transacción y el total: