--- title: Suscriptores slug: suscriptores description: Learn how to interact with the Mobbex API using JavaScript, PHP, and Python with this comprehensive document. Discover code examples for creating, retrieving, editing, and deleting subscribers, as well as executing subscriptions and handling webhooks. Plu icon: {"faIcon":"fa-solid fa-user-group"} docTags: createdAt: 2021-01-25T14:18:53.000Z --- :::ApiMethodV2 ```json { "tab": "request", "url": "https://api.unicobros.com.ar/p/subscriptions/{id}/subscriber?page={page}", "name": "Obtener Suscriptores", "method": "GET", "request": { "pathParameters": [ { "kind": "required", "name": "id", "type": "string", "description": "ID de la suscripción" } ], "queryParameters": [ { "kind": "required", "name": "page", "type": "string", "description": "Número de página a mostrar iniciando desde 0" }, { "kind": "optional", "name": "search", "type": "string", "description": "Permite buscar suscriptores por el valor de alguno de sus campos." } ], "headerParameters": [ { "kind": "required", "name": "x-api-key", "type": "string", "description": "Clave API de su aplicación." }, { "kind": "required", "name": "x-access-token", "type": "string", "description": "Token de Acceso a la entidad para la cual desea realizar la operación." } ], "bodyDataParameters": [], "formDataParameters": [] }, "results": { "languages": [ { "id": "ET-ejMRAdIyvwQsk3nfLp", "code": "{\n \"result\": true,\n \"data\": {\n \"docs\": [\n {\n \"uid\": \"SdV72h~Mf\",\n \"reference\": \"20-38650650-8\",\n \"total\": 2555,\n \"subscription\": {\n \"uid\": \"qLLSnBV35\",\n \"limit\": 3,\n \"entity\": {\n \"name\": \"Demo\",\n \"email\": \"demo@unicobros.com\",\n \"logo\": {\n \"filename\": \"demo-entity_logo_1467046687494.png\",\n \"originalname\": \"app_icon_white_shadow_short.png\",\n \"path\": \"\",\n \"size\": 184658,\n \"filetype\": \"image/png\",\n \"url\": \"//unicobros.s3.amazonaws.com/demo-entity_logo_1467046687494.png\",\n \"created\": \"2017-03-29T03:11:19.000Z\",\n \"sizes\": [],\n \"versions\": [],\n \"extension\": \"\",\n \"mimetype\": \"\"\n }\n },\n \"name\": \"test\",\n \"description\": \"Cobro Suscripción 112233\",\n \"total\": 2555\n },\n \"status\": \"finished\",\n \"created\": \"2020-11-19T18:26:34.681Z\",\n \"activeSource\": {\n \"name\": \"Visa Débito terminada en 0010\",\n \"cardNumber\": \"450799******0010\"\n },\n \"customer\": {\n \"identification\": \"12123123\",\n \"email\": \"demo@unicobros.com\",\n \"phone\": \"116542312\",\n \"Objeto\": null,\n \"name\": \"Demo\"\",\n \"field\": null\n }\n }\n ],\n \"page\": 1,\n \"prevPage\": -1,\n \"nextPage\": -1,\n \"limit\": 15\n }\n}", "language": "200" } ], "selectedLanguageId": "ET-ejMRAdIyvwQsk3nfLp" }, "examples": { "languages": [ { "id": "FNAPJQW82zXJt3ucbC436", "code": "var xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function() {\n if(this.readyState === 4) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.unicobros.com.ar/p/subscriptions/qLLSnBV35/subscriber?page=0\");\nxhr.setRequestHeader(\"x-api-key\", \"zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj\");\nxhr.setRequestHeader(\"x-access-token\", \"d31f0721-2f85-44e7-bcc6-15e19d1a53cc\");\n\nxhr.send();", "language": "javascript" }, { "id": "fvYMDLa8HaGzsq2vTx8cI", "code": " 'https://api.unicobros.com.ar/p/subscriptions/qLLSnBV35/subscriber?page=0',\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => '',\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 0,\n CURLOPT_FOLLOWLOCATION => true,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => 'GET',\n CURLOPT_HTTPHEADER => array(\n 'x-api-key: zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj',\n 'x-access-token: d31f0721-2f85-44e7-bcc6-15e19d1a53cc'\n ),\n));\n\n$response = curl_exec($curl);\n\ncurl_close($curl);\necho $response;\n", "language": "php" } ], "selectedLanguageId": "fvYMDLa8HaGzsq2vTx8cI" }, "description": "Esa API permite obtener todos los suscriptores de una suscripción", "currentNewParameter": { "label": "Path Parameter", "value": "pathParameters" }, "autoGeneratedAnchorSlug": "obtener-suscriptores", "legacyHash": "OQxK7SD4DbEMMSSXbiffJ" } ``` ::: :::ApiMethodV2 ```json { "tab": "examples", "url": "https://api.unicobros.com.ar/p/subscriptions/{id}/subscriber", "name": "Crear Suscriptor", "method": "POST", "request": { "pathParameters": [], "queryParameters": [ { "kind": "required", "name": "id", "type": "string", "description": "ID de la suscripción donde va a ser creado el suscriptor." } ], "headerParameters": [ { "kind": "required", "name": "x-api-key", "type": "string", "description": "Clave API de su aplicación." }, { "kind": "required", "name": "x-access-token", "type": "string", "description": "Token de Acceso a la entidad para la cual desea realizar la operación." } ], "bodyDataParameters": [ { "kind": "required", "name": "customer", "type": "Object", "children": [], "description": "Objeto con los datos del suscriptor." }, { "kind": "required", "name": "customer.email", "type": "string", "description": "Email del cliente. Este parámetro es necesario." }, { "kind": "required", "name": "customer.name", "type": "string", "description": "Nombre del cliente." }, { "kind": "required", "name": "customer.identification", "type": "string", "description": "DNI del cliente." }, { "kind": "optional", "name": "customer.phone", "type": "string", "description": "Teléfono del cliente" }, { "kind": "required", "name": "startDate", "type": "Object", "description": "Fecha a partir de la cual está Activo el suscriptor. Sólo requerido en suscripciones Dinámicas. La fecha definida debe ser al menos 1 día posterior a la fecha actual. \nEjemplo de formato para ingresar Lunes 2 de Enero del año 2023. \n\nNotas: \n- Si la suscripción es de \"Agenda FIja\", se va a cobrar en el primer initialDay en que el startDate se haya cumplido. \n- Si el startDate se cumplió, y el valor del \"StartOnInitialDay\" es false y está charge_on_first_source se cobra el proporcional. " }, { "kind": "required", "name": "startDate.day", "type": "Number", "description": "Dia de inicio de la suscripción. \nEjemplo de formato: \"day\": 2" }, { "kind": "required", "name": "startDate.month", "type": "Number", "description": "Mes de inicio de la suscripción. \nEjemplo de formato: \"month\": 1" }, { "kind": "optional", "name": "startDate.year", "type": "Number", "description": "Año de inicio de la suscripción ( Opcional ). Si no se provee se tomará el año corriente.\nEjemplo de Formato: \"year\": 2023" }, { "kind": "optional", "name": "test", "type": "Boolean", "description": "Marca al suscriptor como un suscriptor de prueba, lo que le permite utilizar las tarjetas de prueba para simular el proceso de suscripción. Valor por defecto: False." }, { "kind": "optional", "name": "total", "type": "Number", "description": "Importe a cobrar al suscriptor (Opcional). Si no se envía este parámetro, se considera el importe definido en la suscripción. Formato XXX.xx donde el PUNTO es el separador decimal." }, { "kind": "optional", "name": "reference", "type": "string", "description": "Referencia única que identifique al suscriptor." }, { "kind": "optional", "name": "voucher", "type": "string", "children": [], "description": "Referencia del voucher o cupón de descuento a aplicar en el suscriptor" }, { "name": "expiresAt", "kind": "optional", "type": "Integer", "description": "Permite configurar la fecha de vencimiento para el link de carga de medio de pago del suscriptor.\nDebe estar en formato 'timestamp'. Por ejemplo: {\"expiresAt\": 1734552312341}", "children": [] } ], "formDataParameters": [] }, "results": { "languages": [ { "id": "xNrSkh7_zvABt1qZc128m", "code": "{\n \"result\": true,\n \"data\": {\n \"uid\": \"Y7B3P541B9VFBYTHSZ\",\n \"reference\": \"233211212\",\n \"sourceUrl\": \"https://unicobros.com/p/subscriptions/T691POMK62SGC7CHAK/subscriber/Y7B3P541B9VFBYTHSZ/source\",\n \"subscriberUrl\": \"https://unicobros.com/p/subscriptions/T691POMK62SGC7CHAK/subscriber/Y7B3P541B9VFBYTHSZ\",\n \"subscription\": {\n \"uid\": \"T691POMK62SGC7CHAK\"\n }\n }\n}", "language": "200" } ], "selectedLanguageId": "xNrSkh7_zvABt1qZc128m" }, "examples": { "languages": [ { "id": "pCAIbxL7rD7t-u9KOJ-SC", "code": "var data = JSON.stringify({\n \"customer\":{\n \"email\":\"demo@unicobros.com\",\n \"identification\":\"12123123\",\n \"name\":\"Test Unicobros\"\n },\n \"startDate\":{\n \"day\":27,\n \"month\":3,\n \"year\":2021\n },\n \"reference\":\"233211212\"});\n\nvar xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function() {\n if(this.readyState === 4) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.unicobros.com.ar/p/subscriptions/T691POMK62SGC7CHAK/subscriber\");\nxhr.setRequestHeader(\"x-api-key\", \"zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj\");\nxhr.setRequestHeader(\"x-access-token\", \"d31f0721-2f85-44e7-bcc6-15e19d1a53cc\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "language": "javascript" }, { "id": "e-VRuRb5Gwpgf2s-YOYAz", "code": " 'https://api.unicobros.com.ar/p/subscriptions/T691POMK62SGC7CHAK/subscriber',\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => '',\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 0,\n CURLOPT_FOLLOWLOCATION => true,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => 'POST',\n CURLOPT_POSTFIELDS =>'{\n \"customer\":{\n \"email\": \"demo@unicobros.com\",\n \"identification\": \"12123123\",\n \"name\": \"Test Unicobros\"\n },\n \"startDate\":{\n \"day\": 27,\n \"month\": 3,\n \"year\": 2021\n },\n \"reference\": \"233211212\"\n}',\n CURLOPT_HTTPHEADER => array(\n 'x-api-key: zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj',\n 'x-access-token: d31f0721-2f85-44e7-bcc6-15e19d1a53cc',\n 'Content-Type: application/json'\n ),\n));\n\n$response = curl_exec($curl);\n\ncurl_close($curl);\necho $response;\n", "language": "php" }, { "id": "tFTVkyK7EpO7VKG7m0YfV", "code": "import requests\n\nurl = \"https://api.unicobros.com.ar/p/subscriptions/T691POMK62SGC7CHAK/subscriber\"\n\npayload=\"{\\r\\n \\\"customer\\\":{\\r\\n \\\"email\\\": \\\"demo@unicobros.com\\\",\\r\\n \\\"identification\\\": \\\"12123123\\\",\\r\\n \\\"name\\\": \\\"Test Unicobros\\\"\\r\\n },\\r\\n \\\"startDate\\\":{\\r\\n \\\"day\\\": 27,\\r\\n \\\"month\\\": 3,\\r\\n \\\"year\\\": 2021\\r\\n },\\r\\n \\\"reference\\\": \\\"233211212\\\"\\r\\n}\"\nheaders = {\n 'x-api-key': 'zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj',\n 'x-access-token': 'd31f0721-2f85-44e7-bcc6-15e19d1a53cc',\n 'Content-Type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n", "language": "python" } ], "selectedLanguageId": "tFTVkyK7EpO7VKG7m0YfV" }, "description": "Permite crear un suscriptor para una determinada suscripción", "currentNewParameter": { "label": "Body Parameter", "value": "bodyDataParameters" }, "autoGeneratedAnchorSlug": "crear-suscriptor", "legacyHash": "B60hKIpc9z_nfal72rGEO" } ``` ::: **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. :::ApiMethodV2 ```json { "tab": "request", "url": "https://api.unicobros.com.ar/p/subscriptions/{id}/subscriber/{sid}", "name": "Obtener Suscriptor", "method": "GET", "request": { "pathParameters": [], "queryParameters": [ { "kind": "required", "name": "id", "type": "string", "description": "ID de la suscripción" }, { "kind": "required", "name": "sid", "type": "string", "description": "ID del suscriptor" } ], "headerParameters": [ { "kind": "required", "name": "x-api-key", "type": "string", "description": "Clave API de su aplicación." }, { "kind": "required", "name": "x-access-token", "type": "string", "description": "Token de Acceso a la entidad para la cual desea realizar la operación." } ], "bodyDataParameters": [], "formDataParameters": [] }, "results": { "languages": [ { "id": "bxQtyIgcaxFJMTN3Y1Jpc", "code": "{\n \"result\": true,\n \"data\": {\n \"subscriber\": {\n \"uid\": \"Y7B3P541B9VFBYTHSZ\",\n \"reference\": \"233211212\",\n \"total\": 0,\n \"customerData\": {\n \"email\": \"demo@unicobros.com\",\n \"identification\": \"12123123\",\n \"name\": \"Test Unicobros\"\n },\n \"status\": \"active\",\n \"executions\": [],\n \"agenda\": [\n {\n \"type\": \"period\",\n \"year\": 0,\n \"_id\": \"605a05c0a969100ecb7a2c39\",\n \"day\": 27,\n \"month\": 2,\n \"period\": 1\n }\n ],\n \"created\": \"2021-03-23T15:14:08.011Z\",\n \"activeSource\": false,\n \"customer\": {\n \"email\": \"demo@unicobros.com\",\n \"identification\": \"12123123\",\n \"name\": \"Test Unicobros\"\n }\n },\n \"subscription\": {\n \"uid\": \"T691POMK62SGC7CHAK\",\n \"type\": \"dynamic\",\n \"interval\": \"1y\",\n \"limit\": 0,\n \"trial\": 0,\n \"initialDay\": 1,\n \"shorten_url\": \"http://.co/2o7MUM9\",\n \"setupFee\": 0,\n \"test\": false,\n \"intent\": \"payment.v2\",\n \"currency\": \"ARS\",\n \"status\": \"active\",\n \"customerForm\": \"default\",\n \"features\": null,\n \"sources\": [],\n \"name\": \"Suscripción de Prueba\",\n \"description\": \"Suscripción Anual\",\n \"reference\": \"fca74b7e-31bf-4494-8914-5f5226a2f8c9\",\n \"total\": 3900,\n \"options\": {\n \"button\": false,\n \"embed\": false,\n \"domain\": null,\n \"theme\": {\n \"type\": \"light\",\n \"background\": \"\",\n \"showHeader\": true,\n \"showBack\": true,\n \"header\": false,\n \"colors\": {\n \"primary\": \"#6f00ff\"\n }\n }\n },\n \"split\": []\n },\n \"entity\": {\n \"name\": \"Demo\",\n \"uid\": \"H1rJEXyr\",\n \"logo\": {\n \"filename\": \"demo-entity_logo_1467046687494.png\",\n \"originalname\": \"app_icon_white_shadow_short.png\",\n \"path\": \"\",\n \"size\": 184658,\n \"filetype\": \"image/png\",\n \"url\": \"//unicobros.s3.amazonaws.com/demo-entity_logo_1467046687494.png\",\n \"created\": \"2017-03-29T03:11:19.000Z\",\n \"sizes\": [],\n \"versions\": [],\n \"extension\": \"\",\n \"mimetype\": \"\"\n }\n },\n \"total\": 3900,\n \"currency\": {\n \"value\": \"ARS\",\n \"label\": \"Peso Argentino\",\n \"symbol\": \"$\",\n \"hidden\": false\n },\n \"url\": \"https://unicobros.com/p/subscriptions/T691POMK62SGC7CHAK/subscriber/Y7B3P541B9VFBYTHSZ\"\n }\n}", "language": "200" } ], "selectedLanguageId": "bxQtyIgcaxFJMTN3Y1Jpc" }, "examples": { "languages": [ { "id": "oG73rxUn8vv3_58bFgTIJ", "code": "var xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function() {\n if(this.readyState === 4) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.unicobros.com.ar/p/subscriptions/T691POMK62SGC7CHAK/subscriber/Y7B3P541B9VFBYTHSZ\");\nxhr.setRequestHeader(\"x-api-key\", \"zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj\");\nxhr.setRequestHeader(\"x-access-token\", \"d31f0721-2f85-44e7-bcc6-15e19d1a53cc\");\n\nxhr.send();", "language": "javascript" }, { "id": "YM1pX4lqsqDsdTIPWDcQI", "code": " 'https://api.unicobros.com.ar/p/subscriptions/T691POMK62SGC7CHAK/subscriber/Y7B3P541B9VFBYTHSZ',\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => '',\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 0,\n CURLOPT_FOLLOWLOCATION => true,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => 'GET',\n CURLOPT_HTTPHEADER => array(\n 'x-api-key: zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj',\n 'x-access-token: d31f0721-2f85-44e7-bcc6-15e19d1a53cc'\n ),\n));\n\n$response = curl_exec($curl);\n\ncurl_close($curl);\necho $response;\n", "language": "php" } ], "selectedLanguageId": "YM1pX4lqsqDsdTIPWDcQI" }, "description": "Permite ver un suscriptor en particular en base al ID de suscripción y ID del suscriptor", "currentNewParameter": { "label": "Header Parameter", "value": "headerParameters" }, "autoGeneratedAnchorSlug": "obtener-suscriptor", "legacyHash": "Om_F7l-It8atVbiJv5Lm6" } ``` ::: :::ApiMethodV2 ```json { "tab": "examples", "url": "https://api.unicobros.com.ar/p/subscriptions/{id}/subscriber/{sid}", "name": "Editar Suscriptor", "method": "POST", "request": { "pathParameters": [], "queryParameters": [ { "kind": "required", "name": "id", "type": "string", "description": "ID de la suscripción" }, { "kind": "required", "name": "sid", "type": "string", "description": "ID del suscriptor" } ], "headerParameters": [ { "kind": "required", "name": "x-api-key", "type": "string", "description": "Clave API de su aplicación." }, { "kind": "required", "name": "x-access-token", "type": "string", "description": "Clave de acceso a la entidad" } ], "bodyDataParameters": [ { "kind": "optional", "name": "total", "type": "Number", "description": "Nuevo importe a cobrar al suscriptor. Este valor predominará sobre el de la suscripción." }, { "kind": "optional", "name": "reference", "type": "Number", "description": "Referencia del suscriptor" }, { "kind": "optional", "name": "customerData", "type": "Object", "description": "Objeto con los datos del suscriptor que se quieren modificar" }, { "kind": "optional", "name": "customerData.email", "type": "string", "description": "Email del suscriptor" }, { "kind": "optional", "name": "customerData.name", "type": "string", "description": "Nombre del suscriptor." }, { "kind": "optional", "name": "customerData.identification", "type": "string", "description": "DNI del suscriptor" }, { "kind": "optional", "name": "customerData.phone", "type": "string", "description": "Teléfono del suscriptor" } ], "formDataParameters": [] }, "results": { "languages": [ { "id": "h8nXO6dJooFNfqR3cJn7Q", "code": "{\n \"result\": true,\n \"data\": {}\n}", "language": "200" }, { "id": "3zeq4s4ZvybFOgut5G9in", "code": "", "language": "404" } ], "selectedLanguageId": "h8nXO6dJooFNfqR3cJn7Q" }, "examples": { "languages": [ { "id": "BqJE8u4fdMlWQr6aJitmb", "code": "curl --location --request POST 'https://api.unicobros.com.ar/p/subscriptions/abc123/subscriber/def456' \\\n--header 'x-api-key: zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj' \\\n--header 'x-access-token: d31f0721-2f85-44e7-bcc6-15e19d1a53cc' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"customerData\": {\n \"name\": \"Cliente Demo\"\",\n \"phone\": \"12123123\"\n }\n}'", "language": "curl" }, { "id": "gURROjzeeGf_EjgL-14ui", "code": "var data = JSON.stringify({\n \"customerData\": {\n \"name\": \"Cliente Demo\",\n \"phone\": \"12123123\"\n }\n});\n\nvar xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function() {\n if(this.readyState === 4) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.unicobros.com.ar/p/subscriptions/abc123/subscriber/def456\");\nxhr.setRequestHeader(\"x-api-key\", \"zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj\");\nxhr.setRequestHeader(\"x-access-token\", \"d31f0721-2f85-44e7-bcc6-15e19d1a53cc\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "language": "javascript" }, { "id": "RqsMAjny0KptDolNGnXWa", "code": "var request = require('request');\nvar options = {\n 'method': 'POST',\n 'url': 'https://api.unicobros.com.ar/p/subscriptions/abc123/subscriber/def456',\n 'headers': {\n 'x-api-key': 'zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj',\n 'x-access-token': 'd31f0721-2f85-44e7-bcc6-15e19d1a53cc',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({\n \"customerData\": {\n \"name\": \"Cliente Demo\",\n \"phone\": \"12123123\"\n }\n })\n\n};\nrequest(options, function (error, response) {\n if (error) throw new Error(error);\n console.log(response.body);\n});", "language": "nodejs" }, { "id": "WbbHIPD929uSwIl4DVSfo", "code": "import requests\nimport json\n\nurl = \"https://api.unicobros.com.ar/p/subscriptions/abc123/subscriber/def456\"\n\npayload = json.dumps({\n \"customerData\": {\n \"name\": \"Cliente Demo\",\n \"phone\": \"12123123\"\n }\n})\nheaders = {\n 'x-api-key': 'zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj',\n 'x-access-token': 'd31f0721-2f85-44e7-bcc6-15e19d1a53cc',\n 'Content-Type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)", "language": "python" } ], "selectedLanguageId": "WbbHIPD929uSwIl4DVSfo" }, "description": "", "currentNewParameter": { "label": "Body Parameter", "value": "bodyDataParameters" }, "autoGeneratedAnchorSlug": "editar-suscriptor", "legacyHash": "VoNxZfU9af9epQ2V-QZPt" } ``` ::: ## Cambiar estado del suscriptor :::ApiMethodV2 ```json { "tab": "examples", "url": "https://api.unicobros.com.ar/p/subscriptions/${uid}/subscriber/${sid}/action/activate", "name": "Activar Suscriptor", "method": "POST", "request": { "pathParameters": [], "queryParameters": [ { "kind": "required", "name": "uid", "type": "string", "description": "uID de la suscripción" }, { "kind": "required", "name": "sid", "type": "string", "description": "ID del suscriptor" } ], "headerParameters": [ { "kind": "required", "name": "x-api-key", "type": "string", "description": "Clave API de su aplicación." }, { "kind": "required", "name": "x-access-token", "type": "string", "description": "Token de Acceso a la entidad para la cual desea realizar la operación." } ], "bodyDataParameters": [], "formDataParameters": [] }, "results": { "languages": [ { "id": "2PjTZuU1YI_UV-KDmrh9m", "code": "{\n \"result\": true\n}", "language": "200" } ], "selectedLanguageId": "2PjTZuU1YI_UV-KDmrh9m" }, "examples": { "languages": [ { "id": "8RFDq8A04opVSCuSxj-Xv", "code": "var xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function() {\n if(this.readyState === 4) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.unicobros.com.ar/p/subscriptions/T691POMK62SGC7CHAK/subscriber/Y7B3P541B9VFBYTHSZ/action/activate\");\nxhr.setRequestHeader(\"x-api-key\", \"zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj\");\nxhr.setRequestHeader(\"x-access-token\", \"d31f0721-2f85-44e7-bcc6-15e19d1a53cc\");\n\nxhr.send();", "language": "javascript" } ], "selectedLanguageId": "8RFDq8A04opVSCuSxj-Xv" }, "description": "Permite re-activar los cobros a un suscriptor en particular", "currentNewParameter": { "label": "Header Parameter", "value": "headerParameters" }, "autoGeneratedAnchorSlug": "activar-suscriptor", "legacyHash": "CzWCwhq1Bi_8aEHuXftOy" } ``` ::: :::ApiMethodV2 ```json { "tab": "examples", "url": "https://api.unicobros.com.ar/p/subscriptions/${uid}/subscriber/${sid}/action/suspend", "name": "Suspender Suscriptor", "method": "POST", "request": { "pathParameters": [], "queryParameters": [ { "kind": "required", "name": "id", "type": "string", "description": "ID de la suscripción" }, { "kind": "required", "name": "sid", "type": "string", "description": "ID del suscriptor" } ], "headerParameters": [ { "kind": "required", "name": "x-api-key", "type": "string", "description": "Clave API de su aplicación." }, { "kind": "required", "name": "x-access-token", "type": "string", "description": "Token de Acceso a la entidad para la cual desea realizar la operación." } ], "bodyDataParameters": [], "formDataParameters": [] }, "results": { "languages": [ { "id": "tP98Dp4Hfgx89nlG6b-hj", "code": "{\n \"result\": true\n}", "language": "200" } ], "selectedLanguageId": "tP98Dp4Hfgx89nlG6b-hj" }, "examples": { "languages": [ { "id": "l9qtIG5ZPxx0AjTzr4wFm", "code": "var xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function() {\n if(this.readyState === 4) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.unicobros.com.ar/p/subscriptions/T691POMK62SGC7CHAK/subscriber/Y7B3P541B9VFBYTHSZ/action/suspend\");\nxhr.setRequestHeader(\"x-api-key\", \"zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj\");\nxhr.setRequestHeader(\"x-access-token\", \"d31f0721-2f85-44e7-bcc6-15e19d1a53cc\");\n\nxhr.send();", "language": "javascript" } ], "selectedLanguageId": "l9qtIG5ZPxx0AjTzr4wFm" }, "description": "Permite suspender los cobros que se realicen a un suscriptor en particular", "currentNewParameter": { "label": "Header Parameter", "value": "headerParameters" }, "autoGeneratedAnchorSlug": "suspender-suscriptor", "legacyHash": "_JZwa-leNzff0dASSY7Vo" } ``` ::: :::ApiMethodV2 ```json { "tab": "examples", "url": "https://api.unicobros.com.ar/p/subscriptions/${uid}/subscriber/${sid}/action/delete", "name": "Eliminar Suscriptor", "method": "DELETE", "request": { "pathParameters": [], "queryParameters": [ { "kind": "required", "name": "id", "type": "string", "description": "ID de la suscripción" }, { "kind": "required", "name": "sid", "type": "string", "description": "ID del suscriptor" } ], "headerParameters": [ { "kind": "required", "name": "x-api-key", "type": "string", "description": "Clave API de su aplicación." }, { "kind": "required", "name": "x-access-token", "type": "string", "description": "Token de Acceso a la entidad para la cual desea realizar la operación." } ], "bodyDataParameters": [], "formDataParameters": [] }, "results": { "languages": [ { "id": "sqtwp8Nd7MhArDrSFNGWJ", "code": "{\n \"result\": true\n}", "language": "200" } ], "selectedLanguageId": "sqtwp8Nd7MhArDrSFNGWJ" }, "examples": { "languages": [ { "id": "ZJIbY3wtlP0RLCQuPogfl", "code": "var xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function() {\n if(this.readyState === 4) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"DELETE\", \"https://api.unicobros.com.ar/p/subscriptions/T691POMK62SGC7CHAK/subscriber/Y7B3P541B9VFBYTHSZ/action/delete\");\nxhr.setRequestHeader(\"x-api-key\", \"zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj\");\nxhr.setRequestHeader(\"x-access-token\", \"d31f0721-2f85-44e7-bcc6-15e19d1a53cc\");\n\nxhr.send();", "language": "javascript" } ], "selectedLanguageId": "ZJIbY3wtlP0RLCQuPogfl" }, "description": "Permite suspender los cobros que se realicen a un suscriptor en particular", "currentNewParameter": { "label": "Header Parameter", "value": "headerParameters" }, "autoGeneratedAnchorSlug": "eliminar-suscriptor", "legacyHash": "Cs9dG_dk4vGCtLJkxuEqM" } ``` ::: ## Cambiar Agenda del Suscriptor :::ApiMethodV2 ```json { "tab": "request", "url": "https://api.unicobros.com.ar/p/subscriptions/{id}/subscriber/{sid}/action/reschedule", "name": "Modificar Agenda", "method": "POST", "request": { "pathParameters": [], "queryParameters": [ { "kind": "required", "name": "id", "type": "string", "description": "ID de la suscripción" }, { "kind": "required", "name": "sid", "type": "string", "description": "ID del suscriptor" } ], "headerParameters": [ { "kind": "required", "name": "x-api-key", "type": "string", "description": "Clave API de su aplicación." }, { "kind": "required", "name": "x-access-token", "type": "string", "description": "Token de Acceso a la entidad para la cual desea realizar la operación." } ], "bodyDataParameters": [ { "kind": "required", "name": "startDate", "type": "Object", "description": "Objecto con la fecha de inicio. La fecha construida debe ser al menos 4 días posterior a la fecha actual." }, { "kind": "required", "name": "startDate.day", "type": "Integer", "description": "Dia de inicio de la suscripción." }, { "kind": "required", "name": "startDate.month", "type": "Integer", "description": "Mes de inicio de la suscripción." }, { "kind": "optional", "name": "startDate.year", "type": "Integer", "description": "Año de inicio de la suscripción ( Opcional ). Si no se provee se tomará el año corriente." } ], "formDataParameters": [] }, "results": { "languages": [ { "id": "6NvlBhYzO5xXZ4ZlRVOul", "code": "{\n \"result\": true,\n \"data\": {}\n}", "language": "200" } ], "selectedLanguageId": "6NvlBhYzO5xXZ4ZlRVOul" }, "examples": { "languages": [ { "id": "2q15tJ9T-YOhfE3eJxXz6", "code": "var data = JSON.stringify({\"startDate\":{\"day\":25,\"month\":4,\"year\":2021}});\n\nvar xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function() {\n if(this.readyState === 4) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.unicobros.com.ar/p/subscriptions/T691POMK62SGC7CHAK/subscriber/Y7B3P541B9VFBYTHSZ/action/reschedule\");\nxhr.setRequestHeader(\"x-api-key\", \"zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj\");\nxhr.setRequestHeader(\"x-access-token\", \"d31f0721-2f85-44e7-bcc6-15e19d1a53cc\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "language": "javascript" }, { "id": "7J0A8J-kyMSK36yb_Aric", "code": " 'https://api.mobbex.com/p/subscriptions/T691POMK62SGC7CHAK/subscriber/Y7B3P541B9VFBYTHSZ/action/reschedule',\r\n CURLOPT_RETURNTRANSFER => true,\r\n CURLOPT_ENCODING => '',\r\n CURLOPT_MAXREDIRS => 10,\r\n CURLOPT_TIMEOUT => 0,\r\n CURLOPT_FOLLOWLOCATION => true,\r\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\r\n CURLOPT_CUSTOMREQUEST => 'POST',\r\n CURLOPT_POSTFIELDS =>'{\r\n \"startDate\":{\r\n \"day\": 25,\r\n \"month\": 4,\r\n \"year\": 2021\r\n }\r\n}',\r\n CURLOPT_HTTPHEADER => array(\r\n 'x-api-key: zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj',\r\n 'x-access-token: d31f0721-2f85-44e7-bcc6-15e19d1a53cc',\r\n 'Content-Type: application/json'\r\n ),\r\n));\r\n\r\n$response = curl_exec($curl);\r\n\r\ncurl_close($curl);\r\necho $response;", "language": "php" } ], "selectedLanguageId": "2q15tJ9T-YOhfE3eJxXz6" }, "description": "Esta acción re-generará toda la agenda del suscriptor basado en la fecha de inicio indicada.", "currentNewParameter": { "label": "Header Parameter", "value": "headerParameters" }, "autoGeneratedAnchorSlug": "modificar-agenda", "legacyHash": "2-ppC35pKzEpnUcJWNZUT" } ``` ::: ## 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" :::ApiMethodV2 ```json { "tab": "request", "url": "https://api.unicobros.com.ar/p/subscriptions/{id}/subscriber/{sid}/action/move", "name": "Mover Suscriptor", "method": "POST", "request": { "pathParameters": [], "queryParameters": [ { "kind": "required", "name": "id", "type": "string", "description": "ID de la suscripción" }, { "kind": "required", "name": "sid", "type": "string", "description": "ID del suscriptor" } ], "headerParameters": [ { "kind": "required", "name": "x-api-key", "type": "string", "description": "Clave API de su aplicación." }, { "kind": "required", "name": "x-access-token", "type": "string", "description": "Token de Acceso a la entidad para la cual desea realizar la operación." } ], "bodyDataParameters": [ { "kind": "required", "name": "sid", "type": "string", "description": "ID de la nueva suscripción" } ], "formDataParameters": [] }, "results": { "languages": [ { "id": "oty0cb72Ws2sGWLksjF2X", "code": "{\n \"result\": true,\n \"data\": {}\n}", "language": "200" } ], "selectedLanguageId": "oty0cb72Ws2sGWLksjF2X" }, "examples": { "languages": [ { "id": "6AB1fIf3O1kM7ZBra2VJF", "code": "var data = JSON.stringify({\"sid\":\"R89BLVMZRPDH3GMRH9\"});\n\nvar xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function() {\n if(this.readyState === 4) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.unicobros.com.ar/p/subscriptions/T691POMK62SGC7CHAK/subscriber/Y7B3P541B9VFBYTHSZ/action/move\");\nxhr.setRequestHeader(\"x-api-key\", \"zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj\");\nxhr.setRequestHeader(\"x-access-token\", \"d31f0721-2f85-44e7-bcc6-15e19d1a53cc\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "language": "javascript" }, { "id": "lrefSG1sG3fJQKbeLY_m2", "code": " 'https://api.mobbex.com/p/subscriptions/T691POMK62SGC7CHAK/subscriber/Y7B3P541B9VFBYTHSZ/action/move',\r\n CURLOPT_RETURNTRANSFER => true,\r\n CURLOPT_ENCODING => '',\r\n CURLOPT_MAXREDIRS => 10,\r\n CURLOPT_TIMEOUT => 0,\r\n CURLOPT_FOLLOWLOCATION => true,\r\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\r\n CURLOPT_CUSTOMREQUEST => 'POST',\r\n CURLOPT_POSTFIELDS =>'{\r\n \"sid\": \"R89BLVMZRPDH3GMRH9\"\r\n}',\r\n CURLOPT_HTTPHEADER => array(\r\n 'x-api-key: zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj',\r\n 'x-access-token: d31f0721-2f85-44e7-bcc6-15e19d1a53cc',\r\n 'Content-Type: application/json'\r\n ),\r\n));\r\n\r\n$response = curl_exec($curl);\r\n\r\ncurl_close($curl);\r\necho $response;\r\n", "language": "php" } ], "selectedLanguageId": "6AB1fIf3O1kM7ZBra2VJF" }, "description": "", "currentNewParameter": { "label": "Header Parameter", "value": "headerParameters" }, "autoGeneratedAnchorSlug": "mover-suscriptor", "legacyHash": "Jp1NJmMVtjUKhffR-KOu8" } ``` ::: # Ejecuciones :::ApiMethodV2 ```json { "tab": "request", "url": "https://api.unicobros.com.ar/p/subscriptions/{id}/subscriber/{sid}/execution", "name": "Ejecutar Suscripción Manualmente", "method": "GET", "request": { "pathParameters": [], "queryParameters": [ { "kind": "required", "name": "id", "type": "string", "description": "ID de la suscripción." }, { "kind": "required", "name": "sid", "type": "string", "description": "ID del suscriptor." } ], "headerParameters": [ { "kind": "required", "name": "x-api-key", "type": "string", "description": "Clave API de su aplicación." }, { "kind": "required", "name": "x-access-token", "type": "string", "description": "Token de Acceso a la entidad para la cual desea realizar la operación." } ], "bodyDataParameters": [], "formDataParameters": [] }, "results": { "languages": [ { "id": "onNkILb9bIyEq_GqP2EZg", "code": "{\n \"result\": true,\n \"data\": {}\n}", "language": "200" } ], "selectedLanguageId": "onNkILb9bIyEq_GqP2EZg" }, "examples": { "languages": [ { "id": "W3ZJwO_vrM5faiRu9FFO4", "code": "var xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function() {\n if(this.readyState === 4) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.unicobros.com.ar/p/subscriptions/T691POMK62SGC7CHAK/subscriber/Y7B3P541B9VFBYTHSZ/execution\");\nxhr.setRequestHeader(\"x-api-key\", \"zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj\");\nxhr.setRequestHeader(\"x-access-token\", \"d31f0721-2f85-44e7-bcc6-15e19d1a53cc\");\n\nxhr.send();", "language": "javascript" }, { "id": "PKnUVYKJpspSBCM0JgGNN", "code": "var request = require('request');\r\nvar options = {\r\n 'method': 'GET',\r\n 'url': 'https://api.mobbex.com/p/subscriptions/T691POMK62SGC7CHAK/subscriber/Y7B3P541B9VFBYTHSZ/execution',\r\n 'headers': {\r\n 'x-api-key': 'zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj',\r\n 'x-access-token': 'd31f0721-2f85-44e7-bcc6-15e19d1a53cc'\r\n }\r\n};\r\nrequest(options, function (error, response) {\r\n if (error) throw new Error(error);\r\n console.log(response.body);\r\n});\r\n", "language": "nodejs" }, { "id": "09qhBJSsfNVz-tPnhE5hA", "code": " 'https://api.mobbex.com/p/subscriptions/T691POMK62SGC7CHAK/subscriber/Y7B3P541B9VFBYTHSZ/execution',\r\n CURLOPT_RETURNTRANSFER => true,\r\n CURLOPT_ENCODING => '',\r\n CURLOPT_MAXREDIRS => 10,\r\n CURLOPT_TIMEOUT => 0,\r\n CURLOPT_FOLLOWLOCATION => true,\r\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\r\n CURLOPT_CUSTOMREQUEST => 'GET',\r\n CURLOPT_HTTPHEADER => array(\r\n 'x-api-key: zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj',\r\n 'x-access-token: d31f0721-2f85-44e7-bcc6-15e19d1a53cc'\r\n ),\r\n));\r\n\r\n$response = curl_exec($curl);\r\n\r\ncurl_close($curl);\r\necho $response;\r\n", "language": "php" } ], "selectedLanguageId": "W3ZJwO_vrM5faiRu9FFO4" }, "description": "", "currentNewParameter": { "label": "Header Parameter", "value": "headerParameters" }, "autoGeneratedAnchorSlug": "ejecutar-suscripcin-manualmente", "legacyHash": "eYcWfCPZiwVmn8NfV7zv0" } ``` ::: :::ApiMethodV2 ```json { "tab": "examples", "url": "https://api.unicobros.com.ar/p/subscriptions/{id}/subscriber/{sid}/execution", "name": "Ejecutar Suscripción Manualmente con Monto Diferenciado", "method": "POST", "request": { "pathParameters": [], "queryParameters": [ { "kind": "required", "name": "id", "type": "string", "description": "ID de la suscripción" }, { "kind": "required", "name": "sid", "type": "string", "description": "ID del suscriptor" } ], "headerParameters": [ { "kind": "required", "name": "x-api-key", "type": "string", "description": "Clave API de su aplicación." }, { "kind": "required", "name": "x-access-token", "type": "string", "description": "Token de Acceso a la entidad para la cual desea realizar la operación." } ], "bodyDataParameters": [ { "kind": "optional", "name": "total", "type": "Number", "description": "Total a cobrar al suscriptor. Si no se envia se cobrará el monto asignado al Suscriptor ( Monto personalizado por Suscriptor ) o el monto de la Suscripción." }, { "kind": "optional", "name": "reference", "type": "string", "description": "Referencia del Cobro a Ejecutar. Esta referencia deberá ser única." }, { "kind": "optional", "name": "description", "type": "string", "description": "Descripción de la Ejecución." }, { "kind": "optional", "name": "test", "type": "Boolean", "description": "Activa el modo de pruebas para la ejecución." }, { "kind": "optional", "name": "taxes", "type": "Array", "children": [], "description": "Descripción de los impuestos aplicados al cobro" }, { "kind": "optional", "name": "", "type": "Object", "children": [ { "kind": "required", "name": "taxes.[$].reference", "type": "string", "description": "e" }, { "kind": "required", "name": "taxes.[$].total", "type": "Number", "description": "Importe del impuesto aplicado al cobro" } ], "description": "" } ], "formDataParameters": [] }, "results": { "languages": [ { "id": "sdKlFAZMQeSRJxok7zUVv", "code": "{\n \"result\": true,\n \"data\": {}\n}", "language": "200" } ], "selectedLanguageId": "sdKlFAZMQeSRJxok7zUVv" }, "examples": { "languages": [ { "id": "yldx1ArzaXJAr0IBaZGdb", "code": "var data = JSON.stringify({\"total\":150,\"reference\":\"230320211305\",\"description\":\"Cobro con una descripción diferente\"});\n\nvar xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function() {\n if(this.readyState === 4) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.unicobros.com.ar/p/subscriptions/R89BLVMZRPDH3GMRH9/subscriber/Y7B3P541B9VFBYTHSZ/execution\");\nxhr.setRequestHeader(\"x-api-key\", \"zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj\");\nxhr.setRequestHeader(\"x-access-token\", \"d31f0721-2f85-44e7-bcc6-15e19d1a53cc\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "language": "javascript" }, { "id": "sdnF0-DxpWv8Cusa_KIv8", "code": " 'https://api.mobbex.com/p/subscriptions/R89BLVMZRPDH3GMRH9/subscriber/Y7B3P541B9VFBYTHSZ/execution',\r\n CURLOPT_RETURNTRANSFER => true,\r\n CURLOPT_ENCODING => '',\r\n CURLOPT_MAXREDIRS => 10,\r\n CURLOPT_TIMEOUT => 0,\r\n CURLOPT_FOLLOWLOCATION => true,\r\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\r\n CURLOPT_CUSTOMREQUEST => 'POST',\r\n CURLOPT_POSTFIELDS =>'{\r\n \"total\": 150,\r\n \"reference\": \"230320211305\",\r\n \"description\": \"Cobro con una descripción diferente\"\r\n}',\r\n CURLOPT_HTTPHEADER => array(\r\n 'x-api-key: zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj',\r\n 'x-access-token: d31f0721-2f85-44e7-bcc6-15e19d1a53cc',\r\n 'Content-Type: application/json'\r\n ),\r\n));\r\n\r\n$response = curl_exec($curl);\r\n\r\ncurl_close($curl);\r\necho $response;\r\n", "language": "php" } ], "selectedLanguageId": "yldx1ArzaXJAr0IBaZGdb" }, "description": "El monto con el que se ejecuta la suscripción puede ser diferente al definido en la suscripción o el suscriptor.", "currentNewParameter": { "label": "Body Parameter", "value": "bodyDataParameters" }, "autoGeneratedAnchorSlug": "ejecutar-suscripcin-manualmente-con-monto-diferenc", "legacyHash": "R1Uy0y9UQHu285ZX6-ccx" } ``` ::: :::ApiMethodV2 ```json { "tab": "examples", "url": "https://api.unicobros.com.ar/p/subscriptions/{id}/action/execute", "name": "Ejecutar cobros manuales masivamente", "method": "POST", "request": { "pathParameters": [], "queryParameters": [ { "kind": "required", "name": "id", "type": "string", "description": "ID de la suscripción" } ], "headerParameters": [ { "kind": "required", "name": "x-api-key", "type": "string", "description": "Clave API de su aplicación." }, { "kind": "required", "name": "x-access-token", "type": "string", "description": "Token de Acceso a la entidad para la cual desea realizar la operación." } ], "bodyDataParameters": [ { "kind": "required", "name": "", "type": "Array", "description": "El body es un Array de Objetos de Tipo JSON" }, { "kind": "required", "name": "", "type": "Object", "description": "Objeto con los datos del suscriptor a cobrar" }, { "kind": "required", "name": "sid", "type": "string", "description": "Identificador del Suscriptor" }, { "kind": "optional", "name": "total", "type": "Number", "description": "Monto de la operación. Formato XXX.xx donde el PUNTO es el separador decimal." }, { "kind": "optional", "name": "reference", "type": "string", "description": "Referencia que identifique el cobro al suscriptor." }, { "kind": "optional", "name": "description", "type": "string", "description": "Permite personalizar la descripción del Cobro." }, { "kind": "optional", "name": "test", "type": "Boolean", "description": "Marca la ejecución como Prueba. Valores aceptados: true / false. Defecto: false" } ], "formDataParameters": [] }, "results": { "languages": [ { "id": "wJ6gnCBF83n8gi7TnhYsJ", "code": "{\n \"result\": true\n}", "language": "200" } ], "selectedLanguageId": "wJ6gnCBF83n8gi7TnhYsJ" }, "examples": { "languages": [ { "id": "ArtVEqvtKimBdiVzSOI7F", "code": "var data = JSON.stringify([\n {\"sid\":\"Y7B3P541B9VFBYTHSZ\",\"total\":10,\"reference\":\"230320211348\"}\n ]);\n\nvar xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function() {\n if(this.readyState === 4) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.unicobros.com.ar/p/subscriptions/R89BLVMZRPDH3GMRH9/action/execute\");\nxhr.setRequestHeader(\"x-api-key\", \"zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj\");\nxhr.setRequestHeader(\"x-access-token\", \"d31f0721-2f85-44e7-bcc6-15e19d1a53cc\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "language": "javascript" }, { "id": "wjzVdFR-BcKEjcmheAdeR", "code": " 'https://api.mobbex.com/p/subscriptions/R89BLVMZRPDH3GMRH9/action/execute',\r\n CURLOPT_RETURNTRANSFER => true,\r\n CURLOPT_ENCODING => '',\r\n CURLOPT_MAXREDIRS => 10,\r\n CURLOPT_TIMEOUT => 0,\r\n CURLOPT_FOLLOWLOCATION => true,\r\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\r\n CURLOPT_CUSTOMREQUEST => 'POST',\r\n CURLOPT_POSTFIELDS =>'[\r\n {\r\n \"sid\": \"Y7B3P541B9VFBYTHSZ\",\r\n \"total\": 10,\r\n \"reference\": \"230320211348\"\r\n }\r\n]',\r\n CURLOPT_HTTPHEADER => array(\r\n 'x-api-key: zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj',\r\n 'x-access-token: d31f0721-2f85-44e7-bcc6-15e19d1a53cc',\r\n 'Content-Type: application/json'\r\n ),\r\n));\r\n\r\n$response = curl_exec($curl);\r\n\r\ncurl_close($curl);\r\necho $response;", "language": "php" } ], "selectedLanguageId": "ArtVEqvtKimBdiVzSOI7F" }, "description": "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.", "currentNewParameter": { "label": "Body Parameter", "value": "bodyDataParameters" }, "autoGeneratedAnchorSlug": "ejecutar-cobros-manuales-masivamente", "legacyHash": "-JE5pstsc_yyDF5A47TYm" } ``` ::: :::ApiMethodV2 ```json { "tab": "examples", "url": "https://api.unicobros.com.ar/p/subscriptions/{id}/subscriber/{sid}/action/schedule", "name": "Programar una ejecución a futuro", "method": "POST", "request": { "pathParameters": [], "queryParameters": [ { "kind": "required", "name": "id", "type": "string", "description": "ID de la suscripción" }, { "kind": "required", "name": "sid", "type": "string", "description": "ID del suscriptor" } ], "headerParameters": [ { "kind": "required", "name": "x-api-key", "type": "string", "description": "Clave API de su aplicación" }, { "kind": "required", "name": "x-access-token", "type": "string", "description": "Token de Acceso a la entidad para la cual desea realizar la operación." } ], "bodyDataParameters": [ { "kind": "required", "name": "date", "type": "Object", "description": "Objecto con la fecha de ejecución futura. La fecha definida debe ser al menos 4 días posterior a la fecha actual." }, { "kind": "required", "name": "date.day", "type": "Integer", "description": "Día a agendar." }, { "kind": "required", "name": "date.month", "type": "Integer", "description": "Mes a agendar." }, { "kind": "required", "name": "date.year", "type": "Integer", "description": "Año a agendar." }, { "kind": "optional", "name": "total", "type": "Number", "description": "Total específico a cobrar al suscriptor. Si no se envía se cobrará el monto asignado al Suscriptor ( Monto personalizado por Suscriptor ) o el monto de la Suscripción." } ], "formDataParameters": [] }, "results": { "languages": [ { "id": "fu8Q-MTdf_RWNwFnO18RY", "code": "{\n \"result\"\n}", "language": "200" } ], "selectedLanguageId": "fu8Q-MTdf_RWNwFnO18RY" }, "examples": { "languages": [ { "id": "QP7bTEYmVe2f-sgcWv-sz", "code": "var data = JSON.stringify({\n \"date\": {\n \"day\": 10,\n \"month\": 4,\n \"year\": 2021\n }\n});\n\nvar xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function() {\n if(this.readyState === 4) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.unicobros.com.ar/p/subscriptions/u5485JkgTy/subscriber/5sfTy4iPlT/action/schedule\");\nxhr.setRequestHeader(\"x-api-key\", \"zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj\");\nxhr.setRequestHeader(\"x-access-token\", \"d31f0721-2f85-44e7-bcc6-15e19d1a53cc\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "language": "javascript" }, { "id": "pkCELRXsRQNfQJmaG-NS2", "code": " 'https://api.mobbex.com/p/subscriptions/u5485JkgTy/subscriber/5sfTy4iPlT/action/schedule',\r\n CURLOPT_RETURNTRANSFER => true,\r\n CURLOPT_ENCODING => '',\r\n CURLOPT_MAXREDIRS => 10,\r\n CURLOPT_TIMEOUT => 0,\r\n CURLOPT_FOLLOWLOCATION => true,\r\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\r\n CURLOPT_CUSTOMREQUEST => 'POST',\r\n CURLOPT_POSTFIELDS =>'{\r\n \"date\": {\r\n \"day\": 10,\r\n \"month\": 4,\r\n \"year\": 2021\r\n }\r\n}',\r\n CURLOPT_HTTPHEADER => array(\r\n 'x-api-key: zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj',\r\n 'x-access-token: d31f0721-2f85-44e7-bcc6-15e19d1a53cc',\r\n 'Content-Type: application/json'\r\n ),\r\n));\r\n\r\n$response = curl_exec($curl);\r\n\r\ncurl_close($curl);\r\necho $response;\r\n", "language": "php" } ], "selectedLanguageId": "QP7bTEYmVe2f-sgcWv-sz" }, "description": "", "currentNewParameter": { "label": "Body Parameter", "value": "bodyDataParameters" }, "autoGeneratedAnchorSlug": "programar-una-ejecucin-a-futuro", "legacyHash": "Et5Q_-fVErGF_bCtbjDmu" } ``` ::: ## Acciones sobre una ejecución :::ApiMethodV2 ```json { "tab": "request", "url": "https://api.unicobros.com.ar/p/subscriptions/{id}/subscriber/{sid}/execution/{eid}/action/retry", "name": "Reintentar una Ejecución", "method": "GET", "request": { "pathParameters": [], "queryParameters": [ { "kind": "required", "name": "id", "type": "string", "description": "ID de la suscripción" }, { "kind": "required", "name": "sid", "type": "string", "description": "ID del suscriptor" }, { "kind": "required", "name": "eid", "type": "string", "description": "ID de la ejecución a reintentar" } ], "headerParameters": [ { "kind": "required", "name": "x-api-key", "type": "string", "description": "Clave API de su aplicación." }, { "kind": "required", "name": "x-access-token", "type": "string", "description": "Token de Acceso a la entidad para la cual desea realizar la operación." } ], "bodyDataParameters": [], "formDataParameters": [] }, "results": { "languages": [ { "id": "io9zAEEc5M_XSZM4Hpw-M", "code": "{\n \"result\": true\n}", "language": "200" } ], "selectedLanguageId": "io9zAEEc5M_XSZM4Hpw-M" }, "examples": { "languages": [ { "id": "SEl6OII4xPcxgBAWxoMK1", "code": "var data = JSON.stringify({\"date\":{\"day\":28,\"month\":5,\"year\":2021}});\n\nvar xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function() {\n if(this.readyState === 4) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.unicobros.com.ar/p/subscriptions/R89BLVMZRPDH3GMRH9/subscriber/Y7B3P541B9VFBYTHSZ/execution/JS73P5HG8AVFBYT45Z/action/retry\");\nxhr.setRequestHeader(\"x-api-key\", \"zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj\");\nxhr.setRequestHeader(\"x-access-token\", \"d31f0721-2f85-44e7-bcc6-15e19d1a53cc\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "language": "javascript" }, { "id": "SIC9o3SrfU49rWn0qinK0", "code": " 'https://api.mobbex.com/p/subscriptions/R89BLVMZRPDH3GMRH9/subscriber/Y7B3P541B9VFBYTHSZ/execution/JS73P5HG8AVFBYT45Z/action/retry',\r\n CURLOPT_RETURNTRANSFER => true,\r\n CURLOPT_ENCODING => '',\r\n CURLOPT_MAXREDIRS => 10,\r\n CURLOPT_TIMEOUT => 0,\r\n CURLOPT_FOLLOWLOCATION => true,\r\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\r\n CURLOPT_CUSTOMREQUEST => 'POST',\r\n CURLOPT_POSTFIELDS =>'{\r\n \"date\": {\r\n \"day\": 28,\r\n \"month\": 5,\r\n \"year\": 2021\r\n }\r\n}',\r\n CURLOPT_HTTPHEADER => array(\r\n 'x-api-key: zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj',\r\n 'x-access-token: d31f0721-2f85-44e7-bcc6-15e19d1a53cc',\r\n 'Content-Type: application/json'\r\n ),\r\n));\r\n\r\n$response = curl_exec($curl);\r\n\r\ncurl_close($curl);\r\necho $response;", "language": "php" } ], "selectedLanguageId": "SEl6OII4xPcxgBAWxoMK1" }, "description": "", "currentNewParameter": { "label": "Header Parameter", "value": "headerParameters" }, "autoGeneratedAnchorSlug": "reintentar-una-ejecucin", "legacyHash": "umwAN3KmXEw67AzDGHOHm" } ``` ::: :::ApiMethodV2 ```json { "tab": "request", "url": "https://api.unicobros.com.ar/p/subscriptions/{id}/subscriber/{sid}/execution/{eid}/action/paid", "name": "Marcar una ejecución como Paga", "method": "GET", "request": { "pathParameters": [], "queryParameters": [ { "kind": "required", "name": "id", "type": "string", "description": "ID de la suscripción." }, { "kind": "required", "name": "sid", "type": "string", "description": "ID del suscriptor." }, { "kind": "required", "name": "eid", "type": "string", "description": "ID de la ejecución a marcar como paga." } ], "headerParameters": [ { "kind": "required", "name": "x-api-key", "type": "string", "description": "Clave API de su aplicación." }, { "kind": "required", "name": "x-access-token", "type": "string", "description": "Token de Acceso a la entidad para la cual desea realizar la operación." } ], "bodyDataParameters": [], "formDataParameters": [] }, "results": { "languages": [ { "id": "rKngguKsYZMepTLnQwlGx", "code": "{\n \"result\": true\n}", "language": "200" }, { "id": "ZbKLY5bbDDHoeEyOO7w6H", "code": "{\n \"message\": \"Ain't no cake like that.\"\n}", "language": "404" } ], "selectedLanguageId": "rKngguKsYZMepTLnQwlGx" }, "examples": { "languages": [ { "id": "trVAnD6v1UiSV8Y_4lUK-", "code": "fetch(\"https://api.cakes.com\", {\n \"method\": \"GET\",\n \"headers\": {\n \"Accept\": \"application/json\"\n }\n})\n.then(response => {\n console.log(response);\n})\n.catch(err => {\n console.error(err);\n});", "language": "javascript" } ], "selectedLanguageId": "trVAnD6v1UiSV8Y_4lUK-" }, "description": "", "currentNewParameter": { "label": "Query Parameter", "value": "queryParameters" }, "autoGeneratedAnchorSlug": "marcar-una-ejecucin-como-paga", "legacyHash": "72hpvf4XX6-7hkjiaXH21" } ``` ::: # WebHooks Los webhooks siempre serán enviados en formato `application/x-www-form-urlencoded` ### Nueva Suscripción ```json { "type": "subscription:registration", "data": { "result": true, "view": { "type": "card" }, "payment": { "id": "ABABBB78798", "description": "Esto es un registro!", "operation": { "type": "validation" }, "status": { "code": "200", "text": "Aprobado", "message": "Transacción Aprobada" }, "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": "soybatman@wayneinc.com" }, "user": { "name": "Juan Perez Wayne", "email": "juan.perez@mimail.com" }, "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": "juan.perez@mimail.com", "name": "Juan Perez Wayne" } }, "context": { "status": "success" }, "execution": {} } } ``` ### Cambio de Método de Pago ```json { "type": "subscription:change_source", "data": { "result": true, "view": { "type": "card" }, "payment": { "id": "ABC123123", "description": "Validación de Tarjeta.", "operation": { "type": "validation" }, "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": "soybatman@wayneinc.com" }, "user": { "name": "Juan Perez Wayne", "email": "juan.perez@mimail.com" }, "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": "juan.perez@mimail.com", "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" ```json { "data": { "context": { "status": "success" }, "customer": { "email": "juan.perez@mimail.com", "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": "juan.perez@mimail.com", "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 ```json { "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": "soybatman@gmail.com" } } } } ``` ### Suscriptor Activado ```javascript { "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": "soybatman@gmail.com" } } } } ```