Agregadores y PSPaaS
ABM de Sub-comercios
3 min
name crear o editar sub comercio method post url https api sugaway com p operator entity description este endpoint le permitir crear o editar un sub comercio tab examples examples languages id e fmgzkscmefowpm niv2 language curl code curl location request post https api sugaway com p operator entity n header accept application json n header content type application json n data raw reference string legalname string name string taxidtype string taxid string mcc string country string address object zipcode string city string state string customlabel id t7pyyv4rponhvw4zuybsr language nodejs code var request require request ; nvar options n method post n url https api sugaway com p operator entity n headers n accept application json n content type application json n n body json stringify n reference string n legalname string n name string n taxidtype string n taxid string n mcc string n country string n address object n zipcode string n city string n state string n n n ; nrequest options function error response n if error throw new error error ; n console log response body ; n ; n customlabel id lt6m5shm6i9ruty63eaug language javascript code var myheaders new headers ; nmyheaders append accept application json ; nmyheaders append content type application json ; n nvar raw json stringify n reference string n legalname string n name string n taxidtype string n taxid string n mcc string n country string n address object n zipcode string n city string n state string n ; n nvar requestoptions n method post n headers myheaders n body raw n redirect follow n ; n nfetch https api sugaway com p operator entity requestoptions n then response response text n then result console log result n catch error console log error error ; customlabel id cmeuw1jmheqaa8nngpsmh language python code import requests nimport json n nurl https api sugaway com p operator entity n npayload json dumps n reference string n legalname string n name string n taxidtype string n taxid string n mcc string n country string n address object n zipcode string n city string n state string n nheaders n accept application json n content type application json n n nresponse requests request post url headers headers data payload n nprint response text n customlabel id 4d5jqnzevuj4hzyoa 32i language ruby code require uri nrequire json nrequire net http n nurl uri https api sugaway com p operator entity n nhttps net http new url host url port nhttps use ssl true n nrequest net http post new url nrequest accept application json nrequest content type application json nrequest body json dump n reference string n legalname string n name string n taxidtype string n taxid string n mcc string n country string n address object n zipcode string n city string n state string n n nresponse https request request nputs response read body n customlabel selectedlanguageid e fmgzkscmefowpm niv2 results languages id 2uamsws nwcpss vxz8k language 200 customlabel code n result true n data n uid n reference n n selectedlanguageid 2uamsws nwcpss vxz8k request pathparameters queryparameters headerparameters name x api key kind optional type string description api key del operador children name x access token kind optional type string description access token del operador children bodydataparameters name reference kind required type string description identificador nico del sub comercio este id debe ser de su sistema y debe ser nico name legalname kind required type string description nombre legal del comercio como se encuentra registrado en el fisco children name name kind required type string description nombre comercial children name taxidtype kind required type string description tipo de identificador tributario valores aceptados argentina arg cuit arg cuil arg dni chile chl rut uruguay ury rut m xico mex rfc children name taxid kind required type string description identificador tributario basado en el tipo elegido children name mcc kind optional type string description c digo de categor a de comercio o mcc ver secci n cod de categoria de comercios en caso de no enviarse se toma el por defecto en base al c digo de actividad nacional children name country kind required type string description pa s en formato iso 3166 1 alpha 3 valores aceptados arg chl ury mex children name address kind required type object description direcci n del comercio children name street kind required type string description calle name number kind required type string description altura name floor kind optional type string description piso name flat kind optional type string description departamento name notes kind optional type string description notas opcionales sobre la direcci n name zipcode kind required type string description c digo postal en argentina se debe utilizar el c digo postal argentino cpa cuyo formato es lnnnnlll children name city kind required type string description ciudad del comercio children name state kind required type string description provincia o estado del comercio para argentina se debe utilizar la clasificacion propuesta children name email kind required type string description email del comercio children name phone kind required type string description tel fono del comercio children name obligatedsubject kind optional type string description indica si el comercio es sujeto obligado v lido para argentina children name owner kind required type object description indica informaci n sobre el due o del comercio personas f sicas o representante legal personas jur dicas children name name kind required type string description indica el nombre del due o del comercio en el caso de pf se debe completar con los mismos datos del titular name pep kind required type boolean description indica si el due o es persona expuesta pol ticamente name identification kind required type string description indica el cuit cuil del due o del comercio; si el comercio es pf se debe completar con los mismos datos del titular name birthdate kind optional type string description indica la fecha de nacimiento del due o del comercio nformato dd mm yyyy name nationality kind optional type string description indica la nacionalidad del due o del comercio utilizando la nomenclatura iso 3166 3 en caso de no enviarse se asume el mismo pa s que el comercio name civilstatus kind optional type string description estado civil del due o del comercio opciones v lidas unmarried married widowed divorced name occupation kind optional type string description ocupaci n o profesi n del due o del comercio name countrycategorycode kind required type string description c digo de actividad del comercio a nivel nacional children name secondarycategorycodes kind optional type array description array con los c digos de actividad secundarios del comercio a nivel nacional array de strings children name accounttype kind optional type string description permite definir una cuenta bancaria o virtual para el destino de los fondos aplicar s lo en los casos requeridos y de forma opcional aplicar s lo en los casos requeridos y previa autorizaci n de suga children name accountnumber kind optional type string description en el caso de especificar una cuenta indica el n mero de cuenta de destino de los fondos children name statetaxes kind optional type string description contiene el listado de los reg menes impositivos por provincia que est n implicados en el subcomercio iibb en argentina children name statetaxesid kind optional type string description permite definir el n mero de inscripci n en los reg menes impositivos por provincia children name user kind optional type object description usuario que podr utilizar la entidad children name email kind optional type string description email del usuario el mismo debe haber sido creado previamente si el usuario no existe ser ignorado pero la entidad ser creada formdataparameters currentnewparameter label body parameter value bodydataparameters la respuesta del servicio será con el siguiente format respuesta exitosa (200) { "result" true, "data" { "uid" "", "reference" "" } } respuesta fallida (200) { "result" false, "code" "error code", "error" "mensaje de error" } posibles códigos de error submerchant\ invalid reference submerchant\ reference not found entity\ tax id type invalid entity\ country invalid state entity\ invalid country entity\ invalid mcc entity\ invalid zip code entity\ invalid address entity\ invalid account entity\ invalid name entity\ invalid legal name name transferor o cambiar due o del comercio method post url https api sugaway com p operator entity uid action transfer description permite transferir o cambiar el usuario de un comercio tab examples examples languages id 2 iyzi7w8w qig2j5 wlt language curl code curl location g request delete https api sugaway com p operator entity uid uid n header accept application json n header content type application json customlabel id fctbx zkcic9t qyghqdl language nodejs code var request require request ; nvar options n method delete n url https api sugaway com p operator entity uid uid n headers n accept application json n content type application json n n ; nrequest options function error response n if error throw new error error ; n console log response body ; n ; n customlabel id mk tdyadnauyksi9noinp language javascript code var myheaders new headers ; nmyheaders append accept application json ; nmyheaders append content type application json ; n nvar requestoptions n method delete n headers myheaders n redirect follow n ; n nfetch https api sugaway com p operator entity uid uid requestoptions n then response response text n then result console log result n catch error console log error error ; customlabel id mrnfsnlxdptc5pjq 0c1m language python code import requests nimport json n nurl https api sugaway com p operator entity uid uid n npayload nheaders n accept application json n content type application json n n nresponse requests request delete url headers headers data payload n nprint response text n customlabel id qipv dnuo6vjba1sdxtok language ruby code require uri nrequire json nrequire net http n nurl uri https api sugaway com p operator entity uid uid n nhttps net http new url host url port nhttps use ssl true n nrequest net http delete new url nrequest accept application json nrequest content type application json n nresponse https request request nputs response read body n customlabel selectedlanguageid 2 iyzi7w8w qig2j5 wlt results languages id 2fefdvh6bqcddwabyp p language 200 customlabel code n result true n id nguhdqe93s fosngjadlk language 404 customlabel code n message ain t no cake like that n selectedlanguageid 2fefdvh6bqcddwabyp p request pathparameters name uid kind optional type string description identificador nico del comercio generado durante la creaci n children queryparameters headerparameters name x api key kind optional type string description children name x access token kind optional type string description children bodydataparameters name email kind optional type string description email del usuario el mismo debe haber sido creado previamente si el usuario no existe ser ignorada su transferencia children formdataparameters currentnewparameter label body parameter value bodydataparameters name eliminar comercio method delete url https api sugaway com p operator entity uid description permite eliminar un comercio tab examples examples languages id 2 iyzi7w8w qig2j5 wlt language curl code curl location g request delete https api sugaway com p operator entity uid uid n header accept application json n header content type application json customlabel id fctbx zkcic9t qyghqdl language nodejs code var request require request ; nvar options n method delete n url https api sugaway com p operator entity uid uid n headers n accept application json n content type application json n n ; nrequest options function error response n if error throw new error error ; n console log response body ; n ; n customlabel id mk tdyadnauyksi9noinp language javascript code var myheaders new headers ; nmyheaders append accept application json ; nmyheaders append content type application json ; n nvar requestoptions n method delete n headers myheaders n redirect follow n ; n nfetch https api sugaway com p operator entity uid uid requestoptions n then response response text n then result console log result n catch error console log error error ; customlabel id mrnfsnlxdptc5pjq 0c1m language python code import requests nimport json n nurl https api sugaway com p operator entity uid uid n npayload nheaders n accept application json n content type application json n n nresponse requests request delete url headers headers data payload n nprint response text n customlabel id qipv dnuo6vjba1sdxtok language ruby code require uri nrequire json nrequire net http n nurl uri https api sugaway com p operator entity uid uid n nhttps net http new url host url port nhttps use ssl true n nrequest net http delete new url nrequest accept application json nrequest content type application json n nresponse https request request nputs response read body n customlabel selectedlanguageid 2 iyzi7w8w qig2j5 wlt results languages id 2fefdvh6bqcddwabyp p language 200 customlabel code n result true n id nguhdqe93s fosngjadlk language 404 customlabel code n message ain t no cake like that n selectedlanguageid 2fefdvh6bqcddwabyp p request pathparameters name uid kind optional type string description identificador nico del comercio generado durante la creaci n children queryparameters headerparameters name x api key kind optional type string description children name x access token kind optional type string description children bodydataparameters formdataparameters currentnewparameter label header parameter value headerparameters name obtener sub comercios method get url https api sugaway com p operator entity description esta api permite obtener un listado con todos los sub comercios dados de alta tab examples examples languages id 2 iyzi7w8w qig2j5 wlt language curl code curl location g request get https api sugaway com p operator entity n header accept application json n header content type application json customlabel id fctbx zkcic9t qyghqdl language nodejs code var request require request ; nvar options n method delete n url https api sugaway com p operator entity uid uid n headers n accept application json n content type application json n n ; nrequest options function error response n if error throw new error error ; n console log response body ; n ; n customlabel id mk tdyadnauyksi9noinp language javascript code var myheaders new headers ; nmyheaders append accept application json ; nmyheaders append content type application json ; n nvar requestoptions n method delete n headers myheaders n redirect follow n ; n nfetch https api sugaway com p operator entity uid uid requestoptions n then response response text n then result console log result n catch error console log error error ; customlabel id mrnfsnlxdptc5pjq 0c1m language python code import requests nimport json n nurl https api sugaway com p operator entity uid uid n npayload nheaders n accept application json n content type application json n n nresponse requests request delete url headers headers data payload n nprint response text n customlabel id qipv dnuo6vjba1sdxtok language ruby code require uri nrequire json nrequire net http n nurl uri https api sugaway com p operator entity uid uid n nhttps net http new url host url port nhttps use ssl true n nrequest net http delete new url nrequest accept application json nrequest content type application json n nresponse https request request nputs response read body n customlabel selectedlanguageid 2 iyzi7w8w qig2j5 wlt results languages id 2fefdvh6bqcddwabyp p language 200 customlabel code n result true n id nguhdqe93s fosngjadlk language 404 customlabel code n message ain t no cake like that n selectedlanguageid 2fefdvh6bqcddwabyp p request pathparameters queryparameters headerparameters name x api key kind optional type string description children name x access token kind optional type string description children bodydataparameters formdataparameters currentnewparameter label header parameter value headerparameters