Documentación de los Servicios Web
Zoom International Services C.A.

RIF J-00102174-4


Zoom ofrece servicios web en formato json con el motivo de extender la funcionalidad a sus clientes.

Requisitos


Servicios disponibles para Pagos Electrónicos:

getNroControlWS
Definición: Obtiene el número de control de Megasoft y genera el número de factura para el sistema (Aplica sólo para Botón de Pago).
Parámetros de Entrada:
Atributos de salida:
Ejemplo de respuesta:
    {
        "sucess": true,
        "Mensaje": {
            "control": "6083149888",
            "factura": "14891844821115",
            "monto": "1024.00"
        }
    } 
getXmlWS
Definición: Retorna la información del pago realizado según el número de control asigando por megasoft a la transacción (Aplica sólo para Botón de Pago).
Parámetros de Entrada:
Atributos de salida:
Ejemplo de respuesta:
	{
	  "sucess": false,
	  "Mensaje": {
		"control": "6081172032",
		"cod_afiliacion": "102174400",
		"factura": "14891769090914",
		"monto": "102425",
		"estado": "R",
		"codigo": "51",
		"descripcion": "FONDO INSUFICIENTE",
		"vtid": "00004201",
		"seqnum": "3",
		"authid": "",
		"authname": "P-EComExterior",
		"tarjeta": "540628******0768",
		"referencia": "000004",
		"terminal": "00004201",
		"lote": "1",
		"rifbanco": "",
		"afiliacion": "102174400",
		"voucher": " \n           BANCO EXTERIOR\n          RIF J-00002950-4\n          RECIBO DE COMPRA\n\nLABORATORIO DE PRUEBAS\nCHAGUARAMOS\nRIF:J-00343075-7\
            nAFILIADO:29012015\nTERMINAL:00004201 LOTE:1\nCUENTA:540628******0768 \nFECHA:10/03/2017 HORA:16:17:18\nTRACE:4 NRO. REF:000004\n\nTRANSACCION FALLIDA\
            nFONDOS INSUFICIENTES  (51)\n\n\n"
	  }
	} 

getMontoDocWs
Definición: Permite consultar los montos de los documentos (guías, facturas y notas de crédito) que se utilizarán para el pago electrónico (Botón de Pago, Pago por Transferencia) siempre y cuando los documentos No se encuentren anulados y No tengan estatus finales.
Método: POST
Parámetros de Entrada:
  • token: Valor obtenido de la autenticación del usuario (servicio web LoginGenUEWs). (NOT NULL)
  • tipoDoc: Tipo de documento a consultar: 1 (Guía), 2 (Factura), 4 (Nota de Crédito). (NOT NULL)
  • nroDoc: Número de documento a consultar (NOT NULL)
Atributos de salida (entidadRespuesta):
  • tipoDoc:
  • nroDoc: Número del documento
  • montodoc: Monto total del documento
  • totalpagado: Monto pagado del documento (pago parcial)
  • montopagar: Monto
  • fecha: Fecha de creación del documento (formato yyyymmdd)
  • base_imp: Base imponible del documento.
  • totaliva: IVA total del documento
  • vs_ret_iva: Valor sugerido de retención de IVA del documento (75%)
  • vs_ret_islr_2: Valor sugerido de retención de ISLR del documento (2%)
  • vs_ret_islr_3: Valor sugerido de retención de ISLR (3%)
  • vs_ret_islr_5: Valor sugerido de retención de ISLR (5%)
  • vs_ret_im: Valor sugerido de retención por Impuestos Municipales
  • vs_ret_tf: Valor sugerido de retención por Timbres Fiscales
  • vs_ret_tf: Valor sugerido de retención por Responsabilidad Social
Ejemplo de respuesta:
    {
      "codrespuesta": "COD_000",
      "mensaje": "CONSULTA REALIZADA EXITOSAMENTE",
      "entidadRespuesta": [
        {
          "tipoDoc": "1",
          "nroDoc": "1000120587",
          "montodoc": "5143",
          "totalpagado": "0",
          "montopagar": "5143",
          "fecha": "20161228",
          "base_imp": "4390.00",
          "totaliva": "526.8",
          "vs_ret_iva": "395.10",
          "vs_ret_islr_2": "87.80",
          "vs_ret_islr_3": "131.70",
          "vs_ret_islr_5": "219.50",
          "vs_ret_im": "87.80",
          "vs_ret_tf": "43.90",
          "vs_ret_rs": "131.70"
        }
      ]
    } 
