NodeJS

55min
InstalaciónInstalar el paquete usando:
Node.js
|
npm install mobbex --save
npm install mobbex --save
﻿
RepositorioURL: https://github.com/mobbexco/nodejs﻿
UsoConfiguraciónEl paquete debe ser configurado utilizando la clave API de la aplicación y el Token de Acceso de la entidad dentro de un objeto:
JS
|
const mobbex = require("mobbex");

mobbex.configurations.configure({
  apiKey: "API-KEY",
  accessToken: "ACCESS-TOKEN",
});
const mobbex = require("mobbex");

mobbex.configurations.configure({
  apiKey: "API-KEY",
  accessToken: "ACCESS-TOKEN",
});
﻿
En caso de necesitar utilizar el Audit Key, simplemente se agrega al objeto junto con la clave API y el Token de Acceso:
JS
|
mobbex.configurations.configure({
  apiKey: "API-KEY",
  accessToken: "ACESS-TOKEN",
  auditKey: "AUDIT-KEY",
});
mobbex.configurations.configure({
  apiKey: "API-KEY",
  accessToken: "ACESS-TOKEN",
  auditKey: "AUDIT-KEY",
});
﻿
CheckoutCrearPara crear un checkout se utiliza checkout.create pasando como argumento el objeto del checkout (Ver documentación sobre Checkout):
JS
|
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));
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));
﻿
SplitCheckout con SplitPara realizar un checkout con modalidad split se utiliza checkout.split:
JS
|
const split = {
  total: 1000,
  currency: "ars",
  reference: "12345",
  description: "Descripción de la Venta",
  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));
const split = {
  total: 1000,
  currency: "ars",
  reference: "12345",
  description: "Descripción de la Venta",
  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));
﻿
Liberar FondosPara liberar fondos retenidos durante una operación de tipo Split simplemente se utiliza checkout.release:
JS
|
mobbex.checkout
  .release("ID")
  .then((data) => console.log(data))
  .catch((error) => console.log(error));
mobbex.checkout
  .release("ID")
  .then((data) => console.log(data))
  .catch((error) => console.log(error));
﻿
Ordenes de PagoCrearPara 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):
JS
|
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));
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));
﻿
Métodos de Pago y CuotasListado de Métodos de PagoPara listar los métodos de pago se utiliza sources.list pasando como argumentos el código de acceso y el total:
JS
|
mobbex.sources
  .list("CODIGO", 200)
  .then((data) => console.log(data))
  .catch((error) => console.log(error));
mobbex.sources
  .list("CODIGO", 200)
  .then((data) => console.log(data))
  .catch((error) => console.log(error));
﻿
Códigos de Barra o InsertadosCrearSe utiliza paymentCode.create pasando como argumentos el código y un objeto con los parámetros:
JS
|
mobbex.paymentCode
  .create("CODIGO", {
    reference: "reference",
    total: 3230,
    expiration: "01-12-2020",
  })
  .then((data) => console.log(data))
  .catch((error) => console.log(error));
mobbex.paymentCode
  .create("CODIGO", {
    reference: "reference",
    total: 3230,
    expiration: "01-12-2020",
  })
  .then((data) => console.log(data))
  .catch((error) => console.log(error));
﻿
FidelizaciónPara 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 CuentaSe utiliza loyalty.search pasando como argumento un objeto con la referencia:
JS
|
mobbex.loyalty
  .search({ reference: "mi-referencia" })
  .then((data) => console.log(data))
  .catch((error) => console.log(error));
mobbex.loyalty
  .search({ reference: "mi-referencia" })
  .then((data) => console.log(data))
  .catch((error) => console.log(error));
﻿
Creación de CuentaSe utiliza loyalty.create pasando como argumento el objeto con los parámetros de la nueva cuenta:
JS
|
mobbex.loyalty
  .create({
    identification: "12312312",
    email: "demo@mobbex.com",
    tax_id: "30121231234",
  })
  .then((data) => console.log(data))
  .catch((error) => console.log(error));
mobbex.loyalty
  .create({
    identification: "12312312",
    email: "demo@mobbex.com",
    tax_id: "30121231234",
  })
  .then((data) => console.log(data))
  .catch((error) => console.log(error));
﻿
Balance de CuentaSe utiliza loyalty.balance pasando como argumento un objeto con la credencial:
JS
|
mobbex.loyalty
  .balance({ credential: "123123123" })
  .then((data) => console.log(data))
  .catch((error) => console.log(error));
