API Products

5
Average: 5 (1 vote)

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

El API le permite realizar la solicitud de la Clave de Pago de C2P a tus clientes Mercantil, desde la Web o App de tu empresa, facilitando la transacción al cliente pagador el cual recibirá la clave de pago en su móvil afiliado a Tpago. La clave de pago es requerida para concluir la transacción.

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) "

0
No votes yet

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

El API le permite 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.

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) "

4
Average: 4 (3 votes)

Transferencia Electrónica de Datos (1.0.0)(4 APIs included)

Las APIs de TED le permiten a una empresa o socio comercial Mercantil, transmitir de forma automatizada datos estructurados con la finalidad de realizar en Mercantil Banco sus órdenes de Pago a Proveedores, Pagos de Nómina, Cobranza en Cuentas y Cobranza en Tarjetas de Crédito.

Información General

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

  • Carga de Archivov
  • 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 prerrequisitos.

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

PARÁMETROS DE MENSAJERIA

Ejemplo request API cargar-archivo

PARÁMETROS DEL REQUEST CARGAR_ARCHIVO
Campo Descripcion Requerido Cifrado
HEADER_ENTRADA Encabezado común para los formatos tipo SOAP. Si No
ID_SOCIO Identificador del Socio Comercial en TED.Si No
CLAVE_ENTRADA Password del Socio Comercial. No No
CONTENIDO_ARCHIVO Contenido del archivo a cargar en TED. Si Si
NOMBRE_ARCHIVO Nombre del archivo a cargar en TED. Si Si
TIPO_ARCHIVO Tipo de archivo a cargar en TED. Posibles valores: Pago de Proveedores/Nómina, el valor es: paymbu Cobranzas, el valor es: debmbu Si Si
CODIGO_ARCHIVO Huella SHA-256 del archivo a cargar en TED. Si Si
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".

PARÁMETROS DEL RESPONSE CARGAR_ARCHIVO
Campo Descripcion Requerido Cifrado
HEADER_SALIDA Encabezado común para los formatos tipo SOAP. Si No
NUMERO_LOTE Número con el cual TED identifica el lote recibido. Se puede utilizar posteriormente en el método LISTAR_LOTE para consultar el estatus del lote.Si Si

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
PARÁMETROS DEL REQUEST DESCARGAR_ARCHIVO
Campo Descripcion Requerido Cifrado
HEADER_ENTRADA Encabezado común para los formatos tipo SOAP. Si No
ID_SOCIO Identificador del Socio Comercial en TED. Si No
CLAVE_ENTRADA Número de lote a descargar. Este número se obtiene con la API Listar Lote, campo “ESTADO_LOTE”. El lote debe estar en estado “RESPUESTA DISPONIBLE” o “RESPUESTA DESCARGADA DESDE TED”. Si Si
CARPETA_ARCHIVO Carpeta de salida donde se encuentra el archivo a descargar. La carpeta se puede obtener con el API LISTAR_LOTE, campo TIPO_ORDEN. Los posibles valores son: debmbu, paymbu, resmbu, movmbu. Si Si

Ejemplo request API descargar-archivo

PARÁMETROS DEL RESPONSE DESCARGAR_ARCHIVO
Campo Descripcion Requerido Cifrado
HEADER_SALIDA Encabezado común para los formatos tipo SOAP. Si No
CONTENIDO_ARCHIVO Contiene la trama completa del archivo que se está descargando. Se debe guardar en un archivo y aplicar el proceso correspondiente para llevarlo a formato ASCII. No Si
NOMBRE_ARCHIVO Nombre del archivo descargado desde TED. Si Si
TIPO_ARCHIVO Extensión del archivo descargado desde TED. Si Si
MAS_ARCHIVOS Indicador de existencia de otro archivo por descargar. Posibles valores: 0 = No hay más archivos disponibles para descargar; 1 = Existe por lo menos un archivo más disponible para descargar. Si No
CODIGO_ARCHIVO Huella SHA256 del archivo descargado desde TED. Se recomienda utilizar para validar la integridad del archivo descargado. Si Si

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

PARÁMETROS DE MENSAJERIA