createPagoWs
Definición: Permite crear el registro de pago electrónico (Bóton de Pago, Pago por Transferencia) de acuerdo a los parámetros correspondientes.

Método: POST
Parámetros de Entrada:
  • token: Valor obtenido de la autenticación del usuario (servicio web LoginGenUEWs). (NOT NULL)
  • idempresa: Código de la empresa (1=ZOOM). (NOT NULL)
  • codusuario: Código del usuario el cual registra el pago (Ver parámetro user_id del servicio LoginGenUEWs). (NOT NULL)
  • idtipotransbanc: Código del tipo de transacción bancaria (24 = Pago por Transferencia, 25 = Botón de Pago). (NOT NULL)
  • idcuentabanco: Código de la cuenta bancaria destino (Numérico). (NOT NULL)
  • codbancoori: Código de la cuenta bancaria origen (Pago por Transferencia) . (NULL)
  • referencia: Número de la referencia (Número de transferencia {Pago por transferencia}; Nro. identificación {Botón Pago} ). (NOT NULL)
  • rifcipagador: Cédula / RIF del pagador (formato: V-12345678, J-01234567-1). (NOT NULL)
  • nombrepagador: Nombre del pagador (NO incluir caracteres especiales). (NOT NULL)
  • emailpagador: Email del pagador. (NOT NULL)
  • tipousuario: Tipo de usuario que registra el pago: GE, UCI. (Ver parámetro usuario_externo del servicio LoginGenUEWs). (NOT NULL)
  • fechapago: Fecha de la realización del pago (formato sugerido: yyyy-mm-dd). (NOT NULL)
  • montoTotal: Monto del pago realizado. (NOT NULL)
  • tipoDoc: (Array) Tipo de documento (1 = Guía, 2 = Factura, 4 = Nota Crédito) (NULL) *
  • nroDoc: (Array) Número de documento. (NULL) *
  • monto: (Array) Monto del documento. (NULL) *
  • sortDoc: (Array) Fecha (formato yyyymmdd) para ordenar los documentos. (NULL) *
  • * Si existe algunos de los valores para los campos: tipoDoc, nroDoc, monto o sortDoc, deben enviarse obligatoriamente todos los valores.
    Ejemplo: tipoDoc = [1, 2] ; nroDoc = ['1100521421', '01E046-0001234567'] ; monto = ['1524.82', '5500.00']; sortDoc = ['20170102','20170320'];
  • nro_control: Número de control (Aplica para Botón de Pago). (NULL)
  • factura_bp: Número de factura (Aplica para Botón de Pago). (NULL)
  • codafiliacion: Código de afiliación (Aplica para Botón de Pago, se obtiene del servicio web getXmlWS). (NULL)
  • nro_tarjeta: Número de tarjeta crédito/débito del Cliente (Aplica para Botón de Pago). (NULL)
  • nro_terminal: Número de terminal (Aplica para Botón de Pago, se obtiene del servicio web getXmlWS). (NULL)
  • nro_lote: Número de lote (Aplica para Botón de Pago, se obtiene del servicio web getXmlWS). (NULL)
  • nro_aprobacion: Número de aprobación (Aplica para Botón de Pago, se obtiene del servicio web getXmlWS). (NULL)
Atributos de salida (entidadRespuesta):
  • fechapago, idempresa, idtipotransbanc, idestatuspago (1= pendiente), montototal, conciliado, idconciliado, idcuentabanco, codbancoori, numcuentaori, referencia, rifcipagador, nombrepagador, emailpagador, codusuario, tipousuario, fechahoracarga, nro_control, idpago (Generado por el sistema), listpagodoc (lista de documentos pagados).
