Suscriptores
16 min
Obtener Suscriptores
Esa API permite obtener todos los suscriptores de una suscripción
GET
https://api.mobbex.com/p/subscriptions/{id}/subscriber?page={page}
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function() {
if(this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("GET", "https://api.mobbex.com/p/subscriptions/qLLSnBV35/subscriber?page=0");
xhr.setRequestHeader("x-api-key", "zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj");
xhr.setRequestHeader("x-access-token", "d31f0721-2f85-44e7-bcc6-15e19d1a53cc");
xhr.send();Crear Suscriptor
Permite crear un suscriptor para una determinada suscripción
POST
https://api.mobbex.com/p/subscriptions/{id}/subscriber
var data = JSON.stringify({
"customer":{
"email":"[email protected]",
"identification":"12123123",
"name":"Test Mobbex"
},
"startDate":{
"day":27,
"month":3,
"year":2021
},
"reference":"233211212"});
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function() {
if(this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("POST", "https://api.mobbex.com/p/subscriptions/T691POMK62SGC7CHAK/subscriber");
xhr.setRequestHeader("x-api-key", "zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj");
xhr.setRequestHeader("x-access-token", "d31f0721-2f85-44e7-bcc6-15e19d1a53cc");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.send(data);Valores importantes en la respuesta:
- sourceUrl: URL a la que debe enviar al usuario a añadir la Tarjeta
- subscriberUrl: URL de Control del Suscriptor.
Obtener Suscriptor
Permite ver un suscriptor en particular en base al ID de suscripción y ID del suscriptor
GET
https://api.mobbex.com/p/subscriptions/{id}/subscriber/{sid}
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function() {
if(this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("GET", "https://api.mobbex.com/p/subscriptions/T691POMK62SGC7CHAK/subscriber/Y7B3P541B9VFBYTHSZ");
xhr.setRequestHeader("x-api-key", "zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj");
xhr.setRequestHeader("x-access-token", "d31f0721-2f85-44e7-bcc6-15e19d1a53cc");
xhr.send();Editar Suscriptor
POST
https://api.mobbex.com/p/subscriptions/{id}/subscriber/{sid}
curl --location --request POST 'https://api.mobbex.com/p/subscriptions/abc123/subscriber/def456' \
--header 'x-api-key: zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj' \
--header 'x-access-token: d31f0721-2f85-44e7-bcc6-15e19d1a53cc' \
--header 'Content-Type: application/json' \
--data-raw '{
"customerData": {
"name": "Cliente Demo"",
"phone": "12123123"
}
}'
Cambiar estado del suscriptor
Activar Suscriptor
Permite re-activar los cobros a un suscriptor en particular
POST
https://api.mobbex.com/p/subscriptions/${uid}/subscriber/${sid}/action/activate
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function() {
if(this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("POST", "https://api.mobbex.com/p/subscriptions/T691POMK62SGC7CHAK/subscriber/Y7B3P541B9VFBYTHSZ/action/activate");
xhr.setRequestHeader("x-api-key", "zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj");
xhr.setRequestHeader("x-access-token", "d31f0721-2f85-44e7-bcc6-15e19d1a53cc");
xhr.send();Suspender Suscriptor
Permite suspender los cobros que se realicen a un suscriptor en particular
POST
https://api.mobbex.com/p/subscriptions/${uid}/subscriber/${sid}/action/suspend
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function() {
if(this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("POST", "https://api.mobbex.com/p/subscriptions/T691POMK62SGC7CHAK/subscriber/Y7B3P541B9VFBYTHSZ/action/suspend");
xhr.setRequestHeader("x-api-key", "zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj");
xhr.setRequestHeader("x-access-token", "d31f0721-2f85-44e7-bcc6-15e19d1a53cc");
xhr.send();Eliminar Suscriptor
Permite suspender los cobros que se realicen a un suscriptor en particular
DELETE
https://api.mobbex.com/p/subscriptions/${uid}/subscriber/${sid}/action/delete
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function() {
if(this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("DELETE", "https://api.mobbex.com/p/subscriptions/T691POMK62SGC7CHAK/subscriber/Y7B3P541B9VFBYTHSZ/action/delete");
xhr.setRequestHeader("x-api-key", "zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj");
xhr.setRequestHeader("x-access-token", "d31f0721-2f85-44e7-bcc6-15e19d1a53cc");
xhr.send();Cambiar Agenda del Suscriptor
Modificar Agenda
Esta acción re-generará toda la agenda del suscriptor basado en la fecha de inicio indicada.
POST
https://api.mobbex.com/p/subscriptions/{id}/subscriber/{sid}/action/reschedule
var data = JSON.stringify({"startDate":{"day":25,"month":4,"year":2021}});
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function() {
if(this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("POST", "https://api.mobbex.com/p/subscriptions/T691POMK62SGC7CHAK/subscriber/Y7B3P541B9VFBYTHSZ/action/reschedule");
xhr.setRequestHeader("x-api-key", "zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj");
xhr.setRequestHeader("x-access-token", "d31f0721-2f85-44e7-bcc6-15e19d1a53cc");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.send(data);Mover Suscriptor a otra Suscripción
Tenga en cuenta que sólo se podrá mover un suscriptor a otra suscripción dentro de la misma entidad. Durante el proceso de mover al suscriptor la agenda del mismo será recalculada cuando la suscripción sea "dynamic"
Mover Suscriptor
POST
https://api.mobbex.com/p/subscriptions/{id}/subscriber/{sid}/action/move
var data = JSON.stringify({"sid":"R89BLVMZRPDH3GMRH9"});
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function() {
if(this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("POST", "https://api.mobbex.com/p/subscriptions/T691POMK62SGC7CHAK/subscriber/Y7B3P541B9VFBYTHSZ/action/move");
xhr.setRequestHeader("x-api-key", "zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj");
xhr.setRequestHeader("x-access-token", "d31f0721-2f85-44e7-bcc6-15e19d1a53cc");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.send(data);
Ejecuciones
Ejecutar Suscripción Manualmente
GET
https://api.mobbex.com/p/subscriptions/{id}/subscriber/{sid}/execution
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function() {
if(this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("GET", "https://api.mobbex.com/p/subscriptions/T691POMK62SGC7CHAK/subscriber/Y7B3P541B9VFBYTHSZ/execution");
xhr.setRequestHeader("x-api-key", "zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj");
xhr.setRequestHeader("x-access-token", "d31f0721-2f85-44e7-bcc6-15e19d1a53cc");
xhr.send();Ejecutar Suscripción Manualmente con Monto Diferenciado
El monto con el que se ejecuta la suscripción puede ser diferente al definido en la suscripción o el suscriptor.
POST
https://api.mobbex.com/p/subscriptions/{id}/subscriber/{sid}/execution
var data = JSON.stringify({"total":150,"reference":"230320211305","description":"Cobro con una descripción diferente"});
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function() {
if(this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("POST", "https://api.mobbex.com/p/subscriptions/R89BLVMZRPDH3GMRH9/subscriber/Y7B3P541B9VFBYTHSZ/execution");
xhr.setRequestHeader("x-api-key", "zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj");
xhr.setRequestHeader("x-access-token", "d31f0721-2f85-44e7-bcc6-15e19d1a53cc");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.send(data);Ejecutar cobros manuales masivamente
Permite ejecutar cobros masivos dentro de una misma suscripción. Tenga en cuenta que esta API solamente retornará que el proceso fue aceptado exitosamente. La ejecución se realizará de fondo y se notificará via Webhooks.
POST
https://api.mobbex.com/p/subscriptions/{id}/action/execute
var data = JSON.stringify([
{"sid":"Y7B3P541B9VFBYTHSZ","total":10,"reference":"230320211348"}
]);
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function() {
if(this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("POST", "https://api.mobbex.com/p/subscriptions/R89BLVMZRPDH3GMRH9/action/execute");
xhr.setRequestHeader("x-api-key", "zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj");
xhr.setRequestHeader("x-access-token", "d31f0721-2f85-44e7-bcc6-15e19d1a53cc");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.send(data);Programar una ejecución a futuro
POST
https://api.mobbex.com/p/subscriptions/{id}/subscriber/{sid}/action/schedule
var data = JSON.stringify({
"date": {
"day": 10,
"month": 4,
"year": 2021
}
});
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function() {
if(this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("POST", "https://api.mobbex.com/p/subscriptions/u5485JkgTy/subscriber/5sfTy4iPlT/action/schedule");
xhr.setRequestHeader("x-api-key", "zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj");
xhr.setRequestHeader("x-access-token", "d31f0721-2f85-44e7-bcc6-15e19d1a53cc");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.send(data);Acciones sobre una ejecución
Reintentar una Ejecución
GET
https://api.mobbex.com/p/subscriptions/{id}/subscriber/{sid}/execution/{eid}/action/retry
var data = JSON.stringify({"date":{"day":28,"month":5,"year":2021}});
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function() {
if(this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("POST", "https://api.mobbex.com/p/subscriptions/R89BLVMZRPDH3GMRH9/subscriber/Y7B3P541B9VFBYTHSZ/execution/JS73P5HG8AVFBYT45Z/action/retry");
xhr.setRequestHeader("x-api-key", "zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj");
xhr.setRequestHeader("x-access-token", "d31f0721-2f85-44e7-bcc6-15e19d1a53cc");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.send(data);Marcar una ejecución como Paga
GET
https://api.mobbex.com/p/subscriptions/{id}/subscriber/{sid}/execution/{eid}/action/paid
fetch("https://api.cakes.com", {
"method": "GET",
"headers": {
"Accept": "application/json"
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});WebHooks
Los webhooks siempre serán enviados en formato application/x-www-form-urlencoded
Nueva Suscripción
{
"type": "subscription:registration",
"data": {
"result": true,
"view": {
"type": "card"
},
"payment": {
"id": "ABABBB78798",
"description": "Esto es un registro!",
"operation": {
"type": "payment.v2"
},
"status": {
"code": "201",
"data": {},
"message": "Validada",
"resultCode": "00",
"text": "Aceptado",
"view": "default"
},
"total": 14.3,
"currency": {
"code": "ARS",
"text": "Peso Argentino",
"symbol": "$"
},
"riskAnalysis": {
"band": "N/A",
"level": "N/A"
},
"created": "2020-12-02T18:12:11.122Z",
"updated": "2020-12-02T18:12:12.768Z",
"reference": "extenal_reference",
"source": {
"name": "Visa Débito",
"type": "card",
"reference": "visa.debit",
"number": "4515 00** **** 1234",
"expiration": {
"month": "01",
"year": "26"
},
"installment": {
"description": "Débito",
"amount": 14.3,
"count": 1,
"reference": "1"
}
}
},
"entity": {
"name": "Demo Entity",
"uid": "demo_entity"
},
"customer": {
"uid": "12123123",
"name": "Juan Perez Wayne",
"phone": "12123123",
"identification": "110303456",
"email": "[email protected]"
},
"user": {
"name": "Juan Perez Wayne",
"email": "[email protected]"
},
"source": {
"name": "Visa Débito",
"type": "card",
"reference": "visa.debit"
},
"subscription": {
"uid": "DRXR14KIUC4V8TFBRL",
"interval": "1m",
"limit": 4,
"name": "El nombre de mi suscripción",
"description": "Esto es GENIAL",
"reference": "external_reference",
"total": 1595
},
"subscriber": {
"uid": "RLY80US2JZ8ZHTSCPH",
"reference": "3447",
"customer": {
"identification": "12123123",
"email": "[email protected]",
"name": "Juan Perez Wayne"
}
},
"context": {
"status": "success"
},
"execution": {}
}
}Cambio de Método de Pago
{
"type": "subscription:change_source",
"data": {
"result": true,
"view": {
"type": "card"
},
"payment": {
"id": "ABC123123",
"description": "Validación de Tarjeta.",
"operation": {
"type": "payment.v2"
},
"status": {
"code": "410",
"text": "Denegada, Fondos insuficientes",
"message": "Denegada, fondos insuficientes. (Cod. 51)"
},
"total": 17.15,
"currency": {
"code": "ARS",
"text": "Peso Argentino",
"symbol": "$"
},
"riskAnalysis": {
"band": "N/A",
"level": "N/A"
},
"created": "2020-12-02T11:31:56.544Z",
"updated": "2020-12-02T11:31:58.243Z",
"reference": "external_reference",
"source": {
"name": "Visa",
"type": "card",
"reference": "visa",
"number": "4515 00** **** 1234",
"expiration": {
"month": "01",
"year": "24"
},
"installment": {
"description": "1 Cuota",
"amount": 17.15,
"count": 1,
"reference": "1"
}
}
},
"entity": {
"name": "Demo Entity",
"uid": "demo_entity"
},
"customer": {
"uid": "12123123",
"name": "Juan Perez Wayne",
"phone": "12123123",
"identification": "110303456",
"email": "[email protected]"
},
"user": {
"name": "Juan Perez Wayne",
"email": "[email protected]"
},
"source": {
"name": "Visa",
"type": "card",
"reference": "visa"
},
"subscription": {
"uid": "4546465465465",
"interval": "1m",
"limit": 0,
"name": "Mi Suscripción",
"description": "Débitos automáticos? Todavía existe eso?",
"reference": "external_reference",
"total": 8000.14
},
"subscriber": {
"uid": "Fvon4enAv5",
"reference": "5defe0af-e9be-4288-bed1-423a5cc41920",
"customer": {
"email": "[email protected]",
"name": "Juan Perez Wayne",
"identification": "12123123",
"phone": "1112341234"
}
},
"context": {
"status": "success"
},
"execution": {}
}
}
}Suscripción Ejecutada
El servicio para este Webhook utiliza los webhooks estandares descriptos en la sección Webhooks de esta documentación agregando los nodos "subscription" y "subscriber"
{
"data": {
"context": {
"status": "success"
},
"customer": {
"email": "[email protected]",
"formatted_phone": "+541130170412",
"identification": "123123132",
"name": "Juan Perez Wayne",
"phone": "130170412"
},
"entity": {
"name": "CUENTA DEMO",
"uid": "H1rJEXyr"
},
"execution": {
"created": "2025-03-18T14:31:00.275Z",
"currency": "ARS",
"date": "2025-03-18T14:31:00.275Z",
"reference": "2303202113481",
"source": "primary",
"test": false,
"total": 1000,
"type": "manual",
"uid": "RPJX6VCD5OKST5AKLE"
},
"payment": {
"created": "2025-03-18T14:31:17.990Z",
"currency": {
"code": "TEST",
"exponent": 2,
"locale": "es",
"symbol": "T$",
"text": "Test Money"
},
"description": "Cobro Ejecutado",
"id": "ANDECH2KGUKYW3LSF2EVPL",
"operation": {
"type": "payment.v2"
},
"reference": "2303202113481",
"requestedCurrency": {
"code": "TEST",
"exponent": 2,
"locale": "es",
"symbol": "T$",
"text": "Test Money"
},
"requestedTotal": 1000,
"riskAnalysis": {
"band": "N/A",
"level": "N/A"
},
"source": {
"cardholder": {
"identification": "12123123",
"name": "DEMO"
},
"expiration": {
"month": "12",
"year": "34"
},
"installment": {
"amount": 1000,
"count": 1,
"description": "1",
"reference": "",
"tags": [],
"uid": ""
},
"name": "Visa",
"number": "45079831****2450",
"reference": "visa",
"transaction": {
"acquirer": "",
"authorizationCode": "175085",
"batchNo": "482",
"merchantNo": "07127489",
"resultCode": "00",
"retrievalReferenceNo": "504881361344",
"ticketNo": "8078",
"transactionId": "ANDECH2KGUKYW3LSF2EVPL"
},
"type": "card",
"variant": "credit"
},
"status": {
"code": "200",
"data": {},
"message": "Transacción Aprobada",
"resultCode": "00",
"text": "Aprobado",
"view": "default"
},
"total": 1000,
"updated": "2025-03-18T14:31:18.070Z"
},
"result": true,
"source": {
"name": "Visa",
"reference": "visa",
"type": "card"
},
"subscriber": {
"customer": {
"email": "[email protected]",
"formatted_phone": "+541130170412",
"identification": "123123132",
"name": "Juan Perez Wayne",
"phone": "130170412"
},
"reference": "DDCBE5GZ2R8IAE6V6X",
"uid": "DDCBE5GZ2R8IAE6V6X"
},
"subscription": {
"description": "Prueba suscripción",
"interval": "1m",
"limit": ,
"name": "PRUEBA",
"reference": "12345678098",
"total": 550,
"uid": "TT6XTS3C7SB220BG7H"
},
"view": {
"type": "card"
}
},
"type": "subscription:execution"
}Suscriptor Suspendido
{
"type": "subscription:subscriber:suspended",
"data": {
"subscription": {
"uid": "JmfI3Ml3D",
"interval": "1m",
"limit": 0,
"name": "Nombre de la Suscripción",
"description": "Descripción de la Suscripción",
"total": 500
},
"subscriber": {
"uid": "qy82noStM",
"reference": "qy82noStM",
"customer": {
"name": "Juan Batman",
"identification": "999999",
"email": "[email protected]"
}
}
}
}Suscriptor Activado
{
"type": "subscription:subscriber:active",
"data": {
"subscription": {
"uid": "JmfI3Ml3D",
"interval": "1m",
"limit": 0,
"name": "Nombre de la Suscripción",
"description": "Descripción de la Suscripción",
"total": 500
},
"subscriber": {
"uid": "qy82noStM",
"reference": "qy82noStM",
"customer": {
"name": "Juan Batman",
"identification": "999999",
"email": "[email protected]"
}
}
}
}