PARÁMETROS DEL REQUEST LISTAR_BUZON
Campo Descripcion Requerido Cifrado
HEADER_ENTRADA Encabezado común para los formatos tipo SOAP. Si No
ID_SOCIO Identificador del Socio Comercial en TED. Si No
CLAVE_ENTRADA Password del Socio Comercial. No No
TIPO_BUZON Tipo de buzón. Posibles valores: entrada, salida. Si Si

Ejemplo request API listar-buzon

PARÁMETROS DE MENSAJERIA

PARÁMETROS DEL RESPONSE LISTAR_BUZON
Campo Descripcion Requerido Cifrado
HEADER_SALIDA Encabezado común para los formatos tipo SOAP. Si No
LISTA_BUZON Lista buzones asociadas al Socio Comercial. Posibles valores: debmbu, paymbu, resmbu, movmbu. Si No

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

PARÁMETROS DE MENSAJERIA

PARÁMETROS DEL REQUEST LISTAR_LOTE
Campo Descripcion Requerido Cifrado
HEADER_ENTRADA Encabezado común para los formatos tipo SOAP. Si No
ID_SOCIO Identificador del Socio Comercial en TED.Si No
CLAVE_ENTRADA Password del Socio Comercial.No No
NUMERO_LOTE Número con el cual TED identificó el lote recibido con la API Cargar Archivo.Si Si
FECHA_DESDE Fecha inicial de búsqueda. Formato (AAAAMMDD).Si Si
FECHA_HASTA Fecha final de búsqueda. Formato (AAAAMMDD).Si Si

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 Número de Lote

PARÁMETROS DEL RESPONSE LISTAR_LOTE
Campo Descripcion Requerido Cifrado
HEADER_SALIDA Encabezado común para los formatos tipo SOAP.Si No
LOTEs Lista de lotes. Objeto Anidado Si No
LOTE.NUMERO_LOTE Número que el sistema le asignó al lote en la carga. Si Si
LOTE.FECHA_CREACION Fecha en que se creó el lote en el sistema. Formato (AAAA-MM-DD). Si No
LOTE.HORA_CREACION Hora en que se creó el lote en el sistema. Formato (HH:MM:SS). Si No
LOTE.FECHA_ULT_MODIF Fecha en que el lote cambió de estado. Formato (AAAA-MM-DD). Si No
LOTE. HORA_ULT_MODIF Hora en que el lote cambió de estado. Formato (HH:MM:SS). Si No
LOTE.ESTADO_LOTE Estado actual del lote en el sistema. Posibles valores: NUEVO, RECIBIDO, RECHAZADO, RESPUESTA DISPONIBLE, RESPUESTA DESCARGADA DESDE TED . SiSi
LOTE.TIPO_ORDEN Indica si el archivo es de Pago de Proveedores/Nómina, Cobranza. Posibles valores: debmbu, paymbu, resmbu, movmbu. SiSi

Ejemplo response API listar-lote 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:

Header de Entrada
Campo Descripcion
IDENTIFICADOR_UNICO_GLOBAL Identificador único generado por CLIENTE. Debe enviar una constante con el valor “TED”.
IDENTIFICACION_CANAL Identificación del canal correspondiente a la transacción, Debe enviar una constante con el valor “06”.
SIGLA_APLICACION Debe enviar una constante con el valor “TED”.
IDENTIFICACION_USUARIO Identificador del usuario. Código de comercio.
DIRECCION_IP_CONSUMIDOR Dirección Ip de la máquina que realiza el consumo del servicio.
DIRECCION_IP_CLIENTE Dirección Ip del cliente que realiza la transacción a través del portal de CLIENTE.
FECHA_ENVIO_MENSAJE Fecha del envío de la transacción en formato AAAAMMDD.
HORA_ENVIO_MENSAJE Hora de envío de la transacción en formato hhmmss.
ATRIBUTO_PAGINEO Debe enviar una constante con el valor “N”.
CLAVE_BUSQUEDA Sin valor
CANTIDAD_REGISTROS Debe enviar una constante con el valor 0.
Header de Salida
Campo Descripcion
TIPO_MENSAJE Tipo de mensaje devuelto (Info, Error).
MENSAJE_PROGRAMADOR_SISTEMA Indica si la transacción finalizó correctamente, en caso de fallar indica la razón de la falla.
CODIGO_MENSAJE_PROGRAMADOR Tendrá el valor 0000 en caso de éxito y 9999 en caso de fallo.
MENSAJE_USUARIO Indica si la transacción fue procesada o rechazada.
CODIGO_MENSAJE_USUARIO Tendrá el valor 0000 en caso de éxito y 9999 en caso de rechazo.
FECHA_SALIDA_MENSAJE Indica la fecha de salida del mensaje en formato AAAAMMDD.
HORA_SALIDA_MENSAJE Indica la hora de salida del mensaje en formato hhmmss.

