SDK
NodeJS
41min
instalación instalar el paquete usando npm install mobbex save repositorio url https //github com/mobbexco/nodejs 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 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 mobbex configurations configure({ apikey "api key", accesstoken "acess token", auditkey "audit key", }); checkout crear para crear un checkout se utiliza checkout create pasando como argumento el objeto del checkout (ver documentación sobre 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", 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 fondos para liberar fondos retenidos durante una operación de tipo split simplemente se utiliza checkout release mobbex checkout release("id") then((data) => console log(data)) catch((error) => console log(error)); 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 ) 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 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 mobbex sources list("codigo", 200) then((data) => console log(data)) catch((error) => console log(error)); códigos de barra o insertados crear se utiliza paymentcode create pasando como argumentos el código y un objeto con los parámetros mobbex paymentcode create("codigo", { reference "reference", total 3230, expiration "01 12 2020", }) then((data) => console log(data)) catch((error) => console log(error)); 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 mobbex loyalty search({ reference "mi referencia" }) then((data) => console log(data)) catch((error) => console log(error)); creación de cuenta se utiliza loyalty create pasando como argumento el objeto con los parámetros de la nueva cuenta mobbex loyalty create({ identification "12312312", email "demo\@mobbex com", tax id "30121231234", }) then((data) => console log(data)) catch((error) => console log(error)); balance de cuenta se utiliza loyalty balance pasando como argumento un objeto con la credencial mobbex loyalty balance({ credential "123123123" }) then((data) => console log(data)) catch((error) => console log(error)); carga de puntos se utiliza loyalty charge pasando como argumento el objeto con la información necesaria mobbex loyalty charge({ credential "123123123", tax id "30121231234", points 32, reference "chargereference", }) then((data) => console log(data)) catch((error) => console log(error)); 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 ) 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)); editar para editar una suscripción se pasan como argumentos el id y un objeto con los cambios mobbex subscriptions edit("id", { total 300 0 }) then((data) => console log(data)) catch((error) => console log(error)); obtener todas para obtener todas las suscripciones mobbex subscriptions all() then((data) => console log(data)) catch((error) => console log(error)); buscar para buscar una suscripción mobbex subscriptions find("id") then((data) => console log(data)) catch((error) => console log(error)); activar para activar una suscripción mobbex subscriptions activate("id") then((data) => console log(data)) catch((error) => console log(error)); eliminar para eliminar una suscripción mobbex subscriptions delete("id") then((data) => console log(data)) catch((error) => console log(error)); 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 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ón para obtener todos los usuarios de una suscripción, se pasa como argumento el id de la suscripción mobbex subscribers all("id") then((data) => console log(data)) catch((error) => console log(error)); buscar para buscar un suscriptor se pasan como argumentos el id de la suscripción y del suscriptor mobbex subscribers find("id", "sid") then((data) => console log(data)) catch((error) => console log(error)); 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) moobex subscribers edit("id", "sid", { total 300, reference "new reference", }) then((data) => console log(data)) catch((error) => console log(error)); suspender y activar para suspenderlo y activarlo se pasan como argumentos el id de la suscripción y del suscriptor 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 argumentos el id de la suscripción y del suscriptor 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 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 mobbex subscribers move("id", "sid", { sid "new subscription id", }) then((data) => console log(data)) catch((error) => console log(error)); dev connect crear solicitud para crear una solicitud se utiliza devconnect create pasando como argumento el objeto con el url de retorno mobbex devconnect create({ return url "https //mobbex com/", }) then((data) => console log(data)) catch((error) => console log(error)); obtener credenciales para obtener credenciales se utiliza devconnect get pasando como argumento el id de la solicitud mobbex devconnect get("id") then((data) => console log(data)) catch((error) => console log(error)); transacciones listar transacciones se utiliza transactions get pasando como argumento la referencia de la factura o pago mobbex transactions get("referencia") then((data) => console log(data)) catch((error) => console log(error)); 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 // 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ón se utiliza transactions refund pasando como argumento el id de la transacción mobbex transactions refund("id") then((data) => console log(data)) catch((error) => console log(error)); devolución parcial se utiliza transactions partialrefund pasando como argumentos el id de la transacción y el total mobbex transactions partialrefund("id", 200) then((data) => console log(data)) catch((error) => console log(error)); capturar operación se utiliza transactions capture pasando como argumentos el id de la transacción y el total mobbex transactions capture("id", 200) then((data) => console log(data)) catch((error) => console log(error));