Ejemplo de respuesta:
        {
          "codrespuesta": "COD_001",
          "mensaje": "INGRESO REALIZADO EXITOSAMENTE",
          "entidadRespuesta": {
            "fechapago": "2017-06-05",
            "idempresa": "1",
            "idtipotransbanc": "24",
            "idestatuspago": 1,
            "montototal": "1500",
            "conciliado": false,
            "idconciliado": 0,
            "idcuentabanco": "0",
            "codbancoori": "0",
            "numcuentaori": null,
            "referencia": "001234567",
            "rifcipagador": "V-16952402",
            "nombrepagador": "VICTOR G. POETA",
            "emailpagador": "vpoeta@grupozoom.com",
            "codusuario": "6082",
            "tipousuario": "UCI",
            "fechahoracarga": "2017-06-07 14:09:43",
            "nro_control": null,
            "codafiliacion": null,
            "nro_tarjeta": null,
            "nro_terminal": null,
            "nro_lote": null,
            "monto_ret_total": null,
            "nro_aprobacion": null,
            "idpago": 913,
            "listpagodoc": [
              {
                "idpago": 913,
                "codguia": "1000119746",
                "monto": "1500",
                "id": 515
              }
            ]
          }
        } 
getInfoPagoWs
Definición: Permite consultar los registros de pagos electrónicos (Bóton de Pago, Pago por Transferencia) de acuerdo a los parámetros correspondientes.

Método: GET, POST
Parámetros de Entrada:
  • token: Valor obtenido de autenticación del usuario (servicio web LoginGenUEWs) o suministrado por ZOOM. (NOT NULL)
  • idpago:(Array) Número de pago (Integer) (NULL)
  • idestatuspago:(Array) Código de estatus de pago (Integer) (NULL)
  • idempresa:(Array) Código de la empresa (Integer) (NULL)
  • idtipotransbanc:(Array) Código del tipo de transacción bancaria (24=Pago por Transferencia, 25=Botón de Pago) (NULL)
  • idcuentabanco:(Array) Código de la cuenta de banco destino (NULL)
  • referencia:(Array) Número de referencia / transferencia (NULL)
  • codusuario:(Array) Código del usuario que registró el pago (NULL)
  • fechapagoDesde: Fecha de pago {Desde} (NULL)
  • fechapagoHasta: Fecha de pago {Hasta} (NULL)
  • fechacarga: Fecha de creación del registro de pago (NULL)
  • montoTotal: Monto total pagado (NULL)
  • codoficina: Código de la Oficina (asociado al usuario que registró el pago) (Integer) (NULL)
  • codcliente: Código de Cliente (del usuario que registró el pago) (Integer) (NULL)
  • guia: Número de Guía asociada a los pagos (Integer) (NULL)
  • factura: Número de Factura asociada a los pagos (NULL)
  • fechasync: Fecha (formato yyyy-mm-dd hh:ii) para sincronización desde Sistema Cinaruco (busca los registros donde la fecha de creación sea igual o mayor a la ingresada) (NULL)
  • todosEnviosEntregados: Si se envía 1, se filtran los registros de pagos con guías en estatus Entregado. Si se envía 0, devuelve registros con guías que No tengan dicho Estatus (NULL)
