MÓDULOS
Suscripciones/Recurrencia
Suscriptores
16 min
{ "tab" "request", "url" "https //api mobbex com/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\@mobbex 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\\" \\"//mobbex 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\@mobbex 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 mobbex com/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" "\<?php\r\n\r\n$curl = curl init();\r\n\r\ncurl setopt array($curl, array(\r\n curlopt url => 'https //api mobbex com/p/subscriptions/qllsnbv35/subscriber?page=0',\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" "fnapjqw82zxjt3ucbc436" }, "description" "esa api permite obtener todos los suscriptores de una suscripción", "currentnewparameter" { "label" "path parameter", "value" "pathparameters" } } { "tab" "examples", "url" "https //api mobbex com/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 //mobbex com/p/subscriptions/t691pomk62sgc7chak/subscriber/y7b3p541b9vfbythsz/source\\",\n \\"subscriberurl\\" \\"https //mobbex 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\@mobbex com\\",\n \\"identification\\" \\"12123123\\",\n \\"name\\" \\"test mobbex\\"\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 mobbex com/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" "\<?php\r\n\r\n$curl = curl init();\r\n\r\ncurl setopt array($curl, array(\r\n curlopt url => 'https //api mobbex com/p/subscriptions/t691pomk62sgc7chak/subscriber',\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 \\"customer\\" {\r\n \\"email\\" \\"demo\@mobbex com\\",\r\n \\"identification\\" \\"12123123\\",\r\n \\"name\\" \\"test mobbex\\"\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}',\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" }, { "id" "tftvkyk7epo7vkg7m0yfv", "code" "import requests\r\n\r\nurl = \\"https //api mobbex com/p/subscriptions/t691pomk62sgc7chak/subscriber\\"\r\n\r\npayload=\\"{\\\r\\\n \\\\\\"customer\\\\\\" {\\\r\\\n \\\\\\"email\\\\\\" \\\\\\"demo\@mobbex com\\\\\\",\\\r\\\n \\\\\\"identification\\\\\\" \\\\\\"12123123\\\\\\",\\\r\\\n \\\\\\"name\\\\\\" \\\\\\"test mobbex\\\\\\"\\\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}\\"\r\nheaders = {\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\nresponse = requests request(\\"post\\", url, headers=headers, data=payload)\r\n\r\nprint(response text)\r\n", "language" "python" } ], "selectedlanguageid" "pcaibxl7rd7t u9koj sc" }, "description" "permite crear un suscriptor para una determinada suscripción", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } 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 { "tab" "request", "url" "https //api mobbex com/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\@mobbex com\\",\n \\"identification\\" \\"12123123\\",\n \\"name\\" \\"test mobbex\\"\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\@mobbex com\\",\n \\"identification\\" \\"12123123\\",\n \\"name\\" \\"test mobbex\\"\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 //mbbx 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\\" \\"//mobbex 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 //mobbex 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 mobbex com/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" "\<?php\r\n\r\n$curl = curl init();\r\n\r\ncurl setopt array($curl, array(\r\n curlopt url => 'https //api mobbex com/p/subscriptions/t691pomk62sgc7chak/subscriber/y7b3p541b9vfbythsz',\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" "og73rxun8vv3 58bfgtij" }, "description" "permite ver un suscriptor en particular en base al id de suscripción y id del suscriptor", "currentnewparameter" { "label" "header parameter", "value" "headerparameters" } } { "tab" "examples", "url" "https //api mobbex com/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 mobbex com/p/subscriptions/abc123/subscriber/def456' \\\\\r\n header 'x api key zj8lftbx6ba8d611e9io13fdzawj0qmko1hn1yij' \\\\\r\n header 'x access token d31f0721 2f85 44e7 bcc6 15e19d1a53cc' \\\\\r\n header 'content type application/json' \\\\\r\n data raw '{\r\n \\"customerdata\\" {\r\n \\"name\\" \\"cliente demo\\"\\",\r\n \\"phone\\" \\"12123123\\"\r\n }\r\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 mobbex com/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');\r\nvar options = {\r\n 'method' 'post',\r\n 'url' 'https //api mobbex com/p/subscriptions/abc123/subscriber/def456',\r\n 'headers' {\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 body json stringify({\r\n \\"customerdata\\" {\r\n \\"name\\" \\"cliente demo\\",\r\n \\"phone\\" \\"12123123\\"\r\n }\r\n })\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});", "language" "nodejs" }, { "id" "wbbhipd929uswil4dvsfo", "code" "import requests\r\nimport json\r\n\r\nurl = \\"https //api mobbex com/p/subscriptions/abc123/subscriber/def456\\"\r\n\r\npayload = json dumps({\r\n \\"customerdata\\" {\r\n \\"name\\" \\"cliente demo\\",\r\n \\"phone\\" \\"12123123\\"\r\n }\r\n})\r\nheaders = {\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\nresponse = requests request(\\"post\\", url, headers=headers, data=payload)\r\n\r\nprint(response text)", "language" "python" } ], "selectedlanguageid" "bqje8u4fdmlwqr6ajitmb" }, "description" "", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } cambiar estado del suscriptor { "tab" "examples", "url" "https //api mobbex com/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 mobbex com/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" } } { "tab" "examples", "url" "https //api mobbex com/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 mobbex com/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" } } { "tab" "examples", "url" "https //api mobbex com/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 mobbex com/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" } } cambiar agenda del suscriptor { "tab" "request", "url" "https //api mobbex com/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 mobbex com/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" "\<?php\r\n\r\n$curl = curl init();\r\n\r\ncurl setopt array($curl, array(\r\n curlopt url => '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" } } 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" { "tab" "request", "url" "https //api mobbex com/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 mobbex com/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" "\<?php\r\n\r\n$curl = curl init();\r\n\r\ncurl setopt array($curl, array(\r\n curlopt url => '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" } } ejecuciones { "tab" "request", "url" "https //api mobbex com/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 mobbex com/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" "\<?php\r\n\r\n$curl = curl init();\r\n\r\ncurl setopt array($curl, array(\r\n curlopt url => '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" } } { "tab" "examples", "url" "https //api mobbex com/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 mobbex com/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" "\<?php\r\n\r\n$curl = curl init();\r\n\r\ncurl setopt array($curl, array(\r\n curlopt url => '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" } } { "tab" "examples", "url" "https //api mobbex com/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 mobbex com/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" "\<?php\r\n\r\n$curl = curl init();\r\n\r\ncurl setopt array($curl, array(\r\n curlopt url => '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" } } { "tab" "examples", "url" "https //api mobbex com/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({\r\n \\"date\\" {\r\n \\"day\\" 10,\r\n \\"month\\" 4,\r\n \\"year\\" 2021\r\n }\r\n});\r\n\r\nvar xhr = new xmlhttprequest();\r\nxhr withcredentials = true;\r\n\r\nxhr addeventlistener(\\"readystatechange\\", function() {\r\n if(this readystate === 4) {\r\n console log(this responsetext);\r\n }\r\n});\r\n\r\nxhr open(\\"post\\", \\"https //api mobbex com/p/subscriptions/u5485jkgty/subscriber/5sfty4iplt/action/schedule\\");\r\nxhr setrequestheader(\\"x api key\\", \\"zj8lftbx6ba8d611e9io13fdzawj0qmko1hn1yij\\");\r\nxhr setrequestheader(\\"x access token\\", \\"d31f0721 2f85 44e7 bcc6 15e19d1a53cc\\");\r\nxhr setrequestheader(\\"content type\\", \\"application/json\\");\r\n\r\nxhr send(data);", "language" "javascript" }, { "id" "pkcelrxsrqnfqjmag ns2", "code" "\<?php\r\n\r\n$curl = curl init();\r\n\r\ncurl setopt array($curl, array(\r\n curlopt url => '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" } } acciones sobre una ejecución { "tab" "request", "url" "https //api mobbex com/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 mobbex com/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" "\<?php\r\n\r\n$curl = curl init();\r\n\r\ncurl setopt array($curl, array(\r\n curlopt url => '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" } } { "tab" "request", "url" "https //api mobbex com/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" } } 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" "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 { "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" { "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 { "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 { "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" } } } }