Escoge el producto API y suscribe tu plan

0
No votes yet

Botón de Pagos Móviles (C2P) y Vuelto (1.0.1)(1 API included)

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.

    • 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
  • Algoritmo de Cifrado: El Algoritmo de Cifrado para los API tiene las siguientes características:
  • El modelo de cifrado es AES/ECB/PKSC S5Padding

    • El valor en la propiedad del mensaje JSON debe estar en Base64/UTF8
    • La clave secreta o secretkey es única por código de comercio. Esta información le 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

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.

0
No votes yet

Búsquedas de Pagos con Tarjetas (1.0.0)(2 APIs included)

API que le permite a tu empresa realizar búsquedas de todas las transacciones realizadas con Tarjetas de crédito y/o débito de forma fácil y rápida. Lo cual permite tener un mejor proceso de conciliación en el momento que lo requieras.

Beneficios

  • Fácil implementación con los esquemas de Open Banking (API).

  • Facilita la conciliación de las transacciones de Pagos con tarjetas.

  • Verifica y ubica fácil y rápidamente transacciones.

Características

  • Permite ubicar transacciones por diferentes criterios de búsqueda.

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.
  • 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
  • El API de Búsquedas de Transacciones contiene 5 criterios de búsqueda:

1. All: El criterio all obtiene todas las transacciones para el comercio indicado en la fecha indicada.

2. Lastfive: El criterio lastfive obtiene las ultimas 5 transacciones para el comercio indicado en la fecha indicada.

3. Lastten: El criterio lastten obtiene las ultimas 10 transacciones para el comercio indicado en la fecha indicada.

4. Last: El criterio last obtiene la última transacción para el comercio indicado en la fecha indicada.

5. Unique: El criterio de búsqueda unique sirve para obtener una transacción en especifica agregando dos filtros adicionales de búsqueda que son la referencia de pago (payment_reference) y el número de factura (invoice_number). Se puede utilizar ambos filtros o solo uno de ellos.

Visite nuestro repositorio de ejemplos haciendo clic en el siguiente texto: Github Mercantil

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.

0
No votes yet

Solicitud de Clave de Pago (1.0.0)(1 API included)

Esta API le permite a tu Empresa colocar un botón dentro de tu Web o App para que los clientes Mercantil soliciten la clave de Pago de Móvil, sin tener que salir de la aplicación y el Pagador recibe la clave en su (celular) o móvil registrado en Mercantil, para confirmar el pago.

Beneficios

  • Fácil implementación con los esquemas de Open Banking (API).

  • Facilitar al Pagador la obtención de la clave de pago, ya que lo hace directamente desde su Web o App.

  • Brinda mayor seguridad. El Pagador va a pedir la clave en el momento de realizar el pago.

  • Es compatible con cualquier teléfono celular que permita recibir SMS, sin importar la operadora telefónica a la que se encuentre afiliado el servicio dentro del territorio nacional.

  • Validación rápida del pago efectuado a los clientes por Pago Móvil C2P.

Características

  • Clave de un solo uso.

  • Duración de 6 horas.

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.

    • 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
  • Algoritmo de Cifrado: El Algoritmo de Cifrado para los API tiene las siguientes características:

    • El modelo de cifrado es AES/ECB/PKSC S5Padding
    • El valor en la propiedad del mensaje JSON debe estar en Base64/UTF8
    • La clave secreta o secretkey es única por código de comercio. Esta información le 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

Descripción de Atributos o Campos

  • Para descargar la descripción de los campos pulse el siguiente texto: Atributos o Campos

Tipos de errores

Ejemplos Solicitud Clave Pago C2P (mobile-payment/scp)

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.

0
No votes yet

Búsquedas de Pagos Móviles (1.0.0)(1 API included)

Le permite a tu empresa realizar búsquedas de todas las transacciones de Pagos móviles procesadas por Tpago (C2P, P2C o Vuelto), de forma fácil y rápida. Con ello podrás realizar tu proceso de conciliación y verificación en el momento que lo requieras.

Beneficios

  • Fácil implementación con los esquemas de Open Banking (API).

  • Facilita la conciliación de las transacciones de Pagos Móviles Tpago.

  • Verifica y ubica fácil y rápidamente transacciones de cualquier Tpago.

Características

  • Permite ubicar transacciones por diferentes criterios de búsqueda.

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

  • Algoritmo de Cifrado: El Algoritmo de Cifrado para los API tiene las siguientes características:

    • El modelo de cifrado es AES/ECB/PKSC S5Padding
    • El valor en la propiedad del mensaje JSON debe estar en Base64/UTF8
    • La clave secreta o secretkey es única por código de comercio. Esta información le 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

Descripción de Atributos o Campos

  • Para descargar la descripción de los campos pulse el siguiente texto: Atributos o Campos

Tipos de errores

Ejemplos Búsquedas Móviles (mobile-payment/search)

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.

0
No votes yet

Transmisión Electrónica de Datos (1.0.0)(4 APIs included)

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.

0
No votes yet

Botón de Pagos con Tarjetas (1.0.0)(2 APIs included)

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 y 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 contiene dos API: 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 tarjeta de débito (getauth). Este API le informa el modelo de autenticación que Mercantil va a utilizar para los clientes (posibles valores retornados clavetelefónica, claveinternet, otp). Actualmente se utiliza la Clave Telefónica. 2. Ejecute el API Pago con Tarjeta de Débito (pay), con los datos financieros que se requieren del cliente pagador como son:

  • Número de Tarjeta de Débito
  • CVV
  • Fecha de Vencimiento
  • Cédula de Identidad
  • Valor del autenticador

  • 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.
    • 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
  • Algoritmo de Cifrado: El Algoritmo de Cifrado para los API tiene las siguientes características:
  • El modelo de cifrado es AES/ECB/PKSC S5Padding
    • El valor en la propiedad del mensaje JSON debe estar en Base64/UTF8
    • La clave secreta o secretkey es única por código de comercio. Esta información le 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

Descripción de Atributos o Campos

  • Para descargar la descripción de los campos pulse el siguiente texto: Atributos o Campos

Tipos de errores

Para ver el listado de errores adicional puede descargar en el siguiente texto: Lista de errores

Ejemplos Getauth

  • Paso 1: Solicitar modelo de autenticación a ser utilizado con el API

Visite nuestro repositorio de ejemplos haciendo clic en el siguiente texto: Github Mercantil

Ejemplos Pago (Pay)

  • Paso 2: Solicitar pago con tarjeta de débito API.

  • Detalle solicitud pago con tarjeta de débito API.

  • Ejemplos de mensaje json de pago TDD en móvil/web

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.