mobbex.loyalty
  .balance({ credential: "123123123" })
  .then((data) => console.log(data))
  .catch((error) => console.log(error));
﻿
Carga de puntosSe utiliza loyalty.charge pasando como argumento el objeto con la información necesaria:
JS
|
mobbex.loyalty
  .charge({
    credential: "123123123",
    tax_id: "30121231234",
    points: 32,
    reference: "chargeReference",
  })
  .then((data) => console.log(data))
  .catch((error) => console.log(error));
mobbex.loyalty
  .charge({
    credential: "123123123",
    tax_id: "30121231234",
    points: 32,
    reference: "chargeReference",
  })
  .then((data) => console.log(data))
  .catch((error) => console.log(error));
﻿
SuscripcionesCrearPara crear una suscripción se utiliza subscriptions.create pasando como argumento el objeto con la nueva suscripción (ver documentación sobre Suscripciones):
JS
|
const subscription = {
  total: 200.0,
  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));
const subscription = {
  total: 200.0,
  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));
﻿
EditarPara editar una suscripción se pasan como argumentos el ID y un objeto con los cambios:
JS
|
mobbex.subscriptions
  .edit("ID", { total: 300.0 })
  .then((data) => console.log(data))
  .catch((error) => console.log(error));
mobbex.subscriptions
  .edit("ID", { total: 300.0 })
  .then((data) => console.log(data))
  .catch((error) => console.log(error));
﻿
Obtener todasPara obtener todas las suscripciones:
JS
|
mobbex.subscriptions
  .all()
  .then((data) => console.log(data))
  .catch((error) => console.log(error));
mobbex.subscriptions
  .all()
  .then((data) => console.log(data))
  .catch((error) => console.log(error));
﻿
BuscarPara buscar una suscripción:
JS
|
mobbex.subscriptions
  .find("ID")
  .then((data) => console.log(data))
  .catch((error) => console.log(error));
mobbex.subscriptions
  .find("ID")
  .then((data) => console.log(data))
  .catch((error) => console.log(error));
﻿
ActivarPara activar una suscripción:
JS
|
mobbex.subscriptions
  .activate("ID")
  .then((data) => console.log(data))
  .catch((error) => console.log(error));
mobbex.subscriptions
  .activate("ID")
  .then((data) => console.log(data))
  .catch((error) => console.log(error));
﻿
EliminarPara eliminar una suscripción:
JS
|
mobbex.subscriptions
  .delete("ID")
  .then((data) => console.log(data))
  .catch((error) => console.log(error));
mobbex.subscriptions
  .delete("ID")
  .then((data) => console.log(data))
  .catch((error) => console.log(error));
﻿
SuscriptoresPara los ejemplos ID es el ID de la suscripción y SID el ID del suscriptor
CrearPara crear un nuevo suscriptor se utiliza subscribers.create pasando como argumentos el ID de la suscripción y un objeto con el nuevo suscriptor:
JS
|
const subscriber = {
  customer: {
    identification: "32321321",
    email: "demo@mobbex.com",
    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));
const subscriber = {
  customer: {
    identification: "32321321",
    email: "demo@mobbex.com",
    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 los suscriptores de una suscripciónPara obtener todos los usuarios de una suscripción, se pasa como argumento el ID de la suscripción:
JS
|
mobbex.subscribers
  .all("ID")
  .then((data) => console.log(data))
  .catch((error) => console.log(error));
mobbex.subscribers
  .all("ID")
  .then((data) => console.log(data))
  .catch((error) => console.log(error));
﻿
BuscarPara buscar un suscriptor se pasan como argumentos el ID de la suscripción y del suscriptor:
JS
|
mobbex.subscribers
  .find("ID", "SID")
  .then((data) => console.log(data))
  .catch((error) => console.log(error));
mobbex.subscribers
  .find("ID", "SID")
  .then((data) => console.log(data))
  .catch((error) => console.log(error));
﻿
EditarPara 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):
JS
|
moobex.subscribers
  .edit("ID", "SID", {
    total: 300,
    reference: "new_reference",
  })
  .then((data) => console.log(data))
  .catch((error) => console.log(error));
moobex.subscribers
  .edit("ID", "SID", {
    total: 300,
    reference: "new_reference",
  })
  .then((data) => console.log(data))
  .catch((error) => console.log(error));
﻿
Suspender y ActivarPara suspenderlo y activarlo se pasan como argumentos el ID de la suscripción y del suscriptor:
JS
|
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));
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 AgendaPara cambiar su agenda se pasan como argumentos el ID de la suscripción y del suscriptor y un objeto con la fecha de inicio:
JS
|
mobbex.subscribers
  .reschedule("ID", "SID", {
    startDate: {
      day: 15,
      month: 5,
    },
  })
  .then((data) => console.log(data))
  .catch((error) => console.log(error));