Ejemplo de respuesta exitosa:
        {
          "codrespuesta": "COD_000",
          "mensaje": "CONSULTA REALIZADA EXITOSAMENTE",
          "entidadRespuesta": [
            {
              "idpago": 801,
              "fechapago": "2017-05-15",
              "idempresa": 1,
              "idtipotransbanc": 24,
              "idestatuspago": 1,
              "montototal": "500",
              "conciliado": false,
              "idconciliado": 0,
              "idcuentabanco": 213,
              "codbancoori": 16,
              "numcuentaori": null,
              "referencia": "435345353",
              "rifcipagador": "V-12345678",
              "nombrepagador": "PEDRO CASIMIRO",
              "emailpagador": "pedrocasimiro123@grupozoom.com",
              "codusuario": 3712,
              "fechahoracarga": "2017-05-15 16:12:05",
              "tipousuario": "GE",
              "monto_ret_iva": "123",
              "monto_ret_islr": "0",
              "monto_ret_tf": "0",
              "monto_ret_im": "0",
              "monto_ret_rs": "0",
              "monto_ret_nc_iva": "0",
              "monto_ret_nc_islr": "0",
              "nro_control": null,
              "factura": null,
              "codafiliacion": null,
              "nro_tarjeta": null,
              "nro_terminal": null,
              "nro_lote": null,
              "monto_ret_total": null,
              "codoficinaret": 46,
              "suma_montosret": "123",
              "listusuario": {
                "codusuario": 3712,
                "codcliente": 100000778,
                "nombre": "PEDRO CASIMIRO",
                "codoficina": 46
              },
              "todosEnviosEntregados": true,
              "listestatuspago": {
                "idestatuspago": 1,
                "nombre": "PENDIENTE",
                "siglas": "PE",
                "orden": 1
              },
              "listempresa": {
                "codempresa": 1,
                "nombre": "ZOOM"
              },
              "listpagodoc": [
                {
                  "id": 398,
                  "idpago": 801,
                  "codguia": 1000118390,
                  "codfactura": null,
                  "monto": "500",
                  "notadebitocredito_id": null,
                  "listguia": {
                    "codguia": 1000118390,
                    "codcliente": 1,
                    "fecha": "2016-12-22",
                    "totalpag": "769.17",
                    "codservicio": 1,
                    "codtipopag": 2,
                    "codoficinaori": 46,
                    "listservicio": {
                      "codservicio": 1,
                      "nombre": "COD NACIONAL",
                      "siglas": "BCD"
                    },
                    "listtipopago": {
                      "codtipopag": 2,
                      "nombre": "CREDITO"
                    },
                    "listestatus": {
                      "codestatus": 7,
                      "nombre": "ENTREGADO AL DESTINO",
                      "siglas": "E",
                      "codtipo": 8
                    }
                  },
                  "listfactura": null,
                  "listnota": null
                }
              ],
              "listcuentabanco": {
                "codcuentabanco": 213,
                "codbanco": 13,
                "codcuenta": "01080950960100010262",
                "listbanco": {
                  "codbanco": 13,
                  "nombre": "BANCO PROVINCIAL"
                }
              },
              "listbancoorigen": {
                "codbanco": 16,
                "nombre": "BANCO BANESCO"
              },
              "listtrackingpago": [
                {
                  "idtrackingpago": 2480,
                  "idpago": 801,
                  "idestatuspago": 1,
                  "fechahora": "2017-05-15 16:12:05",
                  "codusuario": 3712,
                  "observacion": "NUEVO REGISTRO"
                  "tipousuario": "GE",
                    "listusuario": {
                        "codusuario": 3712,
                        "nombre": "PEDRO CASIMIRO"
                    }
                }
              ],
              "listtipotransbancaria": {
                "id_tipotransbancaria": 24,
                "nombre": "TRANSFERENCIA BANCARIA",
                "siglas": "TRANBAN"
              },
              "listpagoarchivo": [],
              "listconciliacion": null,
              "listpagobanco": null,
              "listusuariocasint": null,
              "listusuarioge": {
                "codusuario": 3712,
                "nombre": "PEDRO CASIMIRO",
                "codoficina": 46,
                "listclienteweb": {
                  "codusuario": 3712,
                  "master": true,
                  "codcliente": 100000778
                }
              }
              "listpagotarjetadetalle": null
            }
          ]
        } 

Posibles respuestas de error:
            {
                "codrespuesta": "CODE_000",
                "mensaje": "INFORMACION NO EXISTE EN BASE DE DATOS",
                "entidadRespuesta": []
            } 

            {
                "codrespuesta": "CODE_002",
                "mensaje": "LOS PARAMETROS INGRESADOS NO SON CORRECTOS",
                "entidadRespuesta": {
                    "idpago.0": [
                        "El campo idpago.0 debe ser un entero."
                    ]
                }
            } 

            {
                "codrespuesta": "CODE_003",
                "mensaje": "ERROR EN LA LLAMADA AL SERVICIO",
                "entidadRespuesta": {
                    "tipoError": "NotFoundHttpException",
                    "info": "No existe ruta o servicio web ingresado"
                }
            }