Tipos de errores

HTTP Status Code Descripcion
200 - OK Transacción procesada satisfactoriamente (Aprobada o rechazada)
400 – BAD_REQUEST Errores producto de la validación de los datos asociados a la mensajería (ver tabla de errores)
500 – Internal server error Error técnico en el sistema requiere de apoyo de infraestructura / problemas con la plataforma (ver tabla de errores)

LISTA DE MENSAJES DE RESPUESTA API TED

Código de error Descripción del error Acción a ejecutar
0 Operación exitosa Ninguna
1 Datos Incorrectos HEADER_ENTRADA Revisar los campos obligatorios del header de entrada
2 Tipo Buzón no está asociado al Comercio Revisar el tipo de buzón asignado a su código de comercio
3 Datos incompletos para decodificar el archivo.Revisar el contenido de los campos “CONTENIDO_ARCHIVO” y “CODIGO_ARCHIVO”
4 Archivo vacío Revisar el contenido del archivo
7 No hay archivos para descargar
9 Huella de archivo incorrecta
49 Código de Comercio no existe o sus datos son inconsistentes Colocar correctamente el código de comercio o merchant id enviado para las pruebas
210 Tipo buzón no valida su encriptación Verificar la encriptación según los ejemplos
220 Numero lote no valida su encriptación Verificar la encriptación según los ejemplos
230 Fecha desde no valida su encriptación Verificar la encriptación según los ejemplos
240 Fecha hasta no valida su encriptación Verificar la encriptación según los ejemplos
250 Tipo archivo no valida su encriptación Verificar la encriptación según los ejemplos
260 Carpeta archivo no valida su encriptación Verificar la encriptación según los ejemplos
270 Clave entrada no valida su encriptación Verificar la encriptación según los ejemplos
9001 Error abriendo conexión a la BD
9002 Mensaje errado no es un formato válido
9003 Error procesando el servicio MerchantService
9004 Error en la carga del archivo
9005 Error en la descarga del archivo
9900 No se puede ejecutar la transacción intente más tarde
5
Average: 5 (1 vote)

Pagos con Móvil C2P (1.0.0)(1 API included)

El API de C2P le permite a su empresa recibir pagos interbancarios en bolívares a través de un número celular, para que sus clientes puedan adquirir sus productos y servicios de forma rápida, fácil y sencilla.

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

