Primeros Pasos
La documentación de CuentaVirtual le permitirá a nuestros clientes poder realizar todos los desarrollos e integraciónes necesarias para utilizar todas nuestras herramientas y servicios de valor agregado de forma segura y automatizada.
Introducción
API significa "Application Programming Interface". Una API proporciona un conjunto de comandos, funciones y protocolos para facilitar la programación de software. Estas funciones predefinidas simplifican la interacción del programador con el sistema operativo, ya que el hardware (monitor, datos en el disco duro, etc.) no tiene que ser direccionado directamente. En lo que se refiere a Internet, las APIs Web están a la vanguardia y también sirven como interfaz para permitir el uso de funciones existentes de terceros.
CuentaVirtual entrega a las Empresas/Comercios una API REST HTTP con mensajeria de tipo JSON para trasparentar y acercar los datos y servicios a quien lo requiera.
Autenticación API
Ante la imparable evolución de aplicaciones, frameworks, lenguajes y alternativas para facilitarnos las tareas de Desarrollo Web en diferentes ámbitos, hablaremos a continuación sobre el modelo de autenticación para API REST de nuestra infraestructura. Las API REST que nuestro cloud entrega son uno de los mejores recursos actuales para cualquier desarrollador y en esta ocasión, queremos que conozcas mejor las características y el flujo de este modelo.
En el mundo de las API REST, se deben implementar flujos distintos de los habituales en cuanto a la autenticación de usuarios, ya que su arquitectura nos ofrece otro tipo de recursos que los tradicionales. Por lo general, en las aplicaciones web tradicionales, se utilizan las variables de sesión como soporte para memorizar el usuario. Esto viene a decir que en el momento de autenticar un usuario, el servidor genera las correspondientes variables de sesión y en las siguientes páginas consultadas por ese mismo cliente, es capaz de recordar al usuario.
Sin embargo, en las aplicaciones REST, esto no es posible, ya que una de las limitaciones de este sistema es que no se dispone de variables de sesión. Esto es debido a motivos de escalabilidad, ya que las API REST suelen estar alojadas en un cluster de servidores. La solución habitual para salvar este problema es la autenticación por token.
Flujo de autenticación por usuario y contraseña:
Para acceder a nuestras integraciones y utilizar nuestros servicios es necesario que cuente con una cuenta activa aprobada y tenga acceso a los siguientes datos clave de su cuenta:
- Empresa: Es el código único de empresa asignado por CuentaVirtual en nuestros sistemas.
- Usuario y Contraseña: Es el usuario con el que ingresa al panel de acceso al sistema. Dicho usuario debe estar habilitado en el módulo de seguridad para utilizar las integraciones externas.
- ApiToken: Es el código token único para su empresa y que se obtiene desde el menú de configuraciones -> Datos de configuración.
Seguridad en la comunicaciones:
Si la Empresa/Negocio asi lo requiere la API de acceso puede estar alcanzada por los siguientes métodos de seguridad extra:
- Conexión VPN entre CuentaVirtual y los servidores de la Empresa/Negocio.
- Filtrado IP de Origen para los llamados desde servidores específicos de una Empresa/Negocio.
- Mecanizmo de autenticación OAuth2
Probar Autenticación en Swagger
API CodSeg
Puede que dentro de alguno de los llamados/endpoint de nuestra API exista una variable esperada llamada "CodSeg".
Con el fin de incrementar la seguridad de nuestras transacciones la variable "CodSeg" permite realizar una firma de los datos enviados en el origen y que CuentaVirtual se asegure de su lado que dicha transacción / datos no ha sido alterada en su camino.
Método para generar el "CodSeg":
Independientemente del lenguaje de programación con el cual se realice el llamado a la API, si el endpoint de la API así lo requiere el codseg se debe enviar mediante GET HTTP dentro de la variable "codseg" y será generado de la siguiente manera:
APIS POST JSON:
- Se copiará todo el json generado a enviar en una variable string (JSON_STRING).
- Se debe concatenar la variable JSON_STRING con la variable APIToken asignada por CuentaVirtual para su empresa.
- Se debe generar un hash md5 del resultado concatenado.
$codseg = MD5(concat($JSON_STRING, $apitoken));
APIS HTTP GET:
- Se copiará todas las variables y sus contenidos del get en una variable string (GET_STRING).
- Se debe concatenar la variable GET_STRING con la variable APIToken asignada por CuentaVirtual para su empresa.
- Se debe generar un hash md5 del resultado concatenado.
$codseg = MD5(concat($GET_STRING, $apitoken));
Entornos
Con el fin de separar logicamente los entornos, al momento de recibir acceso a nuestra API, las Empresas/Negocios recibirán acceso a diferentes entornos:
- Homologación: http://cont1-test1.certisend.com/
- Producción: https://cont.apipagos.com/
Así mismo si el cliente asi lo requiere podra realizar independientemente llamados a los diferentes servidores de nuestra nube para autoadministrarse la contingencia ante fallos (Consultar a Soporte).
API
A continuación se detalla cada uno de los diferentes EndPoint/Servicios y el funcionamiento de cada uno de los mismos.
Publicar Deuda
La API de publicación de deuda permite a la Empresa/Comercio realizar el envio de un comprobante para que pueda ser pagado por sus clientes mediante cualquiera de las plataformas parametrizadas para esa cuenta en CuentaVirtual. A continuación se detalla el funcionamiento del endpoint de publicación de deuda:
El endpoint a utilizar es el "api/v1/apipagos/core/create_doc" y dicho endpoint recibira por medio de GET la variable CodSeg y por medio del body un JSON con las siguientes variables:
- emision -> VARCHAR(100) (Obligatorio): Indica una referencia de la emisión del comprobante para ser mostrada al cliente.
- tipo -> VARCHAR(50) (Obligatorio): Refiere al tipo de comprobante configurado en CuentaVirtual. Dicho tipo de comprobante brindara la forma de tratamiento de dicha publicación y los métodos de pago habilitados.
- idworkflow -> INT(6): Indica si se quiere ejecutar un workflow al recibir dicho comprobante (Consultar a Soporte).
- cuituser -> VARCHAR(20): Permite identificar el CUIT del cliente que debe acceder a dicho comprobante.
- emailuser -> VARCHAR(200): Permite identificar el Email del cliente que debe acceder a dicho comprobante.
- fecha -> DATETIME (Obligatorio): Fecha de la publicación de la deuda en formato YYYY-mm-dd.
- titulo -> VARCHAR(100) (Obligatorio): Título de la Deuda.
- documento -> TEXT: Detalle o descripcion del comprobante en formato HTML.
- link -> VARCHAR(1000): Link / URL del comprobante de la deuda.
- campo1 -> VARCHAR(200): Campo Adicional 1 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo2 -> VARCHAR(200): Campo Adicional 2 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo3 -> VARCHAR(200): Campo Adicional 3 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo4 -> VARCHAR(200): Campo Adicional 4 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo5 -> VARCHAR(200): Campo Adicional 5 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo6 -> VARCHAR(200): Campo Adicional 6 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo7 -> VARCHAR(200): Campo Adicional 7 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo8 -> VARCHAR(200): Campo Adicional 8 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo9 -> VARCHAR(200): Campo Adicional 9 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo10 -> VARCHAR(200): Campo Adicional 10 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- fechavencimiento -> DATETIME: Fecha de Vencimiento de la deuda en formato YYYY-mm-dd.
- fechavencimiento2 -> DATETIME: Fecha de 2do Vencimiento de la deuda en formato YYYY-mm-dd.
- fechavencimiento3 -> DATETIME: Fecha de 3re Vencimiento de la deuda en formato YYYY-mm-dd.
- idestado -> tinyint(4): Estado por defecto de la publicación de deuda.
- 0-Pendiente
- 1-Pago
- 2-Cancelado
- 3-Vencido
- 4-No Habilitado.
- 5-No Disponible
- moneda -> VARCHAR(50) (Obligatorio): Moneda de la publicación de la deuda según ISO 4217 Monedas Internacionales.
- importe -> DECIMAL(20,4) (Obligatorio): Importe de la publicación de la deuda sin separador de miles y con punto como separador de 4 decimales. Ej: 45874.2400
- importevto2 -> DECIMAL(20,4): Importe de la publicación de la deuda luego del vencimiento sin separador de miles y con punto como separador de 2 decimales. Ej: 45874.24
- importevto3 -> DECIMAL(20,4): Importe de la publicación de la deuda luego del 2do vencimiento sin separador de miles y con punto como separador de 2 decimales. Ej: 45874.24
- enviamail -> true/false: Indica si envia o no un email de aviso al cliente.
- enviapush -> true/false: Indica si envia o no un push mobile de aviso al cliente.
- enviasms -> true/false: Indica si envia o no un SMS de aviso al cliente.
- enviawhatsapp -> true/false: Indica si envia o no un Whatsapp de aviso al cliente.
- idtemplatecbte -> Indica el ID del template en caso que se requiera generar un comprobante dinamicamente en base a un template pre-parametrizado.
Ejemplo de llamado a la API desde PHP:
//Campos necesarios para la creación de un Comprobante
$jwt = "Token Generado con el endpoint /login",
$emision = "OCTUBRE_2020";
$tipo = "Prueba";
$idworkflow = "1";
$cuituser = "20317079028";
$emailuser = "[email protected]";
$fecha = date("Y-m-d H:i:s");
$titulo = "Documento de Prueba";
$documento = "<p>Esto es un documento de Prueba</p>"
$link = "https://sysworld.com.ar/";
$campo1 = "9876";
$campo2 = "4561";
$campo3 = "";
$campo4 = "";
$campo5 = "";
$campo6 = "";
$campo7 = "";
$campo8 = "";
$campo9 = "";
$campo10 = "";
$fechavencimiento = date("Y-m-d H:i:s", strtotime(date("Y-m-d H:i:s") . "+ 3 days");
$fechavencimiento2 = "";
$fechavencimiento3 = "";
$idestado = "0";
$moneda = "ARS";
$importe = "450.50";
$importevto2 = "0";
$importevto3 = "0";
$enviamail = "0";
$enviapush = "0";
$enviasms = "1";
$enviawhatsapp = "0";
// Se prepara un array con los campos necesarios
$campos = [
"jwt" => $jwt,
"emision" => $emision,
"tipo" => $tipo,
"idworkflow" => $idworkflow,
"cuituser" => $cuituser,
"emailuser" => $emailuser,
"fecha" => $fecha,
"titulo" => $titulo,
"documento" => $documento,
"link" => $link,
"campo1" => $campo1,
"campo2" => $campo2,
"campo3" => $campo3,
"campo4" => $campo4,
"campo5" => $campo5,
"campo6" => $campo6,
"campo7" => $campo7,
"campo8" => $campo8,
"campo9" => $campo9,
"campo10" => $campo10,
"fechavencimiento" => $fechavencimiento,
"fechavencimiento2" => $fechavencimiento2,
"fechavencimiento3" => $fechavencimiento3,
"idestado" => $idestado,
"moneda" => $moneda,
"importe" => $importe,
"importevto2" => $importevto2,
"importevto3" => $importevto3,
"enviamail" => $enviamail,
"enviapush" => $enviapush,
"enviasms" => $enviasms,
"enviawhatsapp" => $enviawhatsapp
];
// Se crea un JSON mediante el array
$json = json_encode($campos);
// Iniciamos CURL
$url = "http://cont1-test1.certisend.com/web/container/api/v1/apipagos/core/create_doc?codseg=##CodigoDeSeguridad##";
$curl = curl_init($url);
curl_setopt_array($curl, [
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => $json,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ["Content-Type: application/json"]
]);
// Se obtiene la respuesta
$response = curl_exec($curl);
Una vez llamada correctamente a la API, el sistema retornará una repuesta en JSON con las siguientes variables:
- state -> tinyint(4): Estado del procesamiento de la llamada.
- 0-Pendiente
- 1-Exitoso
- 2-Error
- message -> VARCHAR(200): Indica la descripción de la API.
- codigo -> VARCHAR(200): Se retorna ante un estado exitoso e indica el codigo generado para la transacción.
- date -> VARCHAR(100): Retorna la fecha y hora de la llamada en formato YYYY-mm-dd HH:II:SS
- id_internal -> VARCHAR(200): Se retorna ante un estado exitoso e indica el ID generado para la transacción.
Crear Usuario
Crear un Usuario le permite a la Empresa/Negocio poder generar un usuario nuevo en el sistema para que el mismo tenga acceso a todas las herramientas embebidas.
Atención
El uso de dicho servicio deberá ser coordinado con nuestro equipo de soporte para la correcta configuración del sistema.
El endpoint a utilizar es el "api/v1/apipagos/core/create_user" y dicho endpoint recibira por medio de GET la variable CodSeg y por medio del body un JSON con las siguientes variables:
- email VARCHAR(200) (Obligatorio): Indica el email principal del usuario a crear. El mismo no se puede repetir dentro de la misma empresa.
- tipopersona -> VARCHAR(5) (Obligatorio): Indica el tipo de persona: F(Física) / J(Jurídica).
- tiporelacion -> VARCHAR(50): Indica el tipo de relacion.
- codigorelacion -> VARCHAR(200): Indica el codigo de relacion.
- actividad -> VARCHAR(200): Indica la actividad.
- dni -> VARCHAR(20) (Obligatorio Personas Físicas): Documento del usuario a crear.
- cuit -> VARCHAR(20) (Obligatorio): CUIT del usuario a crear. El mismo no se puede repetir dentro de la misma empresa.
- cuitrelacion -> VARCHAR(20): Indica el cuit con el que se encuentra relacionado.
- fechanacimiento -> VARCHAR(20): Fecha de Nacimiento en caso de Personas Físicas en formato YYYY-mm-dd.
- nacionalidad -> VARCHAR(20): Indida la nacionalidad.
- estadocivil -> VARCHAR(200): Indica el estado civil en Personas Físicas.
- nombre -> VARCHAR(200) (Obligatorio Personas Físicas): Nombre de la persona física.
- apellido -> VARCHAR(200) (Obligatorio Personas Físicas): Apellido de la persona física.
- razonsocial -> VARCHAR(200) (Obligatorio Personas Jurídicas): Razon Social de la empresa.
- sexo -> VARCHAR(200) (Obligatorio Personas Físicas): M/F
- telefono -> VARCHAR(500): Teléfono de contacto.
- celular -> VARCHAR(500) (Obligatorio): Teléfono móvil de contacto para 2FA.
- ddjjpep -> TINYINT(4): Declaración Jurada Persona Expuesta Políticamente.
- ddjjso -> TINYINT(4): Declaración Jurada Sujetos Obligados.
- email2 -> VARCHAR(200): Email alternativo.
- web -> VARCHAR(500): Web o redes sociales en caso que corresponda.
- domicilio -> VARCHAR(200) (Obligatorio): Domicilio del usuario a crear.
- numero -> VARCHAR(20): numero del domicilio del usuario a crear.
- localidad -> VARCHAR(200) (Obligatorio): Localidad del usuario a crear.
- provincia -> VARCHAR(200) (Obligatorio): Provincia del usuario a crear.
- cp -> VARCHAR(200) (Obligatorio): Código Postal del usuario a crear debe ser de 8 caracteres "Letras y numeros".
- pais -> VARCHAR(200) (Obligatorio): País del usuario a crear.
- fotodnifrente -> TEXT: Foto del frente del DNI para Personas Físicas en png/base64.
- fotodnidorso -> TEXT: Foto del dorso del DNI para Personas Físicas en png/base64.
- foto1 -> TEXT: Foto del selfie1 para Personas Físicas en png/base64.
- foto2 -> TEXT: Foto del selfie2 para Personas Físicas en png/base64.
- foto3 -> TEXT: Foto documento respaldatorio para Personas Físicas y Jurídicas en png/base64.
- foto4 -> TEXT: Foto documento respaldatorio para Personas Físicas y Jurídicas en png/base64.
- campo1 -> VARCHAR(200): Campo de relación del negocio.
- campo2 -> VARCHAR(200): Campo de relación del negocio.
- campo3 -> VARCHAR(200): Campo de relación del negocio.
- campo4 -> VARCHAR(200): Campo de relación del negocio.
- campo5 -> VARCHAR(200): Campo de relación del negocio.
- campo6 -> VARCHAR(200): Campo de relación del negocio.
- campo7 -> VARCHAR(200): Campo de relación del negocio.
- campo8 -> VARCHAR(200): Campo de relación del negocio.
- campo9 -> VARCHAR(200): Campo de relación del negocio.
- campo10 -> VARCHAR(200): Campo de relación del negocio.
- createwallet -> VARCHAR(100) (Obligatorio): true/false. Indica si se le crea un wallet y correspondiente cvu al usuario.
- compliancepep -> TINYINT(4): Indica si el usuarui esta marcado en el analisis previamente como PEP.
- complianceso -> TINYINT(4): Indica si el usuarui esta marcado en el analisis previamente como sujeto obligado.
- complianceso_opciones -> VARCHAR(400): Que tipo de sujeto obligado es ej: Despachante de aduana, escribano publico, etc...
- compliancepep_persona -> VARCHAR(400): Quien es la persona politicamente expuesta ej: yo, madre, padre, etc...
- pep_cargo -> VARCHAR(400): Cargo que ocupa como persona politicamente expuesta.
- pep_fecha_inicio -> VARCHAR(400): Fecha en que inicio su cargo como persona politicamente expuesta.
- pep_fecha_finalizado -> VARCHAR(400): Fecha en que finalizo su cargo como persona politicamente expuesta.
- compliancetiponomina -> VARCHAR(10): Indica la nomina del usuario para persona juridica.
- afipactividad -> VARCHAR(400): Indica la actividad principal de afip. Consumir de tablas generales.
- uniqueuser -> VARCHAR(400): true/false. Indica si es un unico usuario.
//Campos necesarios para la creación de un Comprobante
$jwt = "Token Generado con el endpoint /login",
$email = "[email protected]";
$tipopersona = "F";
$tiporelacion = "";
$codigorelacion = "";
$acitvidad = "";
$dni = "30763840";
$cuit = "20307638404";
$fechanacimiento = "26/04/1984";
$nacionalidad = "";
$nombre = "Juan Manuel";
$apellido = "Fernandez";
$razonsocial = "";
$sexo = "M";
$telefono = "1152645487";
$celular = "1150028422";
$ddjjpep = "";
$ddjjso = "";
$email2 = "[email protected]";
$web = "";
$domicilio = "San Martin 212";
$localidad = "San Martin";
$provincia = "Buenos Aires";
$cp = "CP1548AC";
$pais = "AR";
$fotodnifrente = "";
$fotodnidorso = "";
$foto1 = "";
$foto2 = "";
$foto3 = "";
$foto4 = "";
$campo1 = "";
$campo2 = "";
$campo3 = "";
$campo4 = "";
$campo5 = "";
$campo6 = "";
$campo7 = "";
$campo8 = "";
$campo9 = "";
$campo10 = "";
$createwallet = "false";
$uniqueuser = "false";
// Se prepara un array con los campos necesarios
$campos = [
"jwt" => $jwt,
"email" => $email,
"tipopersona" => $tipopersona,
"tiporelacion" => $tiporelacion,
"codigorelacion" => $codigorelacion,
"acitvidad" => $acitvidad,
"dni" => $dni,
"cuit" => $cuit,
"fechanacimiento" => $fechanacimiento,
"nacionalidad" => $nacionalidad,
"nombre" => $nombre,
"apellido" => $apellido,
"razonsocial" => $razonsocial,
"sexo" => $sexo,
"telefono" => $telefono,
"celular" => $celular,
"ddjjpep" => $ddjjpep,
"ddjjso" => $ddjjso,
"email2" => $email2,
"web" => $web,
"domicilio" => $domicilio,
"localidad" => $localidad,
"provincia" => $provincia,
"cp" => $cp,
"pais" => $pais,
"fotodnifrente" => $fotodnifrente,
"fotodnidorso" => $fotodnidorso,
"foto1" => $foto1,
"foto2" => $foto2,
"foto3" => $foto3,
"foto4" => $foto4,
"campo1" => $campo1,
"campo2" => $campo2,
"campo3" => $campo3,
"campo4" => $campo4,
"campo5" => $campo5,
"campo6" => $campo6,
"campo7" => $campo7,
"campo8" => $campo8,
"campo9" => $campo9,
"campo10" => $campo10,
"uniqueuser" => $uniqueuser
];
// Se crea un JSON mediante el array
$json = json_encode($campos);
// Iniciamos CURL
$url = "http://cont1-test1.certisend.com/web/container/api/v1/apipagos/core/create_user?codseg=##CodigoDeSeguridad##";
$curl = curl_init($url);
curl_setopt_array($curl, [
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => $json,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ["Content-Type: application/json"]
]);
// Se obtiene la respuesta
$response = curl_exec($curl);
Una vez llamada correctamente a la API, el sistema retornará una repuesta en JSON con las siguientes variables:
- state -> tinyint(4): Estado del procesamiento de la llamada.
- 1-Exitoso
- 2-Error
- 3-Fallo en validaciones de CUIT y/o Fotos de DNI (En caso de ser enviadas).
- message -> VARCHAR(200): Indica la descripción de la API.
- codigo -> VARCHAR(200): Se retorna ante un estado exitoso e indica el codigo generado para el usuario.
- idestadovalidacion -> Indica el estado de la validación del usuario.
- 0-Creado
- 1-Validado/Activo
- 10-Esperando Validación Identidad
- 11-Error Validación de identidad.
- 2-Pausado
- 3-Anulado
- date -> VARCHAR(100): Retorna la fecha y hora de la llamada en formato YYYY-mm-dd HH:II:SS
- iduser -> VARCHAR(200): Se retorna ante un estado exitoso e indica el ID generado para la transacción.
Crear Transacción
Crear una Transacción le permite a la Empresa/Negocio poder generar una Transacción de Pago / Reintegro independientemente de la interacción del cliente final.
Atención
El uso de dicho servicio deberá ser coordinado con nuestro equipo de soporte para la correcta configuración del sistema.
El endpoint a utilizar es el "api/v1/apipagos/core/create_tx" y dicho endpoint recibira por medio de GET la variable CodSeg y por medio del body un JSON con las siguientes variables:
- codigobilletera -> VARCHAR(50) (Obligatorio): Código de la billetera donde se generará la transacción al cliente (Consultar con Soporte).
- idgateway -> INT(6): Id del gateway donde se requiere realizar la transaccion. Dicho id del gateway se validará que pertenezca a la empresa logueada en la API.
- tipogateway -> VARCHAR(10) NULL,
- tipotx -> VARCHAR(50) (Obligatorio): Tipo de transacción a Generar.
- ON-On Line
- PG-Programada
- SC-Suscripcion
- SO-Solicitud_Dinero
- EN-Envio_Dinero
- TW-Transferencia_Wallet
- RE-Reintegro
- idestado -> tinyint(4) (Obligatorio): Estado inicial de la transaccion a generar.
- 0-Pendiente
- 1-Confirmada
- 10-Rechazada
- 11-Contracargo
- 20-Abandonada
- 99-Temporal
- fechaprogramada -> DATETIME: Fecha programada para ejecutar la transacción en formato YYYY-mm-dd.
- fechavto1 -> DATETIME: Fecha de Vencimiento de la deuda en formato YYYY-mm-dd.
- titulo -> VARCHAR(100) (Obligatorio): Título de la transacción a mostrarle al cliente.
- concepto -> VARCHAR(250): Concepto detalle de la transacción a mostrarle al cliente.
- moneda -> VARCHAR(50) (Obligatorio): Moneda de la publicación de la deuda según ISO 4217 Monedas Internacionales.
- signoimporte -> VARCHAR(2): Signo del importe para la cuenta corriente del cliente +/-.
- importe -> DECIMAL(20,4) (Obligatorio): Importe de la transacción.
- emailuserorigen -> VARCHAR(200) (Obligatorio): Permite identificar el Email del cliente de la transacción.
- tipodocorigen -> VARCHAR(5) (Obligatorio): Permite seleccionar el tipo de documento del cliente de la transacción.
- CUIL
- CUIT
- DNI
- nrodocorigen -> VARCHAR(20) (Obligatorio): Permite identificar el Nro Documento del cliente de la transacción.
- emailuserdestino -> VARCHAR(200): Permite identificar el Email del usuario de destino de la transacción.
- tipodocdestino -> VARCHAR(5): Permite seleccionar el tipo de documento del usuario de destino de la transacción.
- CUIL
- CUIT
- DNI
- nrodocdestino -> VARCHAR(20): Permite identificar el Nro Documento del usuario de destino de la transacción.
- referencia1 -> VARCHAR(200): Campo para datos de referencia de la Empresa/Negocio.
- referencia2 -> VARCHAR(200): Campo para datos de referencia de la Empresa/Negocio.
- cbte -> VARCHAR(1000): Código de Endpoint de publicación de deuda en caso que se desee referenciar la transacción con una publicación de deuda.
- typecbte -> VARCHAR(50): Refiere al tipo de comprobante configurado en CuentaVirtual. Dicho tipo de comprobante brindara la forma de tratamiento de dicha publicación y los métodos de pago habilitados.
- portal -> VARCHAR(50): Código del portal (Al que ingresa el usuario a realizar el pago de la transacción).
- aperturatx -> OBJETO ARRAY: Permite indicar una apertura de una transacción.
- importe -> DECIMAL(20,4) (Obligatorio): Importe del item (la sumatoria de los importes de los items debe ser igual al importe de la transacción).
- emailuserdestino -> VARCHAR(200): Permite identificar el Email del usuario de destino del item.
- tipodocdestino -> VARCHAR(5): Permite seleccionar el tipo de documento del usuario del item.
- CUIL
- CUIT
- DNI
- nrodocdestino -> VARCHAR(20): Permite identificar el Nro Documento del usuario de destino del item.
//Campos necesarios para la creación de un Comprobante
$jwt = "Token Generado con el endpoint /login",
$codigobilletera = "ARS";
$idgateway = "1";
$tipogateway = "DB";
$tipotx = "ON";
$idestado = "0";
$fechaprogramada = date("Y-m-d H:i:s");
$fechavto1 = date("Y-m-d H:i:s", strtotime(date("Y-m-d H:i:s") . "+ 3 days");
$titulo = "Prueba Transacción"
$concepto = "Esta es una transacción de Prueba";
$moneda = "ARS";
$signoimporte = "-";
$importe = "961.35";
$emailuserorigen = "[email protected]"
$tipodocorigen = "CUIT";
$nrodocorigen = "20317079028";
$emailuserdestino = "[email protected]";
$tipodocdestino = "CUIT";
$nrodocdestino = "27351245872";
$referencia1 = "";
$referencia2 = "";
$cbte = "";
$typecbte = ""
// Se prepara un array con los campos necesarios
$campos = [
"jwt" => $jwt,
"codigobilletera" => $codigobilletera,
"idgateway" => $idgateway,
"tipogateway" => $tipogateway,
"tipotx" => $tipotx,
"idestado" => $idestado,
"fechaprogramada" => $fechaprogramada,
"fechavto1" => $fechavto1,
"titulo" => $titulo,
"concepto" => $concepto,
"moneda" => $moneda,
"signoimporte" => $signoimporte,
"importe" => $importe,
"emailuserorigen" => $emailuserorigen,
"tipodocorigen" => $tipodocorigen,
"nrodocorigen" => $nrodocorigen,
"emailuserdestino" => $emailuserdestino,
"tipodocdestino" => $tipodocdestino,
"nrodocdestino" => $nrodocdestino,
"referencia1" => $referencia1,
"referencia2" => $referencia2,
"cbte" => $cbte,
"typecbte" => $typecbte
];
// Se crea un JSON mediante el array
$json = json_encode($campos);
// Iniciamos CURL
$url = "http://cont1-test1.certisend.com/web/container/api/v1/apipagos/core/create_tx?codseg=##CodigoDeSeguridad##";
$curl = curl_init($url);
curl_setopt_array($curl, [
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => $json,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ["Content-Type: application/json"]
]);
// Se obtiene la respuesta
$response = curl_exec($curl);
Una vez llamada correctamente a la API, el sistema retornará una repuesta en JSON con las siguientes variables:
- state -> tinyint(4): Estado del procesamiento de la llamada.
- 0-Pendiente
- 1-Exitoso
- 2-Error
- message -> VARCHAR(200): Indica la descripción de la API.
- codigo -> VARCHAR(200): Se retorna ante un estado exitoso e indica el codigo generado para la transacción.
- date -> VARCHAR(100): Retorna la fecha y hora de la llamada en formato YYYY-mm-dd HH:II:SS
- id_internal -> VARCHAR(200): Se retorna ante un estado exitoso e indica el ID generado para la transacción.
- linktx -> VARCHAR(200): En caso de enviar un código de portal, se genera el link hacia el mismo para realizar el pago.
Crear Reintegro
Crear un Reintegro le permite a la Empresa/Negocio poder generar una Transacción de Reintegro independientemente de la interacción del cliente final.
El endpoint a utilizar es el "api/v1/apipagos/core/create_reintegro" y dicho endpoint recibirá por medio de GET la variable CodSeg y por medio del body un JSON con las siguientes variables:
- typereintegro -> VARCHAR(50): Indica el tipo de Reintegro.
- lote -> VARCHAR(200) (Obligatorio): Refiere al tipo de comprobante configurado en CuentaVirtual. Dicho tipo de comprobante brindara la forma de tratamiento de dicha publicación y los métodos de pago habilitados.
- idgateway -> INT(6) (Obligatorio): El gateway a utilizar en la transacción.
- tipogateway -> VARCHAR(10): Tipo de gateway a utilizar en la transacción.
- tipotx -> VARCHAR(50): Indica el tipo de transacción.
- ON - Online
- PG - Programada
- SC - Suscripción
- SO - Solicitud de Dinero
- EN - Envío de Dinero
- TW - Transferencia desde Wallet
- token -> VARCHAR(1000): Campo extra para identificar la operación.
- importe1 -> DECIMAL(10,4) (Obligatorio): Importe del Reintegro.
- importe2 -> DECIMAL(10,4): Otro Importe del Reintegro.
- importe3 -> DECIMAL(10,4): Otro Importe del Reintegro.
- idestado -> TINYINT(4) (Obligatorio): Estado por defecto de la publicación de deuda.
- 0 - Pendiente
- 1 - Confirmado
- 2 - Pendiente CBU
- 3 - Reintegrado
- 4 - Cancelado
- 5 - Rechazado
- 6 - Error en el Pago
- diareintegro -> INT(6): Indica sí el cobro del reintegro está programado.
- fechaprogramada -> DATETIME: Fecha programada del reintegro.
- emailuserorigen -> VARCHAR(200): Permite identificar el Email del cliente que debe acceder a dicho reintegro.
- tipodocorigen -> VARCHAR(5): Permite identificar el Tipo de Documento del cliente que debe acceder a dicho reintegro.
- CUIL
- CUIT
- DNI
- nrodocorigen -> VARCHAR(200): Permite identificar el Número de Documento del cliente que debe acceder a dicho reintegro.
- titular -> VARCHAR(500): Indica el nombre y apellido de la persona a ejecutar la suscripción.
- referencia1 -> VARCHAR(1000): Referencia
- referencia2 -> VARCHAR(1000): Referencia
- campo1 -> VARCHAR(200): Campo Adicional 1 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo2 -> VARCHAR(200): Campo Adicional 2 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo3 -> VARCHAR(200): Campo Adicional 3 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo4 -> VARCHAR(200): Campo Adicional 4 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo5 -> VARCHAR(200): Campo Adicional 5 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo6 -> VARCHAR(200): Campo Adicional 6 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo7 -> VARCHAR(200): Campo Adicional 7 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo8 -> VARCHAR(200): Campo Adicional 8 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo9 -> VARCHAR(200): Campo Adicional 9 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo10 -> VARCHAR(200): Campo Adicional 10 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- codigotx -> VARCHAR(200): Codigo de la transacción por la cual se realiza el reintegro.
- idproceso -> INT(6) (Obligatorio): ID Proceso.
- codrelacion -> VARCHAR(250): Código Relación.
- iptx -> VARCHAR(100): IP desde la que se realiza la operación..
- dispositivo -> VARCHAR(4000): Dispositivo desde el que se realiza la operación.
Ejemplo de llamado a la API desde PHP:
//Campos necesarios para la creación de un Comprobante
$jwt = "Token Generado con el endpoint /login",
$typereintegro = "Prueba_Reintegro";
$lote = "20102020";
$idgateway = "3";
$tipotx = "ON";
$importe1 = "3550.5";
$importe2 = "0";
$idestado = "0";
$emailuserorigen = "[email protected]";
$tipodocorigen = "CUIT"
$nrodocorigen = "20317079028";
$referencia1 = "20/10/2020"
$campo1 = "9876";
$campo2 = "4561";
$codigotx = "d8a4s51d6s4af1a32s4f";
$idproceso = "0";
// Se prepara un array con los campos necesarios
$campos = [
"jwt" => $jwt,
"typereintegro" => $typereintegro,
"lote" => $lote,
"idgateway" => $idgateway,
"tipotx" => $tipotx,
"importe1" => $importe1,
"importe2" => $importe2,
"idestado" => $idestado,
"emailuserorigen" => $emailuserorigen,
"tipodocorigen" => $tipodocorigen,
"nrodocorigen" => $nrodocorigen,
"referencia1" => $referencia1,
"campo1" => $campo1,
"campo2" => $campo2,
"codigotx" => $codigotx,
"idproceso" => $idproceso
];
// Se crea un JSON mediante el array
$json = json_encode($campos);
// Iniciamos CURL
$url = "http://cont1-test1.certisend.com/web/container/api/v1/apipagos/core/create_reintegro?codseg=##CodigoDeSeguridad##";
$curl = curl_init($url);
curl_setopt_array($curl, [
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => $json,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ["Content-Type: application/json"]
]);
// Se obtiene la respuesta
$response = curl_exec($curl);
Una vez llamada correctamente a la API, el sistema retornará una repuesta en JSON con las siguientes variables:
- state -> tinyint(4): Estado del procesamiento de la llamada.
- 0-Pendiente
- 1-Exitoso
- 2-Error
- message -> VARCHAR(200): Indica la descripción de la API.
- codigo -> VARCHAR(200): Se retorna ante un estado exitoso e indica el codigo generado para la transacción.
- date -> VARCHAR(100): Retorna la fecha y hora de la llamada en formato YYYY-mm-dd HH:II:SS
- id_internal -> VARCHAR(200): Se retorna ante un estado exitoso e indica el ID generado para la transacción.
Crear Suscripción
Crear una suscripción le permite a la Empresa/Negocio poder generar una Transacción de Suscripción de Pago para un cliente final.
El endpoint a utilizar es el "api/v1/apipagos/core/create_susc" y dicho endpoint recibirá por medio de GET la variable CodSeg y por medio del body un JSON con las siguientes variables:
- idgateway -> INT(6): El gateway a utilizar en la transacción.
- tipotx -> VARCHAR(50): Indica el tipo de transacción.
- ON - Online
- PG - Programada
- SC - Suscripción
- SO - Solicitud de Dinero
- EN - Envío de Dinero
- TW - Transferencia desde Wallet
- token VARCHAR(1000): Indica el token del valor generado para procesar la transacción. Cifrado mediante el método AES-256-CBC, utilizando como clave el apitoken de la empresa. Ej: CBU/Tarjeta
- titular -> VARCHAR(200): Indica el nombre y apellido de la persona a ejecutar la suscripción.
- idestado tinyint(4)
- 0-Pendiente Aprobacion
- 1-Activo
- 2-Cancelado
- 3-Baja Automática
- diadebito -> INT(2): Permite identificar el dìa del mes para ejecutar la suscripción en caso que corresponda un débito.
- emailuserorigen -> VARCHAR(200): Email del usuario que se esta suscribiendo.
- tipodocorigen -> VARCHAR(5): Permite identificar el Tipo de Documento del cliente que debe acceder a dicho reintegro.
- CUIL
- CUIT
- DNI
- nrodocorigen -> VARCHAR(200): Permite identificar el Número de Documento del cliente que debe acceder a dicho reintegro.
- nrodocorigen -> VARCHAR(20) (Obligatorio): Permite identificar el Nro Documento del cliente de la transacción.
- emailuserdestino -> VARCHAR(200): Permite identificar el Email del usuario de destino de la transacción.
- tipodocdestino -> VARCHAR(5): Permite seleccionar el tipo de documento del usuario de destino de la transacción.
- CUIL
- CUIT
- DNI
- nrodocdestino -> VARCHAR(20): Permite identificar el Nro Documento del usuario de destino de la transacción.
- referencia1 -> VARCHAR(200): Referencia
- referencia2 -> VARCHAR(200): Referencia
- campo1 -> VARCHAR(200): Campo Adicional 1 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo2 -> VARCHAR(200): Campo Adicional 2 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo3 -> VARCHAR(200): Campo Adicional 3 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo4 -> VARCHAR(200): Campo Adicional 4 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo5 -> VARCHAR(200): Campo Adicional 5 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo6 -> VARCHAR(200): Campo Adicional 6 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo7 -> VARCHAR(200): Campo Adicional 7 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo8 -> VARCHAR(200): Campo Adicional 8 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo9 -> VARCHAR(200): Campo Adicional 9 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo10 -> VARCHAR(200): Campo Adicional 10 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- typecbte -> VARCHAR(50): Refiere al tipo de comprobante configurado en CuentaVirtual. Dicho tipo de comprobante brindara la forma de tratamiento de dicha publicación y los métodos de pago habilitados.
- gestionabajas -> true/false: Indica si utiliza los campos claves de nrodocorigen, referencias, y campos adicionales para ubicar suscripciones anteriores y marcarlas como bajas.
Ejemplo de llamado a la API desde PHP:
//Campos necesarios para la creación de un Comprobante
$jwt = "Token Generado con el endpoint /login",
$idgateway = "3";
$tipotx = "ON";
$token = openssl_encrypt(##NumeroDeTarjeta##, "AES-256-CBC", ##ApiTokenDeEmpresa##);
$idestado = "1";
$emailuserorigen = "[email protected]";
$tipodocorigen = "CUIT"
$nrodocorigen = "20317079028";
$referencia1 = "20/10/2020"
$referencia2 = "Debito Automatico Cuota"
$campo1 = "111"
$campo2 = "2222/23"
$typecbte = "suscripcionweb"
// Se prepara un array con los campos necesarios
$campos = [
"jwt" => $jwt,
"idgateway" => $idgateway,
"tipotx" => $tipotx,
"token" => $token,
"idestado" => $idestado,
"emailuserorigen" => $emailuserorigen,
"tipodocorigen" => $tipodocorigen,
"nrodocorigen" => $nrodocorigen,
"referencia1" => $referencia1,
"referencia2" => $referencia2,
"campo1" => $campo1,
"campo2" => $campo2,
"typecbte" => $typecbte
];
// Se crea un JSON mediante el array
$json = json_encode($campos);
// Iniciamos CURL
$url = "http://cont1-test1.certisend.com/web/container/api/v1/apipagos/core/create_susc?codseg=##CodigoDeSeguridad##";
$curl = curl_init($url);
curl_setopt_array($curl, [
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => $json,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ["Content-Type: application/json"]
]);
// Se obtiene la respuesta
$response = curl_exec($curl);
Una vez llamada correctamente a la API, el sistema retornará una repuesta en JSON con las siguientes variables:
- state -> tinyint(4): Estado del procesamiento de la llamada.
- 0-Pendiente
- 1-Exitoso
- 2-Error
- message -> VARCHAR(200): Indica la descripción de la API.
- codigo -> VARCHAR(200): Se retorna ante un estado exitoso e indica el codigo generado para la transacción.
- data_encrypted -> VARCHAR(1000): Se retorna el token encriptado por el módulo ApiTokens.
- data_visible -> VARCHAR(200): Se retorna el token con información segura visible para ser mostrada.
- date -> VARCHAR(100): Retorna la fecha y hora de la llamada en formato YYYY-mm-dd HH:II:SS
- id_internal -> VARCHAR(200): Se retorna ante un estado exitoso e indica el ID generado para la transacción.
Consultar Usuario
La API de Consulta de Usuario le permite a la Empresa/Comercio realizar la consulta del estado de un usuario, su información básica y su saldo en cuenta:
El endpoint a utilizar es el "api/v1/apipagos/core/get_user" y dicho endpoint recibira por medio de GET las variables "t" que se corresponde al token JWT generado con el endpoint de login y "codigo" el cual pertenece al código de referencia del usuario a consultar. A continuación, se detalla las variables que retornará el sistema en un formato JSON:
- email VARCHAR(200) (Obligatorio): Indica el email principal del usuario a crear. El mismo no se puede repetir dentro de la misma empresa.
- tipopersona -> VARCHAR(5) (Obligatorio): Indica el tipo de persona: F(Física) / J(Jurídica).
- dni -> VARCHAR(20) (Obligatorio Personas Físicas): Documento del usuario a crear.
- cuit -> VARCHAR(20) (Obligatorio): CUIT del usuario a crear. El mismo no se puede repetir dentro de la misma empresa.
- fechanacimiento -> VARCHAR(20): Fecha de Nacimiento en caso de Personas Físicas en formato YYYY-mm-dd.
- nombre -> VARCHAR(200) (Obligatorio Personas Físicas): Nombre de la persona física.
- apellido -> VARCHAR(200) (Obligatorio Personas Físicas): Apellido de la persona física.
- razonsocial -> VARCHAR(200) (Obligatorio Personas Jurídicas): Razon Social de la empresa.
- sexo -> VARCHAR(200) (Obligatorio Personas Físicas): M/F
- telefono -> VARCHAR(500): Teléfono de contacto.
- celular -> VARCHAR(500) (Obligatorio): Teléfono móvil de contacto para 2FA.
- email2 -> VARCHAR(200): Email alternativo.
- web -> VARCHAR(500): Web o redes sociales en caso que corresponda.
- domicilio -> VARCHAR(200) (Obligatorio): Domicilio del usuario a crear.
- localidad -> VARCHAR(200) (Obligatorio): Localidad del usuario a crear.
- provincia -> VARCHAR(200) (Obligatorio): Provincia del usuario a crear.
- cp -> VARCHAR(200) (Obligatorio): Código Postal del usuario a crear.
- pais -> VARCHAR(200) (Obligatorio): País del usuario a crear.
- fotodnifrente -> TEXT: Foto del frente del DNI para Personas Físicas en png/base64.
- fotodnidorso -> TEXT: Foto del dorso del DNI para Personas Físicas en png/base64.
- foto1 -> TEXT -> TEXT: Foto del selfie1 para Personas Físicas en png/base64.
- foto2 -> TEXT -> TEXT: Foto del selfie2 para Personas Físicas en png/base64.
- foto3 -> TEXT -> TEXT: Foto documento respaldatorio para Personas Físicas y Jurídicas en png/base64.
- foto4 -> TEXT -> TEXT: Foto documento respaldatorio para Personas Físicas y Jurídicas en png/base64.
- campo1 -> VARCHAR(200): Campo de relación del negocio.
- campo2 -> VARCHAR(200): Campo de relación del negocio.
- campo3 -> VARCHAR(200): Campo de relación del negocio.
- campo4 -> VARCHAR(200): Campo de relación del negocio.
- campo5 -> VARCHAR(200): Campo de relación del negocio.
- campo6 -> VARCHAR(200): Campo de relación del negocio.
- campo7 -> VARCHAR(200): Campo de relación del negocio.
- campo8 -> VARCHAR(200): Campo de relación del negocio.
- campo9 -> VARCHAR(200): Campo de relación del negocio.
- campo10 -> VARCHAR(200): Campo de relación del negocio.
- compliancepep -> TINYINT(4): Indica si el usuarui esta marcado en el analisis previamente como PEP.
- complianceso -> TINYINT(4): Indica si el usuarui esta marcado en el analisis previamente como sujeto obligado.
- compliancetiponomina -> VARCHAR(10): Indica la nomina del usuario para persona juridica.
- afipactividad -> VARCHAR(400): Indica la actividad principal de afip. Consumir de tablas generales.
- idestado -> tinyint(4): Estado por defecto de la publicación de deuda.
- 0-Creado
- 1-Validado/Activo
- 10-Esperando Validación Identidad
- 11-Error Validación de identidad
- 2-Pausado
- 3-Anulado
- wallets -> object: array con las billeteras creadas para el usuario.
- codigobilletera
- cvu
- cvualias
- cbu
- cbualias
- saldo
- saldopendiente
- bloqueo
- 0-Sin_Bloqueo
- 1-Bloqueo_Temporal
- 2-Bloqueo_Permanente
Crear Trámite TED
Crear un TED le permite a la Empresa/Negocio enlazar un trámite el cual puede ser consultado.
El endpoint a utilizar es el "api/v1/apipagos/core/create_ted_tx" y dicho endpoint recibirá por medio de GET la variable CodSeg y por medio del body un JSON con las siguientes variables:
- idportal -> INT(4): (Obligatorio) ID del portal a utilizar.
- idtramite -> INT(4): (Obligatorio) ID del trámite a enlazar.
- iddepartamento INT(4): (Obligatorio) ID del departamento al que pertenece al trámite.
- idproducto -> INT(4): (Obligatorio) ID del producto al que pertenece el trámite.
- iduserorigen INT(4): ID del usuario que inició el trámite.
- emailuserorigen -> VARCHAR(200): Email del usuario.
- tipodocorigen -> VARCHAR(200): Tipo de documento del usuario (CUIT).
- nrodocorigen -> VARCHAR(200): Documento del usuario.
- idestado -> INT(4): (Obligatorio) Estado del trámite.
- idestadoworkflow -> INT(4): ID del workflow utilizado.
- campo1 -> VARCHAR(100): Campo Adicional 1 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo2 -> VARCHAR(100): Campo Adicional 2 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo3 -> VARCHAR(100): Campo Adicional 3 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo4 -> VARCHAR(100): Campo Adicional 4 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo5 -> VARCHAR(100): Campo Adicional 5 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo6 -> VARCHAR(100): Campo Adicional 6 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo7 -> VARCHAR(100): Campo Adicional 7 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo8 -> VARCHAR(100): Campo Adicional 8 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo9 -> VARCHAR(100): Campo Adicional 9 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo10 -> VARCHAR(100): Campo Adicional 10 Personalizado para la Empresa/Negocio (Consultar a Soporte).
Ejemplo de llamado a la API desde PHP:
//Campos necesarios para la creación de un Comprobante
$jwt = "Token Generado con el endpoint /login",
$idportal = '3';
$idtramite = '1201';
$iddepartamento = '4';
$idproducto = '10';
$iduserorigen = '3102';
$emailuserorigen = '[email protected]';
$tipodocorigen = 'CUIT'
$nrodocorigen = '20317079028';
$idestado = '0';
$idestadoworkflow = '0';
// Se prepara un array con los campos necesarios
$campos = [
"jwt" => $jwt,
"idportal" => $idportal,
"idtramite" => $idtramite,
"iddepartamento" => $iddepartamento,
"idproducto" => $idproducto,
"iduserorigen" => $iduserorigen,
"emailuserorigen" => $emailuserorigen,
"tipodocorigen" => $tipodocorigen,
"nrodocorigen" => $nrodocorigen,
"idestado" => $idestado,
"idestadoworkflow" => $idestadoworkflow
];
// Se crea un JSON mediante el array
$json = json_encode($campos);
// Iniciamos CURL
$url = "http://cont1-test1.certisend.com/web/container/api/v1/apipagos/core/create_ted_tx?codseg=##CodigoDeSeguridad##";
$curl = curl_init($url);
curl_setopt_array($curl, [
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => $json,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ["Content-Type: application/json"]
]);
// Se obtiene la respuesta
$response = curl_exec($curl);
Una vez llamada correctamente a la API, el sistema retornará una repuesta en JSON con las siguientes variables:
- state -> tinyint(4): Estado del procesamiento de la llamada.
- 1-Exitoso
- 2-Error
- message -> VARCHAR(200): Indica la descripción de la API.
- codigo -> VARCHAR(200): Se retorna ante un estado exitoso e indica el codigo generado para la transacción.
- date -> VARCHAR(100): Retorna la fecha y hora de la llamada en formato YYYY-mm-dd HH:II:SS
- id_internal -> VARCHAR(200): Se retorna ante un estado exitoso e indica el ID generado para la transacción.
- linktx -> VARCHAR(200): Link que redirecciona al portal.
Consultar Usuario
La API de Consulta de Usuario le permite a la Empresa/Comercio realizar la consulta del estado de un usuario, su información básica y su saldo en cuenta:
El endpoint a utilizar es el "api/v1/apipagos/core/get_user" y dicho endpoint recibira por medio de GET la variable codigo la cual pertenece al código de referencia del usuario a consultar. A continuación, se detalla las variables que retornará el sistema en un formato JSON:
- email VARCHAR(200) (Obligatorio): Indica el email principal del usuario a crear. El mismo no se puede repetir dentro de la misma empresa.
- tipopersona -> VARCHAR(5) (Obligatorio): Indica el tipo de persona: F(Física) / J(Jurídica).
- dni -> VARCHAR(20) (Obligatorio Personas Físicas): Documento del usuario a crear.
- cuit -> VARCHAR(20) (Obligatorio): CUIT del usuario a crear. El mismo no se puede repetir dentro de la misma empresa.
- fechanacimiento -> VARCHAR(20): Fecha de Nacimiento en caso de Personas Físicas en formato YYYY-mm-dd.
- nombre -> VARCHAR(200) (Obligatorio Personas Físicas): Nombre de la persona física.
- apellido -> VARCHAR(200) (Obligatorio Personas Físicas): Apellido de la persona física.
- razonsocial -> VARCHAR(200) (Obligatorio Personas Jurídicas): Razon Social de la empresa.
- sexo -> VARCHAR(200) (Obligatorio Personas Físicas): M/F
- telefono -> VARCHAR(500): Teléfono de contacto.
- celular -> VARCHAR(500) (Obligatorio): Teléfono móvil de contacto para 2FA.
- email2 -> VARCHAR(200): Email alternativo.
- web -> VARCHAR(500): Web o redes sociales en caso que corresponda.
- domicilio -> VARCHAR(200) (Obligatorio): Domicilio del usuario a crear.
- localidad -> VARCHAR(200) (Obligatorio): Localidad del usuario a crear.
- provincia -> VARCHAR(200) (Obligatorio): Provincia del usuario a crear.
- cp -> VARCHAR(200) (Obligatorio): Código Postal del usuario a crear.
- pais -> VARCHAR(200) (Obligatorio): País del usuario a crear.
- fotodnifrente -> TEXT: Foto del frente del DNI para Personas Físicas en png/base64.
- fotodnidorso -> TEXT: Foto del dorso del DNI para Personas Físicas en png/base64.
- foto1 -> TEXT -> TEXT: Foto del selfie1 para Personas Físicas en png/base64.
- foto2 -> TEXT -> TEXT: Foto del selfie2 para Personas Físicas en png/base64.
- foto3 -> TEXT -> TEXT: Foto documento respaldatorio para Personas Físicas y Jurídicas en png/base64.
- foto4 -> TEXT -> TEXT: Foto documento respaldatorio para Personas Físicas y Jurídicas en png/base64.
- campo1 -> VARCHAR(200): Campo de relación del negocio.
- campo2 -> VARCHAR(200): Campo de relación del negocio.
- campo3 -> VARCHAR(200): Campo de relación del negocio.
- campo4 -> VARCHAR(200): Campo de relación del negocio.
- campo5 -> VARCHAR(200): Campo de relación del negocio.
- campo6 -> VARCHAR(200): Campo de relación del negocio.
- campo7 -> VARCHAR(200): Campo de relación del negocio.
- campo8 -> VARCHAR(200): Campo de relación del negocio.
- campo9 -> VARCHAR(200): Campo de relación del negocio.
- campo10 -> VARCHAR(200): Campo de relación del negocio.
- idestado -> tinyint(4): Estado por defecto de la publicación de deuda.
- 0-Creado
- 1-Validado/Activo
- 10-Esperando Validación Identidad
- 11-Error Validación de identidad
- 2-Pausado
- 3-Anulado
- wallets -> object: array con las billeteras creadas para el usuario.
- codigobilletera
- cvu
- cvualias
- cbu
- cbualias
- saldo
- saldopendiente
- bloqueo
- 0-Sin_Bloqueo
- 1-Bloqueo_Temporal
- 2-Bloqueo_Permanente
Consultar Deuda/Comprobante
La API de Consulta de Deuda/Comprobante permite a la Empresa/Comercio realizar la consulta el estado de un comprobante en especial.:
El endpoint a utilizar es el "api/v1/apipagos/core/get_doc" y dicho endpoint recibira por medio de GET las variables "t", que corresponde al token JWT generado con la API de login y codigo, la cual pertenece al código de referencia del comprobante/deuda a consultar. A continuación, se detalla las variables que retornará el sistema en un formato JSON:
- codigo -> VARCHAR(100): Indica el código del comprobante.
- codigotx -> VARCHAR(100): Indica el código de la transacción generada para el pago del comprobante.
- emision -> VARCHAR(100): Indica una referencia de la emisión del comprobante para ser mostrada al cliente.
- emision -> VARCHAR(100): Indica una referencia de la emisión del comprobante para ser mostrada al cliente.
- tipo -> VARCHAR(50): Refiere al tipo de comprobante configurado en CuentaVirtual. Dicho tipo de comprobante brindara la forma de tratamiento de dicha publicación y los métodos de pago habilitados.
- idworkflow -> INT(6): Indica el id del workflow relacionado.
- cuituser -> VARCHAR(20): Permite identificar el CUIT del cliente que debe acceder a dicho comprobante.
- emailuser -> VARCHAR(200): Permite identificar el Email del cliente que debe acceder a dicho comprobante.
- fecha -> DATETIME: Fecha de la publicación de la deuda en formato YYYY-mm-dd.
- titulo -> VARCHAR(100): Título de la Deuda.
- documento -> TEXT: Detalle o descripcion del comprobante en formato HTML.
- link -> VARCHAR(1000): Link / URL del comprobante de la deuda.
- campo1 -> VARCHAR(200): Campo Adicional 1 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo2 -> VARCHAR(200): Campo Adicional 2 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo3 -> VARCHAR(200): Campo Adicional 3 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo4 -> VARCHAR(200): Campo Adicional 4 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo5 -> VARCHAR(200): Campo Adicional 5 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo6 -> VARCHAR(200): Campo Adicional 6 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo7 -> VARCHAR(200): Campo Adicional 7 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo8 -> VARCHAR(200): Campo Adicional 8 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo9 -> VARCHAR(200): Campo Adicional 9 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo10 -> VARCHAR(200): Campo Adicional 10 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- fechavencimiento -> DATETIME: Fecha de Vencimiento de la deuda en formato YYYY-mm-dd.
- fechavencimiento2 -> DATETIME: Fecha de 2do Vencimiento de la deuda en formato YYYY-mm-dd.
- fechavencimiento3 -> DATETIME: Fecha de 3re Vencimiento de la deuda en formato YYYY-mm-dd.
- idestado -> tinyint(4): Estado por defecto de la publicación de deuda.
- 0-Pendiente
- 1-Pago
- 2-Cancelado
- 3-Vencido
- 4-No Habilitado.
- 5-No Disponible
- moneda -> VARCHAR(50): Moneda de la publicación de la deuda según ISO 4217 Monedas Internacionales.
- importe -> DECIMAL(20,4): Importe de la publicación de la deuda sin separador de miles y con punto como separador de 4 decimales. Ej: 45874.2400
- importevto2 -> DECIMAL(20,4): Importe de la publicación de la deuda luego del vencimiento sin separador de miles y con punto como separador de 2 decimales. Ej: 45874.24
- importevto3 -> DECIMAL(20,4): Importe de la publicación de la deuda luego del 2do vencimiento sin separador de miles y con punto como separador de 2 decimales. Ej: 45874.24
- enviomail -> true/false: Indica si envió o no un email de aviso al cliente.
- enviopush -> true/false: Indica si envió o no un push mobile de aviso al cliente.
- enviosms -> true/false: Indica si envió o no un SMS de aviso al cliente.
- enviowhatsapp -> true/false: Indica si envió o no un Whatsapp de aviso al cliente.
Consultar Transacción
La API de Consulta de Transacción permite a la Empresa/Comercio realizar la consulta de una transacción generada en CuentaVirtual.
El endpoint a utilizar es el "api/v1/apipagos/core/get_tx" y dicho endpoint recibira por medio de GET la variable codigo la cual pertenece al código de referencia del comprobante/deuda a consultar. A continuación, se detalla las variables que retornará el sistema en un formato JSON:
- codigo -> VARCHAR(100): Indica el código de la transacción generada para el pago del comprobante.
- codigobilletera -> VARCHAR(50) (Obligatorio): Código de la billetera donde se generará la transacción al cliente (Consultar con Soporte).
- idgateway -> INT(6): Id del gateway donde se requiere realizar la transaccion. Dicho id del gateway se validará que pertenezca a la empresa logueada en la API.
- tipogateway -> VARCHAR(10) NULL,
- tipotx -> VARCHAR(50) (Obligatorio): Tipo de transacción a Generar.
- ON-On Line
- PG-Programada
- SC-Suscripcion
- SO-Solicitud_Dinero
- EN-Envio_Dinero
- TW-Transferencia_Wallet
- RE-Reintegro
- idestado -> tinyint(4) (Obligatorio): Estado inicial de la transaccion a generar.
- 0-Pendiente
- 1-Confirmada
- 2-Acreditada Gateway
- 3-Acreditada CuentaVirtual
- 10-Rechazada
- 11-Contracargo
- 20-Abandonada
- 99-Temporal
- 30-Procesando Gateway
- fechaprogramada -> DATETIME: Fecha programada para ejecutar la transacción en formato YYYY-mm-dd.
- fechavto1 -> DATETIME: Fecha de Vencimiento de la deuda en formato YYYY-mm-dd.
- fechatx -> DATETIME: Indica la fecha de generación de la transacción en formato YYYY-mm-dd.
- fechaacreditaciongateway -> DATETIME: Indica la fecha de la acreditación del pago en el gateway interviniente en formato YYYY-mm-dd.
- fechaacreditacionapipagos -> DATETIME: Indica la fecha de la acreditación en la cuenta de CuentaVirtual para la Empresa/Comercio en formato YYYY-mm-dd.
- fechaacreditacioncliente -> DATETIME: Indica la fecha de la acreditación en la cuenta del cliente en formato YYYY-mm-dd.
- fechacontracargo -> DATETIME: Indica la fecha de recepción y generación si existiese un contracargo y/o rechazo en formato YYYY-mm-dd.
- fechacontrol -> DATETIME: Indica la fecha de control de un operador de CuentaVirtual en formato YYYY-mm-dd.
- fecharendicion -> DATETIME: Indica la fecha de rendición a la Empresa/Negocio en caso que corresponda en formato YYYY-mm-dd.
- loterendicion -> VARCHAR(100): Indica la descripción del lote de rendición.
- titulo -> VARCHAR(100) (Obligatorio): Título de la transacción a mostrarle al cliente.
- concepto -> VARCHAR(250): Concepto detalle de la transacción a mostrarle al cliente.
- moneda -> VARCHAR(50) (Obligatorio): Moneda de la publicación de la deuda según ISO 4217 Monedas Internacionales.
- signoimporte -> VARCHAR(2): Signo del importe para la cuenta corriente del cliente +/-.
- importecobrado -> DECIMAL(20,4) (Obligatorio): Importe de la transacción.
- importeacreditadoapipagos -> DECIMAL(20,4): Indica el importe que se acredito en CuentaVirtual por el procesador de la transacción.
- importeacreditadocliente -> DECIMAL(20,4): Indica el importe que se acredito en la cuenta del destinatario de la transacción.
- comisiongateway -> DECIMAL(10,4): Indica la comisión cobrada por el procesador de la transacción.
- comisionapipagos -> DECIMAL(10,4): Indica la comisión cobrada por CuentaVirtual por el procesamiento de la transacción.
- comisioncliente -> DECIMAL(10,4): Indica la comisión cobrada al cliente / usuario final por la transacción.
- retenciones -> DECIMAL(10,4): Indica el total de retenciones realizadas a la Empresa/Negocio.
- ivacomisiongateway -> DECIMAL(10,4): Indica el impuesto de la comisión cobrada por el procesador de la transacción.
- ivacomisionapipagos -> DECIMAL(10,4): Indica el impuesto de la comisión cobrada por el procesador de la transacción.
- ivacomisioncliente -> DECIMAL(10,4): Indica el impuesto de la comisión cobrada al cliente / usuario final por la transacción.
- emailuserorigen -> VARCHAR(200) (Obligatorio): Permite identificar el Email del cliente de la transacción.
- tipodocorigen -> VARCHAR(5) (Obligatorio): Permite seleccionar el tipo de documento del cliente de la transacción.
- CUIL
- CUIT
- DNI
- nrodocorigen -> VARCHAR(20) (Obligatorio): Permite identificar el Nro Documento del cliente de la transacción.
- emailuserdestino -> VARCHAR(200): Permite identificar el Email del usuario de destino de la transacción.
- tipodocdestino -> VARCHAR(5): Permite seleccionar el tipo de documento del usuario de destino de la transacción.
- CUIL
- CUIT
- DNI
- nrodocdestino -> VARCHAR(20): Permite identificar el Nro Documento del usuario de destino de la transacción.
- referencia1 -> VARCHAR(200): Campo para datos de referencia de la Empresa/Negocio.
- referencia2 -> VARCHAR(200): Campo para datos de referencia de la Empresa/Negocio.
- cbte -> VARCHAR(1000): Código de Endpoint de publicación de deuda en caso que se desee referenciar la transacción con una publicación de deuda.
- typecbte -> VARCHAR(50): Refiere al tipo de comprobante configurado en CuentaVirtual. Dicho tipo de comprobante brindara la forma de tratamiento de dicha publicación y los métodos de pago habilitados.
- codigoconc -> VARCHAR(200): Código relacionado con la tabla de conciliaciones en caso que haya conciliada contra dicha tabla.
- webhook1 -> TEXT: Valor JSON del webhook recibido por el procesador de la transacción.
- fechavigencia -> DATETIME: Fecha en la cual se creo la transacción en formato YYYY-mm-dd.
- auditor -> VARCHAR(32): Usuario auditor de la transacción.
- iptx -> VARCHAR(100): Dirección IP desde donde se ejecuto la transacción.
- dispositivo -> VARCHAR(4000): Dispositivo desde donde se ejecuto la transacción.
Consultar Reintegro
La API de Consulta de Reintegro permite a la Empresa/Comercio realizar la consulta del estado de un reintegro en especial:
El endpoint a utilizar es el "api/v1/apipagos/core/get_reintegro" y dicho endpoint recibira por medio de GET las variables "t", que corresponde al token JWT generado con la API de login y codigo, la cual pertenece al código de referencia del reintegro a consultar. A continuación, se detalla las variables que retornará el sistema en un formato JSON:
- typereintegro -> VARCHAR(50): Indica el tipo de Reintegro.
- lote -> VARCHAR(200) (Obligatorio): Refiere al tipo de comprobante configurado en CuentaVirtual. Dicho tipo de comprobante brindara la forma de tratamiento de dicha publicación y los métodos de pago habilitados.
- idgateway -> INT(6) (Obligatorio): El gateway a utilizar en la transacción.
- tipogateway -> VARCHAR(10): Tipo de gateway a utilizar en la transacción.
- tipotx -> VARCHAR(50): Indica el tipo de transacción.
- ON - Online
- PG - Programada
- SC - Suscripción
- SO - Solicitud de Dinero
- EN - Envío de Dinero
- TW - Transferencia desde Wallet
- token -> VARCHAR(1000): Campo extra para identificar la operación.
- importe1 -> DECIMAL(10,4) (Obligatorio): Importe del Reintegro.
- importe2 -> DECIMAL(10,4): Otro Importe del Reintegro.
- importe3 -> DECIMAL(10,4): Otro Importe del Reintegro.
- idestado -> TINYINT(4) (Obligatorio): Estado por defecto de la publicación de deuda.
- 0 - Pendiente
- 1 - Confirmado
- 2 - Pendiente CBU
- 3 - Reintegrado
- 4 - Cancelado
- 5 - Rechazado
- 6 - Error en el Pago
- diareintegro -> INT(6): Indica sí el cobro del reintegro está programado.
- fechaprogramada -> DATETIME: Fecha programada del reintegro.
- fechasolicitud -> DATETIME: Fecha solicitud del reintegro.
- emailuserorigen -> VARCHAR(200): Permite identificar el Email del cliente que debe acceder a dicho reintegro.
- tipodocorigen -> VARCHAR(5): Permite identificar el Tipo de Documento del cliente que debe acceder a dicho reintegro.
- CUIL
- CUIT
- DNI
- nrodocorigen -> VARCHAR(200): Permite identificar el Número de Documento del cliente que debe acceder a dicho reintegro.
- referencia1 -> VARCHAR(1000): Referencia
- referencia2 -> VARCHAR(1000): Referencia
- campo1 -> VARCHAR(200): Campo Adicional 1 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo2 -> VARCHAR(200): Campo Adicional 2 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo3 -> VARCHAR(200): Campo Adicional 3 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo4 -> VARCHAR(200): Campo Adicional 4 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo5 -> VARCHAR(200): Campo Adicional 5 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo6 -> VARCHAR(200): Campo Adicional 6 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo7 -> VARCHAR(200): Campo Adicional 7 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo8 -> VARCHAR(200): Campo Adicional 8 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo9 -> VARCHAR(200): Campo Adicional 9 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo10 -> VARCHAR(200): Campo Adicional 10 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- codigotx -> VARCHAR(200): Codigo de la transacción por la cual se realiza el reintegro.
- idproceso -> INT(6) (Obligatorio): ID Proceso.
- codrelacion -> VARCHAR(250): Código Relación.
- iptx -> VARCHAR(100): IP desde la que se realiza la operación..
- dispositivo -> VARCHAR(4000): Dispositivo desde el que se realiza la operación.
Consultar Suscripcion
La API de Consulta de Suscripcion le permite a la Empresa/Comercio realizar la consulta del estado de una Suscripción.
El endpoint a utilizar es el "api/v1/apipagos/core/get_susc" y dicho endpoint recibira por medio de GET la variable codigo la cual pertenece al código de referencia de la suscripción a consultar. A continuación, se detalla las variables que retornará el sistema en un formato JSON:
- idgateway INT(6): Indica el ID del Gateway utilizado.
- tipogateway -> VARCHAR(10): Indica el tipo de Gateway:
- ON - Online
- PG - Programada
- SC - Suscripcion
- SO - Solicitud de Dinero
- EN - Envío de Dinero
- TW - Transferencia desde Wallet
- tipotx -> VARCHAR(50): Tipo de Transacción.
- token -> VARCHAR(100): Indica el token del valor generado para procesar la transacción. Cifrado mediante el método AES-256-CBC, utilizando como clave el apitoken de la empresa. Ej: CBU/Tarjeta.
- idestado -> INT(4):
- 0 - Pendiente Aprobacion
- 1 - Activo
- 2 - Cancelado
- diadebito -> INT(6): Permite identificar el dìa del mes para ejecutar la suscripción en caso que corresponda un débito.
- fechaprogramada -> DATETIME: Fecha en la que se ejecuta la suscripción, en caso que corresponda un débito.
- iduserorigen -> INT(6): ID del usuario que está suscripto.
- emailuserorigen -> VARCHAR(200): Email del usuario que está suscripto.
- tipodocorigen -> VARCHAR(5): Permite identificar el Tipo de Documento del cliente:
- CUIL
- CUIT
- DNI
- nrodocorigen -> VARCHAR(20): Número de Documento del cliente suscripto.
- iduserdestino -> INT(6): ID del usuario destino de la transacción.
- emailuserdestino -> VARCHAR(500): Email del usuario de destino de la transacción.
- tipodocdestino -> VARCHAR(5): Tipo de documento del usuario de destino de la transacción:
- CUIT
- CUIL
- DNI
- nrodocdestino -> VARCHAR(20): Nro Documento del usuario de destino de la transacción.
- referencia1 -> VARCHAR(200): Referencia.
- referencia2 -> VARCHAR(200): Referencia.
- typecbte -> VARCHAR(50): Refiere al tipo de comprobante configurado en CuentaVirtual. Dicho tipo de comprobante brindara la forma de tratamiento de dicha publicación y los métodos de pago habilitados.
- codigotx -> VARCHAR(200): Código de la transacción.
- fechavigencia -> DATETIME: Fecha en la que se realizó la suscripción.
- auditor -> VARCHAR(32): Auditor de la suscripción.
Consultar Trámite TED
La API de Consulta de TED le permite a la Empresa/Comercio realizar la consulta de la información relacionada a un TED.
El endpoint a utilizar es el "api/v1/apipagos/core/get_ted_tx" y dicho endpoint recibira por medio de GET las variables "t", que corresponde al token JWT generado con la API de login y "codigo" el cual pertenece al código de referencia del TED a consultar. A continuación, se detalla las variables que retornará el sistema en un formato JSON:
- state INT(6): Estado de la consulta.
- message -> VARCHAR(200): Descripción del estado.
- id -> INT(6): ID del Trámite.
- empresa -> VARCHAR(100): Empresa a la que pertenece el trámite.
- idportal -> INT(6): ID del portal.
- idtramite -> INT(6) ID del trámite.
- iddepartamento -> INT(6): ID del del departamento al que pertenece el trámite.
- idproducto -> INT(6): ID del producto.
- iduserorigen -> INT(6): ID del usuario al que pertenece el trámite.
- emailuserorigen -> VARCHAR(100): Email del usuario.
- tipodocorigen -> VARCHAR(5): Permite identificar el Tipo de Documento del usuario (CUIT).
- nrodocorigen -> VARCHAR(20): Número de Documento del usuario.
- tipotx -> VARCHAR(200): Tipo de Transacción.
- idultimopaso -> INT(6): ID del último paso.
- codigo -> VARCHAR(200): Código que identifica el trámite.
- sesion -> VARCHAR(200): Datos de sesión.
- fecha -> DATETIME: Fecha de creación del trámite.
- fechatratamiento -> DATETIME: Fecha de tratamiento del trámite.
- fechaultimopaso -> DATETIME: Fecha ultimo paso del trámite.
- codrelacion -> VARCHAR(200): Código de relación.
- ip -> VARCHAR(200): IP pública del usuario.
- navegador -> VARCHAR(200): Información pública del dispositivo del usuario.
- idestado -> INT(6): ID del estado.
- idestadoworkflow -> INT(6): ID del estado del workflow.
- formularios -> ARRAY(OBJECT): Formularios asociados al trámite.
- id -> INT(6): ID de Registro.
- idformulario -> INT(6): ID del formulario relacionado.
- iduser -> INT(6): ID del formulario.
- iddepartamento -> INT(6): ID del departamento al que pertenece el formulario.
- idtramiteregistro -> VARCHAR(200): ID del registro del Trámite.
- codigo -> VARCHAR(200): Código de identificación del Formulario.
- sesion -> VARCHAR(200): Datos de sesión.
- fecha -> DATETIME: Fecha de creación del formulario.
- fechatratamiento -> DATETIME: Fecha de tratamiento del formulario.
- codrelacion -> VARCHAR(200): Código de relación.
- ip -> VARCHAR(200): IP pública del usuario.
- navegador -> VARCHAR(200): Información pública del dispositivo del usuario.
- idestado -> INT(6): ID del estado.
- idestadoworkflow -> INT(6): ID del estado del workflow.
- campos -> ARRAY(OBJECT): Campos asociados al trámite.
- id -> INT(6): ID de Registro.
- idformulario -> INT(6): ID del formulario relacionado.
- idcampo -> INT(6): ID del campo.
- idregistro -> INT(6): ID del registro relacionado.
- registrovalor -> INT(6): Valor del campo.
- registrodescripcion -> VARCHAR(200): Descripción del campo.
- nombredoc -> VARCHAR(200): Nombre del documento adjunto.
- tamanodoc -> VARCHAR(200): Tamaño del documento adjunto.
- linkdoc -> VARCHAR(200): Link para visualizar el documento adjunto.
Actualizar Deuda
La API de actualización de deuda permite a la Empresa/Comercio realizar el envio de informaciòn para actualizar los datos de una deuda publicada. A continuación se detalla el funcionamiento del endpoint de actualización de deuda:
El endpoint a utilizar es el "api/v1/apipagos/core/update_doc" y dicho endpoint recibira por medio de GET la variable CodSeg y por medio del body un JSON con las siguientes variables dispoblibles para dicha funcionalidad:
- codigo -> VARCHAR(100) (Obligatorio): Indica el codigo obtenido en la creaciòn de la publicaciòn de deuda.
- emision -> VARCHAR(100) (Obligatorio): Indica una referencia de la emisión del comprobante para ser mostrada al cliente.
- tipo -> VARCHAR(50) (Obligatorio): Refiere al tipo de comprobante configurado en CuentaVirtual. Dicho tipo de comprobante brindara la forma de tratamiento de dicha publicación y los métodos de pago habilitados.
- idworkflow -> INT(6): Indica si se quiere ejecutar un workflow al recibir dicho comprobante (Consultar a Soporte).
- titulo -> VARCHAR(100) (Obligatorio): Título de la Deuda.
- documento -> TEXT: Detalle o descripcion del comprobante en formato HTML.
- link -> VARCHAR(1000): Link / URL del comprobante de la deuda.
- campo1 -> VARCHAR(200): Campo Adicional 1 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo2 -> VARCHAR(200): Campo Adicional 2 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo3 -> VARCHAR(200): Campo Adicional 3 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo4 -> VARCHAR(200): Campo Adicional 4 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo5 -> VARCHAR(200): Campo Adicional 5 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo6 -> VARCHAR(200): Campo Adicional 6 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo7 -> VARCHAR(200): Campo Adicional 7 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo8 -> VARCHAR(200): Campo Adicional 8 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo9 -> VARCHAR(200): Campo Adicional 9 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo10 -> VARCHAR(200): Campo Adicional 10 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- fechavencimiento -> DATETIME: Fecha de Vencimiento de la deuda en formato YYYY-mm-dd.
- fechavencimiento2 -> DATETIME: Fecha de 2do Vencimiento de la deuda en formato YYYY-mm-dd.
- fechavencimiento3 -> DATETIME: Fecha de 3re Vencimiento de la deuda en formato YYYY-mm-dd.
- idestado -> tinyint(4): Estado por defecto de la publicación de deuda.
- 0-Pendiente
- 1-Pago
- 2-Cancelado
- 3-Vencido
- 4-No Habilitado.
- 5-No Disponible
- moneda -> VARCHAR(50) (Obligatorio): Moneda de la publicación de la deuda según ISO 4217 Monedas Internacionales.
- importe -> DECIMAL(20,4) (Obligatorio): Importe de la publicación de la deuda sin separador de miles y con punto como separador de 4 decimales. Ej: 45874.2400
- importevto2 -> DECIMAL(20,4): Importe de la publicación de la deuda luego del vencimiento sin separador de miles y con punto como separador de 2 decimales. Ej: 45874.24
- importevto3 -> DECIMAL(20,4): Importe de la publicación de la deuda luego del 2do vencimiento sin separador de miles y con punto como separador de 2 decimales. Ej: 45874.24
- enviamail -> true/false: Indica si envia o no un email de aviso al cliente.
- enviapush -> true/false: Indica si envia o no un push mobile de aviso al cliente.
- enviasms -> true/false: Indica si envia o no un SMS de aviso al cliente.
- enviawhatsapp -> true/false: Indica si envia o no un Whatsapp de aviso al cliente.
- idtemplatecbte -> Indica el ID del template en caso que se requiera generar un comprobante dinamicamente en base a un template pre-parametrizado.
Ejemplo de llamado a la API desde PHP:
//Campos necesarios para la creación de un Comprobante
$jwt = "Token Generado con el endpoint /login",
$emision = "OCTUBRE_2020";
$tipo = "Prueba";
$titulo = "Documento de Prueba";
$documento = "<p>Esto es un documento de Prueba</p>"
$link = "https://sysworld.com.ar/";
$campo1 = "9876";
$campo2 = "4561";
$campo3 = "";
$campo4 = "";
$campo5 = "";
$campo6 = "";
$campo7 = "";
$campo8 = "";
$campo9 = "";
$campo10 = "";
$fechavencimiento = date("Y-m-d H:i:s", strtotime(date("Y-m-d H:i:s") . "+ 3 days");
$fechavencimiento2 = "";
$fechavencimiento3 = "";
$idestado = "0";
$moneda = "ARS";
$importe = "450.50";
$importevto2 = "0";
$importevto3 = "0";
$enviamail = "0";
$enviapush = "0";
$enviasms = "1";
$enviawhatsapp = "0";
// Se prepara un array con los campos necesarios
$campos = [
"jwt" => $jwt,
"emision" => $emision,
"tipo" => $tipo,
"titulo" => $titulo,
"documento" => $documento,
"link" => $link,
"campo1" => $campo1,
"campo2" => $campo2,
"campo3" => $campo3,
"campo4" => $campo4,
"campo5" => $campo5,
"campo6" => $campo6,
"campo7" => $campo7,
"campo8" => $campo8,
"campo9" => $campo9,
"campo10" => $campo10,
"fechavencimiento" => $fechavencimiento,
"fechavencimiento2" => $fechavencimiento2,
"fechavencimiento3" => $fechavencimiento3,
"idestado" => $idestado,
"moneda" => $moneda,
"importe" => $importe,
"importevto2" => $importevto2,
"importevto3" => $importevto3,
"enviamail" => $enviamail,
"enviapush" => $enviapush,
"enviasms" => $enviasms,
"enviawhatsapp" => $enviawhatsapp
];
// Se crea un JSON mediante el array
$json = json_encode($campos);
// Iniciamos CURL
$url = "http://cont1-test1.certisend.com/web/container/api/v1/apipagos/core/update_doc?codseg=##CodigoDeSeguridad##";
$curl = curl_init($url);
curl_setopt_array($curl, [
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => $json,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ["Content-Type: application/json"]
]);
// Se obtiene la respuesta
$response = curl_exec($curl);
Una vez llamada correctamente a la API, el sistema retornará una repuesta en JSON con las siguientes variables:
- state -> tinyint(4): Estado del procesamiento de la llamada.
- 0-Pendiente
- 1-Exitoso
- 2-Error
- message -> VARCHAR(200): Indica la descripción de la API.
- codigo -> VARCHAR(200): Se retorna ante un estado exitoso e indica el codigo generado para la transacción.
- date -> VARCHAR(100): Retorna la fecha y hora de la llamada en formato YYYY-mm-dd HH:II:SS
- id_internal -> VARCHAR(200): Se retorna ante un estado exitoso e indica el ID generado para la transacción.
Actualizar Suscripción
La api de actualizar una suscripción le permite a la Empresa/Negocio poder actualizar los datos de una Transacción de Suscripción previamente creada.
El endpoint a utilizar es el "api/v1/apipagos/core/update_susc" y dicho endpoint recibirá por medio de GET la variable CodSeg y por medio del body un JSON con las siguientes variables:
- codigo -> VARCHAR(100) (Obligatorio): Indica el codigo obtenido en la creaciòn de la suscripción.
- idestado tinyint(4)
- 0-Pendiente Aprobacion
- 1-Activo
- 2-Cancelado
- diadebito -> INT(2): Permite identificar el dìa del mes para ejecutar la suscripción en caso que corresponda un débito.
- referencia1 -> VARCHAR(200): Referencia
- referencia2 -> VARCHAR(200): Referencia
- campo1 -> VARCHAR(200): Campo Adicional 1 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo2 -> VARCHAR(200): Campo Adicional 2 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo3 -> VARCHAR(200): Campo Adicional 3 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo4 -> VARCHAR(200): Campo Adicional 4 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo5 -> VARCHAR(200): Campo Adicional 5 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo6 -> VARCHAR(200): Campo Adicional 6 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo7 -> VARCHAR(200): Campo Adicional 7 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo8 -> VARCHAR(200): Campo Adicional 8 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo9 -> VARCHAR(200): Campo Adicional 9 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo10 -> VARCHAR(200): Campo Adicional 10 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- typecbte -> VARCHAR(50): Refiere al tipo de comprobante configurado en CuentaVirtual. Dicho tipo de comprobante brindara la forma de tratamiento de dicha publicación y los métodos de pago habilitados.
Ejemplo de llamado a la API desde PHP:
//Campos de ejemplo para la actualización de un Comprobante
$jwt = "Token Generado con el endpoint /login",
$codigo = "dd93f45084d65a328486284c7112b1sd";
$idestado = "1";
$referencia1 = "20/10/2020"
$referencia2 = "Debito Automatico Cuota"
$campo1 = "111"
$campo2 = "2222/23"
$typecbte = "suscripcionweb"
// Se prepara un array con los campos necesarios
$campos = [
"jwt" => $jwt,
"codigo" => $codigo,
"idestado" => $idestado,
"referencia1" => $referencia1,
"referencia2" => $referencia2,
"campo1" => $campo1,
"campo2" => $campo2,
"typecbte" => $typecbte
];
// Se crea un JSON mediante el array
$json = json_encode($campos);
// Iniciamos CURL
$url = "http://cont1-test1.certisend.com/web/container/api/v1/apipagos/core/update_susc?codseg=##CodigoDeSeguridad##";
$curl = curl_init($url);
curl_setopt_array($curl, [
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => $json,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ["Content-Type: application/json"]
]);
// Se obtiene la respuesta
$response = curl_exec($curl);
Una vez llamada correctamente a la API, el sistema retornará una repuesta en JSON con las siguientes variables:
- state -> tinyint(4): Estado del procesamiento de la llamada.
- 0-Pendiente
- 1-Exitoso
- 2-Error
- message -> VARCHAR(200): Indica la descripción de la API.
- codigo -> VARCHAR(200): Se retorna ante un estado exitoso e indica el codigo generado para la transacción.
- date -> VARCHAR(100): Retorna la fecha y hora de la llamada en formato YYYY-mm-dd HH:II:SS
- id_internal -> VARCHAR(200): Se retorna ante un estado exitoso e indica el ID generado para la transacción.
Actualizar Transacción
La api de actualizar Transacción le permite a la Empresa/Negocio poder actualizar los datos de una Transacción previamente creada.
El endpoint a utilizar es el "api/v1/apipagos/core/update_tx" y dicho endpoint recibirá por medio de GET la variable CodSeg y por medio del body un JSON con las siguientes variables:
- codigo -> VARCHAR(100) (Obligatorio): Indica el codigo de la Transacción, obtenido en la creación de la misma.
- idestado tinyint(4)
- 0-Pendiente
- 1-Confirmada
- 2-Acreditada Gateway
- 3-Acreditada CuentaVirtual
- 10-Rechazada
- 11-Contracargo
- 19-Cancelada
- 20-Abandonada
- 25-Pendiente Reversa
- 15-Pendiente Autorizar
- 99-Temporal
- 30-Procesando Gateway
- idestadosyscore tinyint(4)
- 0-Pendiente
- 1-Procesada
- 2-Error
- 99-Procesando
- 100-N/A
- idestadocliente tinyint(4)
- 0-Pendiente
- 1-Pendiente Acreditación
- 2-Error
- 10-Acreditada
- titulo -> VARCHAR(100): Titulo
- concepto -> VARCHAR(100): Concepto
- codauth -> VARCHAR(100): Código de Autenticación de la Transacción
Ejemplo de llamado a la API desde PHP:
//Campos de ejemplo para la actualización de un Comprobante
$jwt = "Token Generado con el endpoint /login",
$codigo = "dd93f45084d65a328486284c7112b1sd";
$idestadocliente = "10";
// Se prepara un array con los campos necesarios
$campos = [
"jwt" => $jwt,
"codigo" => $codigo,
"idestadocliente" => $idestadocliente
];
// Se crea un JSON mediante el array
$json = json_encode($campos);
// Iniciamos CURL
$url = "http://cont1-test1.certisend.com/web/container/api/v1/apipagos/core/update_tx?codseg=##CodigoDeSeguridad##";
$curl = curl_init($url);
curl_setopt_array($curl, [
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => $json,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ["Content-Type: application/json"]
]);
// Se obtiene la respuesta
$response = curl_exec($curl);
Una vez llamada correctamente a la API, el sistema retornará una repuesta en JSON con las siguientes variables:
- state -> tinyint(4): Estado del procesamiento de la llamada.
- 0-Pendiente
- 1-Exitoso
- 2-Error
- message -> VARCHAR(200): Indica la descripción de la API.
- codigo -> VARCHAR(200): Se retorna ante un estado exitoso e indica el codigo generado para la transacción.
- date -> VARCHAR(100): Retorna la fecha y hora de la llamada en formato YYYY-mm-dd HH:II:SS
- id_internal -> VARCHAR(200): Se retorna ante un estado exitoso e indica el ID generado para la transacción.
Actualizar Reintegro
La api de actualizar Reintegro le permite a la Empresa/Negocio poder actualizar los datos de una Transacción de Reintegro previamente creada.
El endpoint a utilizar es el "api/v1/apipagos/core/update_reintegro" y dicho endpoint recibirá por medio de GET la variable CodSeg y por medio del body un JSON con las siguientes variables:
- codigo -> VARCHAR(100) (Obligatorio): Indica el codigo obtenido en la creacón del Reintegro.
- typereintegro -> VARCHAR(100): Tipo de Reintegro.
- idgateway -> VARCHAR(100): ID del Gateway a utilizar.
- tipotx -> VARCHAR(100): Tipo de Transacción.
- token -> VARCHAR(100): Token de la Transacción / Dato del medio de pago utilizado.
- importe1 -> VARCHAR(100): Importe 1.
- importe2 -> VARCHAR(100): Importe 2.
- importe3 -> VARCHAR(100): Importe 3.
- idestado tinyint(4)
- 0 - Pendiente
- 1 - Confirmado
- 2 - Pendiente CBU
- 3 - Reintegrado
- 4 - Cancelado
- 5 - Rechazado
- 6 - Error en el Pago
- diareintegro -> INT: Día de acreditación.
- fechaprogramada -> DATE: Fecha de acreditación.
- emailuserorigen -> VARCHAR(100): Email del usuario.
- tipodocorigen -> VARCHAR(100): Tipo de Documento del Usuario.
- nrodocorigen -> VARCHAR(100): Documento del usuario.
- referencia1 -> VARCHAR(200): Referencia
- referencia2 -> VARCHAR(200): Referencia
- campo1 -> VARCHAR(200): Campo Adicional 1 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo2 -> VARCHAR(200): Campo Adicional 2 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo3 -> VARCHAR(200): Campo Adicional 3 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo4 -> VARCHAR(200): Campo Adicional 4 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo5 -> VARCHAR(200): Campo Adicional 5 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo6 -> VARCHAR(200): Campo Adicional 6 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo7 -> VARCHAR(200): Campo Adicional 7 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo8 -> VARCHAR(200): Campo Adicional 8 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo9 -> VARCHAR(200): Campo Adicional 9 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo10 -> VARCHAR(200): Campo Adicional 10 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- codigotx -> VARCHAR(100): Código de la Transacción Relacionada.
- idproceso -> VARCHAR(100): ID de Proceso.
- codrelacion -> VARCHAR(100): Código de Relación Externo.
- iptx -> VARCHAR(100): IP desde la que se realizó la operación.
- dispositivo -> VARCHAR(100): Dispositivo desde el que se realizó la operación.
Ejemplo de llamado a la API desde PHP:
//Campos de ejemplo para la actualización de un Comprobante
$jwt = "Token Generado con el endpoint /login",
$codigo = "dd93f45084d65a328486284c7112b1sd";
$importe1 = 3567.50;
$referencia1 = "20/10/2020";
$referencia2 = "Debito Automatico Cuota";
$campo1 = "111";
$campo2 = "2222/23";
// Se prepara un array con los campos necesarios
$campos = [
"jwt" => $jwt,
"codigo" => $codigo,
"importe1" => $importe1,
"referencia1" => $referencia1,
"referencia2" => $referencia2,
"campo1" => $campo1,
"campo2" => $campo2
];
// Se crea un JSON mediante el array
$json = json_encode($campos);
// Iniciamos CURL
$url = "http://cont1-test1.certisend.com/web/container/api/v1/apipagos/core/update_reintegro?codseg=##CodigoDeSeguridad##";
$curl = curl_init($url);
curl_setopt_array($curl, [
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => $json,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ["Content-Type: application/json"]
]);
// Se obtiene la respuesta
$response = curl_exec($curl);
Una vez llamada correctamente a la API, el sistema retornará una repuesta en JSON con las siguientes variables:
- state -> tinyint(4): Estado del procesamiento de la llamada.
- 0-Pendiente
- 1-Exitoso
- 2-Error
- message -> VARCHAR(200): Indica la descripción de la API.
- codigo -> VARCHAR(200): Se retorna ante un estado exitoso e indica el codigo generado para la transacción.
- date -> VARCHAR(100): Retorna la fecha y hora de la llamada en formato YYYY-mm-dd HH:II:SS
- id_internal -> VARCHAR(200): Se retorna ante un estado exitoso e indica el ID generado para la transacción.
Actualizar Trámite TED
La api actualizar trámite TED le permite a la Empresa/Negocio poder actualizar los datos de trámite TED.
El endpoint a utilizar es el "api/v1/apipagos/core/update_ted_tx" y dicho endpoint recibirá por medio de GET los parámetros codseg y código, y por medio del body un JSON con las siguientes variables:
- iddepartamento -> (Obligatorio) INT(6): ID del del departamento al que pertenece el trámite.
- idproducto -> (Obligatorio) INT(6): ID del producto.
- emailuserorigen -> VARCHAR(100): Email del usuario.
- idestado -> (Obligatorio) INT(6): ID del estado.
- idestadoworkflow -> (Obligatorio) INT(6): ID del estado del workflow.
- campo1 -> VARCHAR(100): Campo Adicional 1 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo2 -> VARCHAR(100): Campo Adicional 2 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo3 -> VARCHAR(100): Campo Adicional 3 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo4 -> VARCHAR(100): Campo Adicional 4 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo5 -> VARCHAR(100): Campo Adicional 5 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo6 -> VARCHAR(100): Campo Adicional 6 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo7 -> VARCHAR(100): Campo Adicional 7 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo8 -> VARCHAR(100): Campo Adicional 8 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo9 -> VARCHAR(100): Campo Adicional 9 Personalizado para la Empresa/Negocio (Consultar a Soporte).
- campo10 -> VARCHAR(100): Campo Adicional 10 Personalizado para la Empresa/Negocio (Consultar a Soporte).
Ejemplo de llamado a la API desde PHP:
//Campos de ejemplo para la actualización de un Comprobante
$jwt = "Token Generado con el endpoint /login",
$codigo = "dd93f45084d65a328486284c7112b1sd";
$iddepartamento = 10;
$idestado = 2;
$idestadoworkflow = 1";
// Se prepara un array con los campos necesarios
$campos = [
"jwt" => $jwt,
"codigo" => $codigo,
"iddepartamento" => $iddepartamento,
"idestado" => $idestado,
"idestadoworkflow" => $idestadoworkflow
];
// Se crea un JSON mediante el array
$json = json_encode($campos);
// Iniciamos CURL
$url = "http://cont1-test1.certisend.com/web/container/api/v1/apipagos/core/update_ted_tx?codseg=##CodigoDeSeguridad##&&codigo=$codigo";
$curl = curl_init($url);
curl_setopt_array($curl, [
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => $json,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ["Content-Type: application/json"]
]);
// Se obtiene la respuesta
$response = curl_exec($curl);
Una vez llamada correctamente a la API, el sistema retornará una repuesta en JSON con las siguientes variables:
- state -> tinyint(4): Estado del procesamiento de la llamada.
- 0-Error interno
- 1-Exitoso
- 2-Error
- message -> VARCHAR(200): Indica la descripción de la API.
- codigo -> VARCHAR(200): Se retorna ante un estado exitoso e indica el codigo del TED actualizado.
- id_internal -> VARCHAR(200): Se retorna ante un estado exitoso e indica el ID del TED actualizado.
Información Genérica
La API de Consulta Genérica le permite a la Empresa/Comercio consultar información genérica del Sistema.
El endpoint a utilizar es el "api/v1/apipagos/core/system_function" y dicho endpoint recibirá por medio de GET la variable CodSeg y por medio del body un JSON con la siguiente variable:
- function: Indica la función a ejecutar:
- table_system_data_geo_paises - Devuelve la info de la tabla "paises" del sistema.
- table_system_data_geo_provincias - Devuelve la info de la tabla "provincias" del sistema.
- table_system_data_geo_localidades - Devuelve la info de la tabla "localidades" del sistema.
- table_system_parametros_generales - Devuelve la info de la tabla "parametros generales" del sistema, para la empresa logueada.
- table_system_tablas_generales - Devuelve la info de la tabla "tablas generales" del sistema, para la empresa logueada.
- table_system_config - Devuelve la info de la tabla "system config" del sistema, para la empresa logueada.
El endpoint responderá el siguiente JSON:
- state: Indica el estado de la consulta
- 1 - OK
- 2 - Error
- message: Detalle de la respuesta.
- data: En caso de una respuesta exitosa, la información solicitada se regresa en este atributo.
Login Portal
El módulo de llamado al Login del front CuentaVirtual permite brindarle una herramienta de integración a Empresas/Negocios con el fin de que puedan vincular sus sistemas con los portales de CuentaVirtual. A continuación se detalla el funcionamiento de autologin:
Atención
El uso de autologin deberá ser coordinado con nuestro equipo de soporte para la correcta configuración del sistema.
La integración de login portal no es ni más ni menos que un llamado al servidor del portal de CuentaVirtual mediante un llamado HTTP GET concatenando los campos claves de login y un código de seguridad. A continuación se detallan los campos habilitados para autologin de usuarios y la forma correcta de generar el código de seguridad.
El endpoint a utilizar es el "web/container/app/syscoreweb/app/login" y dicho endpoint recibira por medio de GET la variable CodSeg y por medio del body un JSON con las siguientes variables:
- empresa: -> Obligatorio. Indica el codigo de empresa provisto por CuentaVirtual.
- type: -> Indica el tipo de validación. (simple/validation)
- destlogin: -> Indica la aplicación de destino una vez logueado
- metodo: -> Indica el metodo de menu del portal. (simple/completo)
- layout: -> Indica las hojas de estilos a utilizar en los portales. (Consultar a Soporte)
- campo1: -> Opcional: Campo fijo para validar en el login contra la tabla de usuarios.
- campo2: -> Opcional: Campo fijo para validar en el login contra la tabla de usuarios.
- campo3: -> Opcional: Campo fijo para validar en el login contra la tabla de usuarios.
- campo4: -> Opcional: Campo fijo para validar en el login contra la tabla de usuarios.
- campo5: -> Opcional: Campo fijo para validar en el login contra la tabla de usuarios.
- campo6: -> Opcional: Campo fijo para validar en el login contra la tabla de usuarios.
- campo7: -> Opcional: Campo fijo para validar en el login contra la tabla de usuarios.
- campo8: -> Opcional: Campo fijo para validar en el login contra la tabla de usuarios.
- campo9: -> Opcional: Campo fijo para validar en el login contra la tabla de usuarios.
- campo10: -> Opcional: Campo fijo para validar en el login contra la tabla de usuarios.
- codseg: -> Opcional. Ver Generar CodSeg -> APIS HTTP GET.
/login?empresa=demo&type=validation&destlogin=casillapostal_pendientes&metodo=simple&codseg=b4304c5d4bd33f0d91824fe0d58c5bcc
AutoLogin Portal
El módulo de autologin de CuentaVirtual permite brindarle una herramienta de integración a Empresas/Negocios con el fin de que puedan vincular sus sistemas con los portales de CuentaVirtual sin tener que solicitar otro login. A continuación se detalla el funcionamiento de autologin:
Atención
El uso de autologin deberá ser coordinado con nuestro equipo de soporte para la correcta configuración del sistema.
La integración de autologin portal no es ni más ni menos que un llamado al servidor del portal de CuentaVirtual mediante un llamado HTTP GET concatenando los campos claves de login y un código de seguridad. A continuación se detallan los campos habilitados para autologin de usuarios y la forma correcta de generar el código de seguridad.
- empresa: -> Obligatorio. Indica el codigo de empresa provisto por CuentaVirtual.
- email: -> Opcional
- cuit: -> Opcional
- DNI: -> Opcional
- layout: -> (Opcional) Indica las hojas de estilos a utilizar en los portales. (Consultar a Soporte)
- campo1: -> Opcional
- campo2: -> Opcional
- campo3: -> Opcional
- campo4: -> Opcional
- campo5: -> Opcional
- campo6: -> Opcional
- campo7: -> Opcional
- campo8: -> Opcional
- campo9: -> Opcional
- campo10: -> Opcional
- codseg: -> Obligario. Ver Generar CodSeg -> APIS HTTP GET.
/[email protected]&cuit=274521548&campo1=4444&campo2=123&codseg=b4304c5d4bd33f0d91824fe0d58c5bcc
WebHook
La API de Webhook permite ante determinados eventos que se generan en el sistema poder realizar un llamado a servidores de CuentaVirtual para notificar a la Empresa/Negocio de dicho evento.
Atención
El uso de dicho servicio deberá ser coordinado con nuestro equipo de soporte para la correcta configuración del sistema.
La tecnología de llamado de webhook de CuentaVirtual se basa en las siguientes definiciones:
- Detino: -> Servidores listados en la configuración CuentaVirtual
- Protocolo: -> HTTP / HTTPS
- Métodos: -> GET / POST
- Formatos: -> FORM_URL_ENCODE / JSON / XML(Beta)
- Frecuecia: -> MINUTO / HORA / DIA / MES / AÑO
APIs Complementarias
Las Apis complementarias permiten a las Empresas / Negocios de CuentaVirtual poder incorporar en sus procesos, tecnología de avanzada con el fin de generar valor agregado en dichos circuitos y mejorar la calidad y seguridad de las transacciones.
Atención
Puede que el uso de determinadas APIs complementarias requiera una suscripción adicional de nuestro producto ApiLanding y/o genere costos transaccionales adicionales. Para más información contacte a su asesor comercial.
Validar Identidad
¿Cómo se sabe que una persona es quién dice ser? A medida que el mundo online evoluciona, aumenta la necesidad de tener identidades verificables y de confianza. Aunque inicialmente una identidad falsa podría ser beneficiosa, en realidad es el centro de muchos de los delitos financieros.
Construir un marco necesario de confianza online requiere una verificación de identidad para confirmar que la persona realmente existe, verificar la validez y los datos de la identidad que proporciona, datos también conocidos como Información de Identificación Personal (en inglés PII – Personal Identifiable Information). Existen tres tipos diferentes de verificaciones:
- Autenticación de identidad: La autenticación de identidad determina si la persona es quien dice ser, basándose en datos adicionales que son difíciles de proporcionar, excepto por esa persona en concreto.
- Validación y Verificación de identidad: El proceso de identidad comienza en la verificación; ¿existe un registro de esa persona? Cuando una persona proporciona su información de identificación, como el nombre, la dirección y la fecha de nacimiento, ¿coincide esa información con el registro de una persona?
- Verificación del documento: La verificación de documentos usa la posesión de documentos de identidad para autenticarse. Las fotos de las licencias de conducir, los pasaportes u otros documentos de identificación se examinan electrónicamente para determinar la autenticidad y la legitimidad, así como para garantizar que el documento no haya sido falsificado. La información es indicada por la persona que posee el documento, pero ¿qué sucede si un estafador tiene esos documentos? Para evitar esa posible suplantación de identidad, una foto tomada en tiempo real se compara con la foto registrada para su validación.
Las diferencias entre los tres tipos pueden causar confusión ya que cada uno incluye información diferente, tiene implicaciones y requisitos legales distintos. Los términos de cada uno de ellos tienen diferentes significados. El nivel de verificación de identidad depende de la estrategia de mitigación de riesgos de una empresa y, si se trata de una institución financiera, como un banco o un negocio de servicios monetarios (en inglés MSB – Money Service Business), a qué regulaciones pertenecen.
Si bien CuentaVirtual provee sus propios procesos de validación de identidad al momento de realizar transacciones Nativas de CuentaVirtual, nuestra infraestructura provee las siguientes APIs para acompañar a nuestros clientes en la generación de procesos y transacciones robustos:
- Validar CUIT: La API de validación de CUIT permite poder realizar un llamado y en milesimas de segundo recibir información acerca de si el número de cuit es valido o no además
de retornar información referente a la persona consultada.
Para mayor información puede consultar:
Ver Detalles de la API
- Validar Documentos Apocrifos: El Registro de Documentos de Identidad Cuestionados reúne información sobre los documentos que han sido denunciados por extravío o robo.
Los bancos y las entidades financieras, antes de otorgar sus productos, están obligadas a consultar el Registro. De ese modo, se puede prevenir robo de identidad y fraudes.
Para mayor información puede consultar:
Ver Detalles de la API
- Convertir DNI a CUIT: La API de conversión automática de DNI a CUIT permite recorrer diferentes bases de datos de personas físicas con el fin de encontrar
duplicidad de documentos y poder determinar una conversión segura
Para mayor información puede consultar:
Ver Detalles de la API
- Encuesta Multiple-Choice: Una de las formas más utilizadas en internet para validar la identidad de una persona digital es realizar una encuesta múltiple choice y comparar las respuestas generando un score de seguridad. Gracias a esta API, el sistema recibirá un CUIT y retornara un lote de preguntas y respuestas dentro de las
cuales se marcarán las positivas con los fines de realizar un score de validación.
Para mayor información puede consultar:
Ver Detalles de la API
- Validación Biometrica: La biometría es la ciencia del análisis de las características físicas o del comportamiento, propias de cada individuo, con el fin de autenticar su identidad.
Gracias a esta API, el sistema es capaz de recibir imagenes de la persona y validarlas contra datos conocidos y/o bases de datos públicas como RENAPER.
Para mayor información puede consultar:
Ver Detalles de la API
Validar CBU / CVU
La herramienta de Validación de CBU es la solución informática para validar y normalizar números de CBU/CVU del mercado financiero Argentino.
Años de trayectoria brindando soluciones al mundo empresarial y financiero, nos han permitido detectar la gran cantidad de errores en los procesos por fallas en la carga de los datos del CBU/CVU.
Validar CBU Simple
El endpoint a utilizar es "api/v1/apipagos/core/extra/validate_cbu_simple", el mismo recibira por medio de GET la variable codseg y por medio del body un JSON con las siguientes variables:
- jwt -> Código generado con el endpoint /login.
- cbu -> CBU/CVU a validar. El mismo debe estar Cifrado mediante el método AES-256-CBC, utilizando como clave el apitoken de la empresa.
// Campos necesarios para la consulta de CBU/CVU
$jwt = "Token Generado con el endpoint /login";
// El endpoint /validate_cbu_simple solo acepta CBU/CVU numéricos.
$cbu = "2850590940090418135201";
$cbu = openssl_encrypt($cbu, "AES-256-CBC", ##ApiTokenDeEmpresa##);
// Se prepara un array con los campos necesarios
$campos = [
"jwt" => $jwt,
"cbu" => $cbu
];
// Se crea un JSON mediante el array
$json = json_encode($campos);
// Iniciamos CURL
$url = "http://cont1-test1.certisend.com/web/container/api/v1/apipagos/core/extra/validate_cbu_simple?codseg=##CodigoDeSeguridad##";
$curl = curl_init($url);
curl_setopt_array($curl, [
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => $json,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ["Content-Type: application/json"]
]);
// Se obtiene la respuesta
$response = curl_exec($curl);
Una vez llamada correctamente la API, el sistema retornará una respuesta en JSON con las siguiente variables:
En caso de CBU:
-
state -> Estado de la validación.
- 0 - Error
- 1 - OK
- type -> Indica el tipo (CBU/CVU);
- bankid -> Identificador del Banco.
- bankname -> Nombre del Banco.
- banklogo -> Logo del Banco.
- bankid -> Sucursal del Banco.
- bankid -> N° de cuenta del Usuario.
En caso de CVU:
-
state -> Estado de la validación.
- 0 - Error
- 1 - OK
- pspid -> Identificador del PSP.
En caso de error (CBU/CVU), se agrega el campo:
- desc -> Descripción del error.
También, contamos con una API con la cual podrá validar no solo si un CBU/CVU es válido sino los datos del titular del mismo.
Validar CBU Completo
El endpoint a utilizar es "api/v1/apipagos/core/extra/validate_cbu_gold", el mismo recibira por medio de GET la variable codseg y por medio del body un JSON con las siguientes variables:
- jwt -> Código generado con el endpoint /login.
- cbu -> CBU/CVU/Alias a validar. El mismo debe estar Cifrado mediante el método AES-256-CBC, utilizando como clave el apitoken de la empresa.
- cuit -> (Opcional) Valida sí el CBU/CVU/Alias ingresado corresponde al CUIT del usuario.
// Campos necesarios para la consulta de CBU/CVU
$jwt = "Token Generado con el endpoint /login";
$cbu = "alias.ap";
$cbu = openssl_encrypt($cbu, "AES-256-CBC", ##ApiTokenDeEmpresa##);
// El campo cuit es opcional
// Sí está, valida que el CBU ingresado pertenezca al CUIT
$cuit = "20319846398";
// Se prepara un array con los campos necesarios
$campos = [
"jwt" => $jwt,
"cbu" => $cbu,
"cuit" => $cuit
];
// Se crea un JSON mediante el array
$json = json_encode($campos);
// Iniciamos CURL
$url = "http://cont1-test1.certisend.com/web/container/api/v1/apipagos/core/extra/validate_cbu_gold?codseg=##CodigoDeSeguridad##";
$curl = curl_init($url);
curl_setopt_array($curl, [
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => $json,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ["Content-Type: application/json"]
]);
// Se obtiene la respuesta
$response = curl_exec($curl);
Una vez llamada correctamente la API, el sistema retornará una respuesta en JSON con las siguiente variables:
-
state -> Estado de la validación.
- 0 - Error de Petición
- 1 - OK
- 2 - Error de Validación
- data -> Datos de la Cuenta y del Titular de la misma.
En caso de error (CBU/CVU), se agrega el campo:
- desc -> Descripción del error.
Comunicaciones
Sabemos que las comunicaciones permanentes con los usuarios son fundamentales para el correcto funcionamiento de los procesos. Hace años nuestra empresa es especialista en comunicaciones formales y fehacientes
asegurandole a nuestros clientes altas tasas de efectividad. Es por eso que ademàs de las opciones nativas de comunicaciones que traen nuestros sistemas, nuestros clientes pueden optar por consumir de forma independiente las siguientes APIS:
- Enviar Email EnvioCertificado:
EnvioCertificado es la solución propia de nuestro grupo para poder realizar envio de comunicaciones y que las mismas cuenten con certificación en la blockchain y certificación anti-spam.
Para mayor información puede consultar:
Ver EnvioCertificado.com
- Enviar Email con Respaldo Notarial:
ERN - Envío con Respaldo Notarial es la solución propia de nuestro grupo para poder realizar envio de comunicaciones con respaldo notarial y que las mismas cuenten con certificación en la blockchain y certificación anti-spam.
Para mayor información puede consultar:
Ver Web ERN
- Enviar SMS Número Corto:
Mediante esta API las empresas y comercios podrán realizar envios de SMS de número corto de doble via.
Para mayor información puede consultar:
Ver Detalles de la API
Validar Tarjetas
La validación de Tarjetas es la tecnología que permite a empresas y comercios con cumplimiento PCI DSS poder evaluar los datos ingresados antes de realizar una transacción de pago. A continuación se detallas algunas APIs complementarias para realizar dichas funcionalidades:
Validar Número BIN
El número BIN de tarjeta bancaria es el que se encuentra en las tarjetas de pago, en las tarjetas de crédito, en las tarjetas de débito, en las tarjetas de prepago, en las tarjetas de regalo y en otras tarjetas similares.
Los números de tarjetas bancarias se asignan de acuerdo con la norma ISO / IEC 7812.
El número de tarjeta bancaria se limita a identificar la tarjeta, que luego se asocia electrónicamente, a través de la organización emisora, con uno de sus clientes y luego con la cuenta bancaria del cliente.
La herramienta de Validación de Datos BIN de Tarjetas de Debito, Credito y Prepagas de la industria financiera es la solución informática para validar y normalizar dichos datos dentro de sus procesos.
El endpoint a utilizar es "api/v1/apipagos/core/extra/validate_card_bin", el mismo recibira por medio de GET la variable codseg y por medio del body un JSON con las siguientes variables:
- jwt -> Código generado con el endpoint /login.
- bin -> BIN a validar.
// Campos necesarios para la consulta de BIN
$jwt = "Token Generado con el endpoint /login";
$bin = "111103";
// Se prepara un array con los campos necesarios
$campos = [
"jwt" => $jwt,
"bin" => $bin
];
// Se crea un JSON mediante el array
$json = json_encode($campos);
// Iniciamos CURL
$url = "http://cont1-test1.certisend.com/web/container/api/v1/apipagos/core/extra/validate_card_bin?codseg=##CodigoDeSeguridad##";
$curl = curl_init($url);
curl_setopt_array($curl, [
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => $json,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ["Content-Type: application/json"]
]);
// Se obtiene la respuesta
$response = curl_exec($curl);
Una vez llamada correctamente la API, el sistema retornará una respuesta en JSON con las siguiente variables:
-
state -> Estado de la validación.
- 0 - Error
- 1 - OK
- data -> Información del BIN ingresado
En caso de error, se agrega el campo:
- desc -> Descripción del error.
Validar Tarjeta Simple:
También contamos con una herramienta para la validación de Números de Tarjeta.
El endpoint a utilizar es "api/v1/apipagos/core/extra/validate_card_number_simple", el mismo recibira por medio de GET la variable codseg y por medio del body un JSON con las siguientes variables:
- jwt -> Código generado con el endpoint /login.
- card -> Número de Tarjeta Cifrado mediante el método AES-256-CBC, utilizando como clave el apitoken de la empresa.
// Campos necesarios para la consulta de CBU/CVU
$jwt = "Token Generado con el endpoint /login";
$card = openssl_encrypt(##NumeroDeTarjeta##, "AES-256-CBC", ##ApiTokenDeEmpresa##);
// Se prepara un array con los campos necesarios
$campos = [
"jwt" => $jwt,
"card" => $card
];
// Se crea un JSON mediante el array
$json = json_encode($campos);
// Iniciamos CURL
$url = "http://cont1-test1.certisend.com/web/container/api/v1/apipagos/core/extra/validate_card_number_simple?codseg=##CodigoDeSeguridad##";
$curl = curl_init($url);
curl_setopt_array($curl, [
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => $json,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ["Content-Type: application/json"]
]);
// Se obtiene la respuesta
$response = curl_exec($curl);
Una vez llamada correctamente la API, el sistema retornará una respuesta en JSON con las siguiente variables:
-
state -> Estado de la validación.
- 0 - Error
- 1 - OK
- number -> Últimos 4 numeros de la tarjeta enviada.
- desc -> Descripción de la Respuesta.
- timestamp -> Fecha y Hora.
Validar Tarjeta Identidad:
El proceso de validaciòn de tarjeta de identidad permite validar la identidad de una persona contra las tarjetas de crédito activas para dicha persona.
Atención
Tarjetas VISA: Todas
Tarjetas AMEX: Bancos: Santander, Galicia, Macro, Patagonia, Bapro, HSBC, Galicia Naranja, Transatlántica Cía Financiera.
Tarjetas MASTER: Bancos: Santander, Macro, Del Tucumán, BSF Carrefour, Transatlántica Cía Financiera, BANCOR
El endpoint a utilizar es "api/v1/apipagos/core/extra/validate_card_identity", el mismo recibira por medio de GET la variable codseg y por medio del body un JSON con las siguientes variables:
- jwt -> Código generado con el endpoint /login.
- card -> Número de Tarjeta Cifrado mediante el método AES-256-CBC, utilizando como clave el apitoken de la empresa.
- doc -> Número de Documento o CUIT del titular de la tarjeta, Cifrado mediante el método AES-256-CBC, utilizando como clave el apitoken de la empresa.
- gender -> Genero de la Persona "M" / "F".
// Campos necesarios para la consulta de CBU/CVU
$jwt = "Token Generado con el endpoint /login";
$card = openssl_encrypt(##NumeroDeTarjeta##, "AES-256-CBC", ##ApiTokenDeEmpresa##);
$doc = openssl_encrypt(##NumeroDeDocumento##, "AES-256-CBC", ##ApiTokenDeEmpresa##);
$gender = "M";
// Se prepara un array con los campos necesarios
$campos = [
"jwt" => $jwt,
"card" => $card,
"doc" => $doc,
"gender" => $gender
];
// Se crea un JSON mediante el array
$json = json_encode($campos);
// Iniciamos CURL
$url = "http://cont1-test1.certisend.com/web/container/api/v1/apipagos/core/extra/validate_card_identity?codseg=##CodigoDeSeguridad##";
$curl = curl_init($url);
curl_setopt_array($curl, [
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => $json,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ["Content-Type: application/json"]
]);
// Se obtiene la respuesta
$response = curl_exec($curl);
Una vez llamada correctamente la API, el sistema retornará una respuesta en JSON con las siguiente variables:
-
state -> Estado de la validación.
- 0 - Error Interno
- 1 - OK Validado
- 2 - Error de Validación
- number -> Últimos 4 numeros de la tarjeta enviada.
- desc -> Descripción de la Respuesta.
- timestamp -> Fecha y Hora.
Validar Email
La herramienta de Validación de Emails es la solución informática para validar direcciones de correo electrónico de forma simple y segura.
Años de trayectoria brindando soluciones al mundo empresarial y financiero, nos han permitido detectar la gran cantidad de correos erróneos, listas con spamtrap, errores de sintaxis, Emails desactualizados que perjudican la reputación del remitente. Direcciones imposibles de entregar y dañinas que pueden provocar bloqueos y la introducción en listas negras por los ISP / ESP.
Muchos de estos correos son recolectados de diferentes canales, para incluirlos en comunicaciones o acciones electrónicas comerciales, si el correo falla entonces la comunicación con el destinatario fallará también.
Gracias a las siguientes herramientas, las empresas / comercios podran garantizar la correcta validación de los emails de sus usuarios / clientes:
- Validar Email Simple:
Permite Validar la sintaxis de una cuenta de email, su dominio y si tiene un servidor de email asociado.
Para mayor información puede consultar:
Ver Detalles de la API
- Validar Email GOLD:
Permite Validar la sintaxis de una cuenta de email, su dominio, si tiene un servidor de email asociado y si la cuenta de correo existe.
Para mayor información puede consultar:
Ver Detalles de la API
- Validar Dominio Disponable:
Una Dirección Electrónica Desechable (DED, en inglés DEA - Disposable email addressing) es una forma de gestionar el correo en la que se utiliza una dirección de correo electrónico única para cada contacto o cada entidad con la que uno se quiere comunicar. Tiene como ventaja que si alguien empieza a abusar de esta dirección de correo electrónico, o se ve comprometida, el propietario de la dirección puede cancelarla (o "desecharla") sin afectar a ninguno de sus otros contactos.
Es un servicio que permite recibir correos electrónicos en una dirección temporal que se autodestruye luego de que transcurra cierto tiempo. También es conocido por nombres como: tempmail, 10minutemail, correo electrónico desechable, correo falso o correo basura. Muchos foros, propietarios de Wi-Fi, sitios web y blogs solicitan a los visitantes que se registren antes de que puedan ver el contenido, publicar comentarios o descargar algo. Temp-Mail - es el servicio de correo electrónico desechable más avanzado que le ayuda a evitar el correo no deseado y a mantenerse a salvo.
Comunmente cuando los sitios o procesos de las compañías solicitan un email valido, los usuarios que conocen de la existencia de los emails desechables hacen uso de ellos para registrarse. El inconveniente se da en que a la compañía le queda un email desechable y al cual no podra contactar al propietario en el futuro.
Gracias a esta API las empresas y comercios podran identificar cuando los usuarios / clientes intenten dejar un email temporal.
Para mayor información puede consultar:
Ver Detalles de la API
- Validar Email Hackeado:
Mediante esta API las empresas y comercios podrán confirmar si una dirección de email y sus contraseñas de uso han sido difundidas publicamente debido a vulnerabilidades de seguridad de determinados proveedores de sitios en internet.
Reconocida dicha vulnerabilidad, se pueden contemplar procesos de comprobaciones adicionales con el fin de aumentar la seguridad del proceso.
Para mayor información puede consultar:
Ver Detalles de la API
Validar Teléfono
La herramienta de Validación de teléfonos es la solución informática para validar y normalizar números de teléfonos ya sean fijos o móviles, nacionales o internacionales de forma simple y segura.
Años de trayectoria brindando soluciones al mundo empresarial y financiero, nos han permitido detectar la gran cantidad de teléfonos erróneos y sin normalizar que perjudican la comunicación con el destinatario. Destinos imposibles de contactar y dañinos que pueden provocar bloqueos y la introducción en listas negras por los proveedores de comunicaciones.
Muchos de estos teléfonos son recolectados de diferentes canales, para incluirlos en comunicaciones o acciones electrónicas comerciales, si el número falla entonces la comunicación con el destinatario fallará también.
Mediante las siguientes APIs las empresas y comercios podran realizar las siguientes validaciones:
- Validar Teléfono Simple:
Mediante esta API las empresas y comercios podrán validar de forma simple un domicilio obteniendo:
- Validación de sintaxis del Teléfono: Se validan la cantidad de dígitos, se asigna país de defecto y área predeterminada.
- Normalización del número: Se estandariza el número de teléfono separando País, Área, Número.
- Se consulta línea asignada mediante datos oficiales ENACOM.
- Se asigna Descripción de Área Geográfica.
Ver Detalles de la API
- Validar Teléfono GOLD: Mediante esta API las empresas y comercios podrán validar de forma completa un domicilio obteniendo:
- Validación de sintaxis del Teléfono: Se validan la cantidad de dígitos, se asigna país de defecto y área predeterminada.
- Normalización del número: Se estandariza el número de teléfono separando País, Área, Número.
- Se consulta línea asignada mediante datos oficiales ENACOM.
- Se asigna Descripción de Área Geográfica.
Ver Detalles de la API
- Obtener Domicilio de Teléfono: Mediante esta API las empresas y comercios podrán obtener un domicilio teniendo como origen un número de telefono fijo.
Esta información es consultada en bases de datos públicas de guías telefónicas abiertas. Para mayor información puede consultar:
Ver Detalles de la API
Validar Domicilios
La herramienta de Validación de direcciones es la solución informática para validar y normalizar las direcciones ingresadas.
Años de trayectoria brindando soluciones al mundo empresarial y financiero, nos han permitido detectar una problemática a la hora de las direcciones almacenadas de los clientes quedando el dato sin normalizar y que perjudican la comunicación con el destinatario o la sectorización de acuerdo a su región para una mejor atención.
Gracias a esta herramienta podrá validar la dirección ingresada y obtener datos adicionales como el barrio, el código postal, las diferentes normalizaciones de la dirección, latitud y longitud, etc.
Para mayor información puede consultar:
Ver Detalles de la API
2FA SMS
El servicio de SMS_Code o comunmente llamado como Autenticación de dos factores (2FA) via SMS es un servicio que originalmente nació para poder lograr incrementar la seguridad de autenticación de un usuario y/o validar la identidad de una persona.
Dicho servicio permite generar un código random númerico / alfanuerico de varios dígitos y enviarselo por un servicio premium de SMS de número corto a un dispositivo móvil.
Ventajas:
- Envio de SMS mediante SMS Premium de Número Corto con tiempos de entrega inmediatos y seguridad en el despacho.
- No se necesitan tókenes adicionales puesto que utiliza los dispositivos móviles que se portan en todo momento.
- Puesto que se cambian continuamente, los códigos generados dinámicamente son más seguros de utilizar que la información de autenticación fija o estática.
- Dependiendo de la solución, los códigos que se han utilizados son reemplazados para asegurarse de que siempre hay un código válido disponible. Por lo tanto, los problemas de transmisión o recepción no son un impedimento para la autenticación del usuario.
- La opción de especificar un número máximo de intentos fallidos reduce el riesgo de que haya ataques de personas no autorizadas.
- Fácil de configurar y de fácil uso.
Aplicaciones:
- Validar y comprobar el celular de la persona que se esta registrando.
- Incrementar la seguridad de un sistema de control de accesos.
- Simplificar el login a sistemas seguros mediante contraseña de un solo uso (OTP)
Para mayor información puede consultar:
Ver Detalles de la API
Scoring Crediticio
El scoring crediticio es un sistema informático que es utilizado por empresas y comercios para aprobar o denegar productos o servicios, es decir, es un analista de riesgos. En numerosos casos según la puntuación o la valoración que proporcione este método será concluyente a la hora de que el crédito o préstamo en cuestión sea concedido por el Banco o no.
Si bien CuentaVirtual y su Alianza con ApiLanding no son generadores propios de scoring crediticio, se mantienen alianzas e integraciones con las siguientes empresas para la evaluaciòn de datos comerciales:
- Fidelitas.
- Nosis.
- Riesgo Online
Riesgo IP
A menudo las empresas y negocios tienen que exponer en internet formularios, servicios y productos que interactuen con sus procesos productivos.
Es por eso que existen diferentes metodologías adicionales para securizar las transacciones. A continuación se detallan las APIs disponibles para hacer más seguros sus procesos.
- IP Blacklist:
Mediante esta API las empresas y comercios podrán detectar si el origen desde el cual estan recibiendo la petición en sus servidores es un origen con reputación de conductas sospechosas.
Para mayor información puede consultar:
Ver Detalles de la API
- Detectar Proxy:
A menudo las transacciones fraudulentas se esconden atrás de un proxy de navegación. Mediante esta API las empresas y comercios podrán detectar si el origen desde el cual estan recibiendo la petición esta cursandose desde un proxy de navegación público o vulnerado.
Para mayor información puede consultar:
Ver Detalles de la API
- Info IP:
Mediante esta API las empresas y comercios podrán obtener información detallada de la IP desde la cual estan recibiendo la peticiones a sus servicios con el fin de tomar desiciones inteligentes de filtrado.
Para mayor información puede consultar:
Ver Detalles de la API
PLD
Una alianza con la empresa Worldsys SA permite no solo hacer un exaustivo cumplimiento de las normativas sobre Prevención del Lavado del Dinero sino que tambien podemos brindarles a nuestros clientes tecnología de punta para dichos controles
Para mayor información puede consultar:Ver Web Worldsys S.A.