Bienvenido a nuestro portal API
Donde encontrarás soluciones tecnológicas
para potenciar al máximo tu negocio.
En este paso registrarás tu aplicación, sistema, página web o tienda virtual.
Aquí encontrarás todos los productos API's disponibles
Es un servicio de recaudación electrónica que permite realizar la cobranza de servicios y/o productos por Internet de manera rápida y segura, empleando las Tarjetas de Crédito Diners Club, Visa o MasterCard de cualquier banco emisor Nacional o Internacional, o Tarjeta de Débito Mercantil, con la inclusión de un punto de venta en la tienda virtual de la página web o en el APP.
Beneficios
Oportunidad de desarrollo de aplicaciones que interactúen con nuestras APIs, mediante un proceso de integración e implementación ágil.
Garantiza una entrega de información fluida y una experiencia de usuario integrada.
Genera nuevas oportunidades de negocios.
Mejora la experiencia de tus clientes.
Aumenta la rentabilidad de tu emprendimiento o empresa.
Fácil implementación con los esquemas de Open Banking (API).
Plataforma estable y segura.
Reducción de tiempos y costos.
Oportunidad de venta las 24 horas, los 365 días.
Información General
El API de Pago con Tarjeta de Débito contempla dos APIs: 1) Autenticación del cliente; 2) Transacción financiera o pago. Para ejecutar pruebas debe seguir los siguientes pasos:
1. Ejecute el API Autenticación para Pagos con Tarjeta de Débito (getauth). Este API le informa el modelo de autenticación que Mercantil Banco tiene disponible para sus clientes. Actualmente el modelo de autenticación es Otp (One Time Password) / Clave Temporal. El API valida la petición y si todo está correcto, envía al cliente la Clave Temporal (otp) vía SMS y/o email.
2. Ejecute el API Pago con Tarjeta de Débito (pay), con los datos financieros que se requieren del cliente pagador como son:
Clave Temporal (otp)
Código de Identificación de cliente (ClientID): Para poder usar cualquiera de los APIs es importante tener un código de identificación de cliente (ClientID).
Descripción de Atributos o Campos
Tipos de errores
Para ver el listado de errores adicional puede descargar en el siguiente texto: Lista de errores
Ejemplos Getauth
Visite nuestro repositorio de ejemplos haciendo clic en el siguiente texto: Github Mercantil
Ejemplos Pago (Pay)
Los requisitos aplican para todos los API’s
Requisitos
Ser cliente de Mercantil C.A. Banco Universal.
Estar afiliado a Mercantil en Línea Empresas.
Contar con una aplicación o sitio web de tu negocio.
Es un nuevo servicio de recaudación electrónica, que permite a tu empresa solicitar pagos de manera inmediata con el servicio de pago móvil interbancario a través de un número celular, para que tus clientes puedan adquirir sus bienes y/o servicios de forma rápida, fácil y sencilla.
Botón de Vuelto
El Botón de Vuelto con Pagos móviles (API de Vuelto), permite a los comercios dar el vuelto a sus clientes, de manera digital, por compras realizadas, garantizando la disponibilidad de los fondos de los clientes de manera inmediata con el servicio de pago móvil interbancario, a través de un número celular de forma rápida, fácil y sencilla, mejorando sus procesos internos.
Beneficios
Servicio disponible en Bolívares.
Límite de montos adaptado a las necesidades del mercado y según la normativa de Sudeban.
Permite el pago con cuentas de cualquier banco afiliados a la RED interbancaria.
Operación inmediata y en línea impulsada por el comercio.
Condiciones
El recaudador (Empresa) debe estar afiliado al sistema de Pago Móvil Interbancario.
La empresa debe ser cliente Mercantil, afiliarse al Servicios de C2P y desarrollar la API Pagos Móviles C2P.
Contar con una aplicación o sitio web de su negocio.
Información General
Código de Identificación de cliente (ClientID): Para poder usar cualquiera de los API es importante tener un có digo de identificación de cliente (ClientID).
Para el ambiente de certificación el código de cliente (ClientID) le será enviado por comunicación directa por Mercantil Banco vía email con el resto de las condiciones para realizar las pruebas de certificación, una vez haya creado su Cuenta de Usuario, su Aplicación y suscrito el Plan.
El modelo de cifrado es AES/ECB/PKSC S5Padding
Descripción de Atributos o Campos
Tipos de errores
Para ver el listado de errores adicional puede descargar en el siguiente texto: Lista de errores
Ejemplos Pago (C2P)
Ejemplos Vuelto (P2P)
Los requisitos aplican para todos los API’s
Requisitos
Ser cliente de Mercantil C.A. Banco Universal.
Estar afiliado a Mercantil en Línea Empresas.
Contar con una aplicación o sitio web de tu negocio.
Permite a las personas Jurídicas enviar archivos para Pagos a Proveedores y Pagos de Nómina multimoneda, así como Domiciliaciones en Bolívares desde la comodidad de tu plataforma administrativa y recibir respuesta del resultado de los archivos enviados de forma segura, rápida, precisa, confiable y sencilla.
Beneficios
Fácil implementación con los esquemas de Open Banking (API).
Integración directa con el Banco.
Manejo de esquemas de seguridad.
Función automatizada que permite que los datos se compartan rápidamente.
Intercambio de datos bajo Formato estándares.
Servicio Multimoneda*.
Ahorro en costos y mejora en la eficiencia.
Permite el pago con cuentas de cualquier Banco.
Límite de montos adaptado a las necesidades del mercado y según la normativa de Sudeban.
Recepción de archivos de movimientos de las cuentas afiliadas.
Condiciones
Información General
Con las APIs de TED se pueden realizar las siguientes funciones:
Especificaciones para la implementación y consumo de las APIs para la Transmisión Electrónica de Datos.
Para implementar las APIs para la Transmisión Electrónica de Datos (TED), usted debe previamente cumplir con algunos pre-requisitos.
Pre-requisitos:
Código de Identificación de cliente (ClientID):
Para poder utilizar cualquiera de las APIs, primero debe contar con un código de identificación del cliente o ClientID, el cual es generado para el ambiente de producción desde el portal de API de Mercantil Banco luego de que el usuario esté registrado y sea aprobada la suscripción y las aplicaciones para el ambiente de certificación. El código de identificación del cliente será enviado por comunicación directa desde Mercantil Banco vía email con el resto de las condiciones para realizar sus pruebas de certificación . La identificación del cliente o ClientID es parte de una cabecera/header del protocolo HTTP. En la información del ambiente de certificación se le enviará identificado como: X-IBM-Client- Id
Para obtener mayor información sobre el Protocolo HTTP sugerimos consultar la siguiente dirección: Protocolo HTTP
Disponer del código de comercio o MerchantID. Éste será enviado por comunicación directa desde Mercantil Banco vía email con el resto de las condiciones para realizar sus pruebas de certificación. El código de comercio o MerchantID es utilizado en todos los métodos en el campo <ID_SOCIO>.
El cifrado es de suma importancia. El algoritmo de cifrado es AES, el cifrado para los APIs tiene las siguientes características:
Los datos o atributos que se deben cifrar y que retornarán cifrados por las APIs son:
Método carga de archivo (cargar-archivo):
Método descarga de archivo (descargar-archivo):
Método lista de buzones (listar-buzon):
Método lista de lotes (listar-lote):
Descripción de Atributos o Campos
Servicio Carga de Archivo
Envío de orden de Pago a Proveedores, Pago de Nómina, Cobranza en Cuentas o Cobranza Tarjetas de Crédito.
API v1/ted/cargar-archivo
MÉTODO HTTP
INFORMACIÓN DEL RECURSO
Requiere Autenticación: NO
Para descargar la descripción de los campos pulse el siguiente texto: Atributos o Campos
Ejemplo request API cargar-archivo
Especificaciones:
Campo "CONTENIDO_ARCHIVO"
Pasos para cifrar y comprimir el archivo:
1. Cifrar el archivo a enviar con AES utilizando la llave secreta suministrada por Mercantil Banco
2. Comprimir el archivo cifrado en formato 7z
3. Extraer el contenido del archivo en formato 7z y codificar en Base64
4. Eliminar line feed y carriage return de la trama en Base64 antes de colocarla en el tag "CONTENIDO_ARCHIVO".
Ejemplo response API cargar-archivo
Servicio Descarga de Archivo
Descargar respuesta de orden de Pago a Proveedores, Nómina, Cobranza en Cuentas, o Cobranza Tarjetas de Crédito. Archivos tipo orden: paymbu, debmbu, resmbu, movmbu.
API v1/ted/descargar-archivo
MÉTODO HTTP
INFORMACIÓN DEL RECURSO
Requiere Autenticación: NO
Para descargar la descripción de los campos pulse el siguiente texto: Atributos o Campos
Ejemplo request API descargar-archivo
Ejemplo response API descargar-archivo
Especificaciones:
Campo "CONTENIDO_ARCHIVO"
Pasos para descomprimir y descifrar el archivo:
1. Decodificar la trama en Base64
2. Guardar los bytes en archivo local tipo 7z. Ejemplo: ArchivoComprimido.7z
3. Descomprimir el archivo formato 7z. Ejemplo nombre archivo destino: ArchivoCifrado.cif
4. Descifrar el archivo con AES. Ejemplo: ArchivoCifrado.cif
Servicio Listar Buzón
Consultar buzones asignados al socio comercial. Tipos de buzón: entrada, salida.
API v1/ted/listar-buzon
MÉTODO HTTP
INFORMACIÓN DEL RECURSO
Requiere Autenticación: NO
Para descargar la descripción de los campos pulse el siguiente texto: Atributos o Campos
Ejemplo request API listar-buzon
Ejemplo response API listar-buzon
Servicio Listar Lotes
Consultar buzones asignados al socio comercial. Tipos de buzón: entrada, salida.
API v1/ted/listar-lote
MÉTODO HTTP
INFORMACIÓN DEL RECURSO
Requiere Autenticación: NO
Para descargar la descripción de los campos pulse el siguiente texto: Atributos o Campos
Ejemplo request API listar-lote por Número de Lote
Ejemplo response API listar-lote por Número de Lote
Importante:
La consulta de lotes se puede realizar por número de lote o por rango de fechas desde/hasta. Si en la consulta se llenan todos los campos, la consulta se realizará por número de lote.
Ejemplo request API listar-lote por Rango de Fechas
Ejemplo response API listar-lote por Rango de Fechas
Descripción de los campos:
Tipos de errores
Los requisitos aplican para todos los API’s
Requisitos
Ser cliente de Mercantil C.A. Banco Universal.
Estar afiliado a Mercantil en Línea Empresas.
Contar con una aplicación o sitio web de tu negocio.