Campo Descripcion
Merchant_identify Información asociada a la identificación del comercio
IntegratorId Código de integrador asignado por Mercantil Banco, si es un integrador de comercios el valor debe ser 1. Campo numérico. Si se coloca algún valor no numérico, el API responderá con el siguiente error “9002 No es un mensaje json válido”.
MerchantId Código de comercio entregado por Mercantil junto a la llave de cifrado que utilizará para cifrar la data sensible. Campo numérico. Si se coloca algún valor no numérico, el API responderá con el siguiente error “9002 No es un mensaje json válido”.
TerminalId Código de terminal asignado por Mercantil Banco, si Mercantil Banco no le suministra código de terminal debe colocar el valor 1
Client_identify Información asociada para identificar el dispositivo utilizado por el cliente pagador
IpaddressIP Address del cliente pagador
Browser_agent User Agent en caso de que el cliente realizó el pago vía browser
Mobile Información asociada a los datos del dispositivo móvil (cliente pagador)
Manufacturer Marca del dispositivo móvil (cliente pagador)
Model Modelo del dispositivo móvil (cliente pagador)
Os_version Sistema operativo Modelo del dispositivo móvil (cliente pagador)
Location Información asociada a la geolocalización del dispositivo móvil (cliente pagador)
Lat Geo localización latitud. Campo numérico. Si se coloca algún valor no numérico, el API responderá con el siguiente error “9002 No es un mensaje json válido”.
Log Geo localización longitud. Campo numérico. Si se coloca algún valor no numérico, el API responderá con el siguiente error “9002 No es un mensaje json válido”.
Transaction_c2p Información asociada a la transacción financiera
Amount Monto de la transacción. El separador de decimal es “.” Ejemplo si el monto es 2525,33 el valor a colocarse en este campo es 2525.33 Campo numérico. Si se coloca algún valor no numérico, el API responderá con el siguiente error “9002 No es un mensaje json válido”.
Currency Tipo de moneda, constante “ves”
Destination_bank_id Código de banco destino. Es el código del banco donde se encuentra afiliado el número del móvil de la persona pagadora. Campo numérico. Si se coloca algún valor no numérico, el API responderá con el siguiente error “9002 No es un mensaje json válido”.
Destination_id Identificación destino ejemplo V12388088. Es la identificación de la persona pagadora. El tipo de identificación debe colocarse siempre al inicio sin guiones ni caracteres especiales, seguido por el número de identificación. Posibles valores de tipo de identificación: “V”, “E”, “P”.
Destination_mobile_number Número móvil destino. Es el número del móvil de la persona pagadora. Está compuesto de código país (longitud 2), código de área (longitud 3) y número de teléfono (longitud 7). Ejemplo 589991234567
Payment_reference Número de referencia de la transacción. Requerido cuando el tipo de transacción trx_type = “anulacion”
Origin_mobile_number Número móvil origen. Es el número del móvil de la empresa/comercio que realizará el cobro. Está compuesto de código país (longitud 2), código de área (longitud 3) y número de teléfono (longitud 7). Ejemplo 589991234567
Trx_type Tipo de transacción. Posibles valores: “compra”, “anulacion”.
Payment_method Método de pago, constante “c2p”
Invoice_number Identificador de la transacción, este dato es utilizado para relacionar la operación del cliente con el pago
Twofactor_auth Clave temporal de compra del cliente
  • Para descargar la descripción de los campos pulse el siguiente texto: Atributos o Campos

Tipos de errores

HTTP Status Code Descripcion
200 - OK Transacción procesada satisfactoriamente (Aprobada o rechazada por el Banco Emisor)
400 – BAD_REQUEST Errores producto de la validación de los datos asociados a la mensajería (ver tabla de errores)
401 – Unauthorized Error en validar seguridad
500 – Internal server error Error técnico en el sistema requiere de apoyo de infraestructura / problemas con la plataforma (ver tabla de errores)

ERRORES EN LAS PRUEBAS CON C2P

