webpolis / mobbex-node

Mobbex Integration Package

Mobbex

Instalación

Instalar el paquete usando:

npm install mobbex --save

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:

const mobbex = require('mobbex')

mobbex.configurations.configure({
    apiKey: 'API-KEY',
    accessToken: 'ACCESS-TOKEN'
})

Checkout

Crear

Para crear un checkout se utiliza checkout.create pasando como parametro el objeto del checkout:

const checkout =
{
  total: 100.2,
  currency: "ARS",
  reference: "2982-2XtPXlgSaWccqUyobuv4sEmLYMV0N6oX6MoridMw",
  description: "Descripción de la Venta",
  items: [
    {
      image: "https://www.mobbex.com/wp-content/uploads/2019/03/web_logo.png",
      quantity: 2,
      description: "Mi Producto",
      total: 50,
    },
    {
      image: "https://www.mobbex.com/wp-content/uploads/2019/03/web_logo.png",
      quantity: 1,
      description: "Mi otro producto",
      total: 50.2,
    }],
  options: {
    domain: "midominio.com",
  },
  return_url: "https://mobbex.com/sale/return?session=56789",
  webhook: "https://mobbex.com/sale/webhook?user=1234"
}

mobbex.checkout.create(checkout)
    .then(data => console.log(data))
    .catch(error => console.log(error))

Split

Checkout con Split

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

const split =
{
  total: 1000,
  currency: "ars",
  reference: "12345",
  split: [
    {
      tax_id: "30121231235",
      total: 900,
      reference: "pago_1",
      fee: 100
    },
    {
      tax_id: "33213213216",
      total: 100,
      reference: "pago_2",
      fee: 80
    }
  ]
}

mobbex.checkout.split(split)
    .then(data => console.log(data))
    .catch(error => console.log(error))

Ordenes de Pago

Crear

Para crear un checkout se utiliza paymentOrder.create pasando como parametro el objeto de la orden de pago:

paymentOder =
{
  total: 100,
  description: "Some Description #3",
  actions: [
    {
      icon: "attachment",
      title: "Factura",
      url: "https://speryans.com/mifactura/123"
    }
  ],
  reference: "mi_referencia_123"
}

mobbex.paymentOrder.create(paymentOrder)
    .then(data => console.log(data))
    .catch(error => console.log(error))

Subscripciones

Crear

Para crear una subscripción se utiliza subscriptions.create pasando como parametro el objeto con la nueva subscripción:

const subscription =
{
  total: 200.00,
  currency: 'ARS',
  name: 'Prueba',
  description: 'Prueba',
  type: 'dynamic',
  interval: '1m',
  trial: 1,
  limit: 0,
  webhook: 'http://webhook',
  return_url: 'http://return_url',
  features: ['accept_no_funds']
}

mobbex.subscriptions.create(subscripcion)
    .then(data => console.log(data))
    .catch(error => console.log(error))

Editar

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

mobbex.subscriptions.edit('ID', {total: 300.00})
    .then(data => console.log(data))
    .catch(error => console.log(error))

Obtener todas

Para obtener todas las subscripciones:

mobbex.subscriptions.all()
    .then(data => console.log(data))
    .catch(error => console.log(error))

Buscar

Para buscar una subscripción:

mobbex.subscriptions.find('ID')
    .then(data => console.log(data))
    .catch(error => console.log(error))

Activar

Para activar una subscripción:

mobbex.subscriptions.activate('ID')
    .then(data => console.log(data))
    .catch(error => console.log(error))

Eliminar

PAra eliminar una subscripción:

mobbex.subscriptions.delete('ID')
    .then(data => console.log(data))
    .catch(error => console.log(error))

Susbscriptores

Para los ejemplos ID es el ID de la subscripción y SID el ID del subscriptor

Crear

Para crear un nuevo subscriptor se utiliza subscribers.create pasando como parametros el ID de la subscripción y un objeto con el nuevo subscriptor:

const subscriber =
{
  customer: {
    identification: "32321321",
    email: "[e-mail]",
    name: "Demo User"
    },
  startDate: {
    day: 15,
    month: 5
    },
  reference: "demo_user_321"
}

mobbex.subscribers.create('ID', subscriber)
    .then(data => console.log(data))
    .catch(error => console.log(error))

Obtener todos

Para obtener todos los usarios de una subscripción se pasa como parametro el ID de la subscripción:

mobbex.subscribers.all('ID')
    .then(data => console.log(data))
    .catch(error => console.log(error))

Buscar

Para buscar un subscriptor se pasan como parametros el ID de la subscripción y del subscriptor:

mobbex.subscribers.find('ID', 'SID')
    .then(data => console.log(data))
    .catch(error => console.log(error))

Editar

Para editar un subscriptor se pasan como parametros el ID de la subscripción y del subscriptor y un objeto con los nuevos parametros. (Los parametros son opcionales):

moobex.subscribers.edit('ID', 'SID', {
    total: 300,
    reference: 'new_reference'
})
    .then(data => console.log(data))
    .catch(error => console.log(error))

Suspender y Actiar

Para suspenderlo y activarlo se pasan como parametros el ID de la subscripción y del subscriptor:

mobbex.subscribers.suspend('ID', 'SID')
    .then(data => console.log(data))
    .catch(error => console.log(error))

mobbex.subscribers.activate('ID', 'SID')
    .then(data => console.log(data))
    .catch(error => console.log(error))

Cambiar Agenda

Para cambiar su agenda se pasan como parametros el ID de la subscripción y del subscriptor y un objeto con la fecha de inicio:

mobbex.subscribers.reschedule('ID', 'SID', {
    startDate: {
        day: 15,
        month: 5
    }
})
    .then(data => console.log(data))
    .catch(error => console.log(error))

Mover a otra subscripción

Para moverlo a otra subscripción se pasan como parametros el ID de la subscripción y del subscriptor y un objeto con el ID de la nueva subscripción:

mobbex.subscribers.move('ID', 'SID', {
    sid: 'new_subscription_id'
})
    .then(data => console.log(data))
    .catch(error => console.log(error))