mobbex.subscribers
  .reschedule("ID", "SID", {
    startDate: {
      day: 15,
      month: 5,
    },
  })
  .then((data) => console.log(data))
  .catch((error) => console.log(error));
﻿
Mover Suscriptor a otra SuscripciónPara 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:
JS
|
mobbex.subscribers
  .move("ID", "SID", {
    sid: "new_subscription_id",
  })
  .then((data) => console.log(data))
  .catch((error) => console.log(error));
mobbex.subscribers
  .move("ID", "SID", {
    sid: "new_subscription_id",
  })
  .then((data) => console.log(data))
  .catch((error) => console.log(error));
﻿
Dev ConnectCrear SolicitudPara crear una solicitud se utiliza devConnect.create pasando como argumento el objeto con el url de retorno:
JS
|
mobbex.devConnect
  .create({
    return_url: "https://mobbex.com/",
  })
  .then((data) => console.log(data))
  .catch((error) => console.log(error));
mobbex.devConnect
  .create({
    return_url: "https://mobbex.com/",
  })
  .then((data) => console.log(data))
  .catch((error) => console.log(error));
﻿
Obtener CredencialesPara obtener credenciales se utiliza devConnect.get pasando como argumento el ID de la solicitud:
JS
|
mobbex.devConnect
  .get("ID")
  .then((data) => console.log(data))
  .catch((error) => console.log(error));
mobbex.devConnect
  .get("ID")
  .then((data) => console.log(data))
  .catch((error) => console.log(error));
﻿
TransaccionesListar transaccionesSe utiliza transactions.get pasando como argumento la referencia de la factura o pago:
JS
|
mobbex.transactions
  .get("REFERENCIA")
  .then((data) => console.log(data))
  .catch((error) => console.log(error));
mobbex.transactions
  .get("REFERENCIA")
  .then((data) => console.log(data))
  .catch((error) => console.log(error));
﻿
Listado y Búsqueda de TransaccionesSe 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:
JS
|
// POST REQUEST:
mobbex.transactions
  .search({
    // page y limit van dentro del objeto
    // a pesar de ser párametros en URL
    page: 1,
    limit: 10,
    currency: "ARS",
  })
  .then((data) => console.log(data))
  .catch((error) => console.log(error));

// GET REQUEST:
mobbex.transactions
  .search(
    {
      page: 1,
      limit: 10,
      currency: "ARS",
    },
    "get"
  )
  .then((data) => console.log(data))
  .catch((error) => console.log(error));
// POST REQUEST:
mobbex.transactions
  .search({
    // page y limit van dentro del objeto
    // a pesar de ser párametros en URL
    page: 1,
    limit: 10,
    currency: "ARS",
  })
  .then((data) => console.log(data))
  .catch((error) => console.log(error));

// GET REQUEST:
mobbex.transactions
  .search(
    {
      page: 1,
      limit: 10,
      currency: "ARS",
    },
    "get"
  )
  .then((data) => console.log(data))
  .catch((error) => console.log(error));
﻿
Devolución / AnulaciónSe utiliza transactions.refund pasando como argumento el ID de la transacción:
JS
|
mobbex.transactions
  .refund("ID")
  .then((data) => console.log(data))
  .catch((error) => console.log(error));
mobbex.transactions
  .refund("ID")
  .then((data) => console.log(data))
  .catch((error) => console.log(error));
﻿
Devolución ParcialSe utiliza transactions.partialRefund pasando como argumentos el ID de la transacción y el total:
JS
|
mobbex.transactions
  .partialRefund("ID", 200)
  .then((data) => console.log(data))
  .catch((error) => console.log(error));
mobbex.transactions
  .partialRefund("ID", 200)
  .then((data) => console.log(data))
  .catch((error) => console.log(error));
﻿
Capturar OperaciónSe utiliza transactions.capture pasando como argumentos el ID de la transacción y el total:
JS
|
mobbex.transactions
  .capture("ID", 200)
  .then((data) => console.log(data))
  .catch((error) => console.log(error));
mobbex.transactions
  .capture("ID", 200)
  .then((data) => console.log(data))
  .catch((error) => console.log(error));
﻿
﻿
Updated 03 Mar 2023
Did this page help you?
Yes
Operatoria en 2 pasos
Wallet
Docs powered by archbee