Código de error Descripción del error Acción a ejecutar
0 Transacción procesada correctamente Ninguna
25Browser Agent inválido máximo 80 caracteres Revisar la cantidad máxima de caracteres
26Manufacturer inválido máximo 80 caracteres Revisar la cantidad máxima de caracteres
27 Model inválido máximo 80 caracteres Revisar la cantidad máxima de caracteres
28 Os_Version inválido máximo 80 caracteres Revisar la cantidad máxima de caracteres
30 Código de integrador en cero o nulo Colocar el código de integrador o integratorId que se encuentra en el ejemplo
40 Código de comercio en cero o nulo Colocar correctamente el código de comercio o merchant id enviado para las pruebas
43 Código de terminal en nulo o muy largo debe ser menor a 13 caracteres Revisar la cantidad de caracteres
46 IP del cliente errada Revisar y colocar correctamente la IP del cliente
49 Código de comercio no existe o sus datos son inconsistentes Colocar correctamente el código de comercio o merchant id enviado para las pruebas
50 Tipo de transacción errado Colocar correctamente el Trx_type que se solicita.
60 Método de pago errado Colocar correctamente el Payment_Method que se solicita. Es un valor constante
70 Identificación banco destino en cero o nulo Colocar correctamente el destination_bank_id que se solicita
80 Segundo factor en nulo Colocar correctamente el twofactor_auth que se solicita
90 Tipo de identificación en destination_id en cero o nulo Colocar correctamente el destination_id que se solicita
100 Número de identificación en destination_id en cero Colocar correctamente el destination_id que se solicita
101 Número de identificación en destination_id muy largo máximo 15 caracteres Revisar la cantidad máxima de caracteres de destination_id
102 Identificación destino con formato errado Colocar correctamente el destination_id que se solicita
130 Número móvil destino en cero o nulo Colocar correctamente el destination_mobile_number que se solicita
131 Número móvil destino debe ser de 12 dígitos Colocar correctamente el destination_mobile_number que se solicita
140 Número móvil origen en cero o nulo Colocar correctamente el origin_mobile_number que se solicita
141 Número móvil origen debe ser de 12 dígitos Colocar correctamente el origin_mobile_number que se solicita
150 Número de referencia en cero o nulo Colocar correctamente el payment_reference que se solicita
151 Número de referencia muy largo máximo 12 caracteres Revisar la cantidad máxima de caracteres de payment_reference
160 Monto de la transacción erradoVerificar monto de la transacción ingresado
170 Código de moneda errado Verificar el código de moneda
180 Número de factura en nulo Verificar el número de factura o Invoice Number que generó
181 Número de factura muy largo máximo 40 caracteresRevisar la cantidad máxima de caracteres
210 Número de factura procesada previamente Verificar el número de factura o Invoice Number que generó. No puede ser duplicado aun cuando la transacción haya sido rechazada
220 ApiKey no válido Verificar la generación del ApiKey
230 Número móvil origen no valida su encriptación Verificar la encriptación según los ejemplos
240 Segundo factor no valida su encriptación Verificar la encriptación según los ejemplos
250 Comercio no está activo Colocar correctamente el código de comercio o merchant id enviado para las pruebas
260 Número móvil destino no valida su encriptación Verificar la encriptación según los ejemplos
280 Identificación destino no valida su encriptación Verificar la encriptación según los ejemplos
9005 La clave de compra ingresada no es correcta debe solicitar una nuevamente
9006 El número de cedula de identidad destino no es válido por favor corregir y realizar la transacción nuevamente
9007 El número de cedula de identidad origen no es válido por favor corregir y realizar la transacción nuevamente
9008 El número de teléfono destino no es válido por favor corregir y realizar la transacción nuevamente
9009 El número de teléfono origen no es válido por favor corregir y realizar la transacción nuevamente
9010 El banco ingresado no es válido por favor corregir y realizar la transacción nuevamente
9011 Ha excedido el número de transacciones permitidas al día
9018 El monto ingresado no es válido por favor corregir y realizar la transacción nuevamente
9019 El banco ingresado no es válido por favor corregir y realizar la transacción nuevamente
9020 No se encuentra afiliado al servicio. Realice la afiliación a través de Mercantil en Línea en www.mercantilbanco.com
9021 El numero celular es invalido contacte a su operadora
9022 El monto supera el monto disponible en cuenta
9023 Ha excedido el número de transacciones permitidas al día
9024 Por favor comuníquese con el banco emisor
9025 Ha excedido el monto permitido al día
8000 api not found
9000 Falla en la lectura del archivo de configuración
9001 Error abriendo conexión a la BD (PersistenceDB)
9002 Mensaje errado no es un mensaje json válido
9003 Error procesando el servicio MerchantService
9004 Error procesando el servicio PAGOS
9013 Error ejecutando addPayment método ingresar transacción en la BD
9014 Error ejecutando updateStatusPayment método actualizar transacción en la BD
9015 Error ejecutando checkInvoiceNumber método para verificar facturas duplicadas
9016 Error ejecutando checkPayMethod método para verificar método de pago
9017 Error ejecutando checkCurrency método para verificar el código de moneda
9900 No se puede ejecutar la transacción intente más tarde

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

Ejemplos Pago (C2P)

5
Average: 5 (1 vote)

Pagos con Tarjetas (1.0.0)(2 APIs included)

Recibe los pagos de tus clientes a través del Botón de Pagos Mercantil, el cual le permite transacciones con tarjetas de crédito Diners Club, Visa y Mastercard nacionales e internacionales y Tarjeta de Débito Mercantil desde el móvil o página web.

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

5
Average: 5 (1 vote)

Búsquedas (1.0.0)(1 API included)

Esta API le permite localizar información de sus transacciones realizadas con Tarjetas de crédito, débito o Pagos C2P de forma fácil y rápida.

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