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

• Afiliación a los Productos y Servicios de Pago de Proveedores, Pago de Nómina y Domiciliación.

Información General

Con las APIs de TED se pueden realizar las siguientes funciones:

• Carga de Archivo
• Descarga de Archivo
• Lista de Buzones
• Lista de Lotes

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:

  • El modelo de cifrado es AES/ECB/PKSC S5Padding
  • El valor en la propiedad del mensaje debe estar en Base64/UTF8
  • La clave secreta o secretkey es una por código de comercio. Esta información será suministrada por el banco tanto en los ambientes de certificación como de producción
  • La clave secreta entregada por el banco debe convertirla a SHA-256 y se debe tomar los primeros 16 bytes para cifrar
  • Revisar los ejemplos para cifrado en la siguiente dirección: Github Mercantil
  • Para obtener mayor información sobre Algoritmo de Cifrado sugerimos consultar la siguiente dirección: Cifrado AES

Los datos o atributos que se deben cifrar y que retornarán cifrados por las APIs son:

Método carga de archivo (cargar-archivo):

• Request = CONTENIDO_ARCHIVO, NOMBRE_ARCHIVO, TIPO_ARCHIVO, CODIGO_ARCHIVO
• Response = NUMERO_LOTE

Método descarga de archivo (descargar-archivo):

• Request = CLAVE_ENTRADA, CARPETA_ARCHIVO
• Response = CONTENIDO_ARCHIVO, NOMBRE_ARCHIVO, TIPO_ARCHIVO, CODIGO_ARCHIVO

Método lista de buzones (listar-buzon):

• Request = TIPO_BUZON
• Response = Ninguno

Método lista de lotes (listar-lote):

• Request = NUMERO_LOTE, FECHA_DESDE, FECHA_HASTA
• Response = NUMERO_LOTE, ESTADO_LOTE, TIPO_ORDEN

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

• POST

INFORMACIÓN DEL RECURSO

• Formato de Respuesta: SOAP

• 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

• POST

INFORMACIÓN DEL RECURSO

• Formato de Respuesta: SOAP

• 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

• POST

INFORMACIÓN DEL RECURSO

• Formato de Respuesta: SOAP

• 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

• POST

INFORMACIÓN DEL RECURSO

• Formato de Respuesta: SOAP

• 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:

• Para descargar la descripción de los campos pulse uno de los siguientes textos: Header de Entrada

Header de Salida

Tipos de errores

• Para descargar los tipos de errores pulse el siguiente texto: 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.