Inicio

Servicios de la API

La API provee cuatro tipos de servicios:

Servicio para obtener token de sesión: Este es el primer servicio a invocar cada vez que se desee acceder a los servicios de la API. Permite obtener un token temporal que se debe incluir en todos los servicios a utilizar durante cada sesión.Ver especificación técnica del servicio de token de sesión.

Servicio de bitácora: Permite conocer la última fecha de actualización de las diferentes tablas y catálogos en la base de datos del Banco de México. Esto es de utilidad para evitar realizar consultas de información que no se ha modificado en la base de datos. Ver Especificación técnica del servicio de bitácora.

Servicio de catálogos: Permiten obtener los catálogos necesarios para interpretar los valores de aquellos campos que toman valores de catálogo. Por ejemplo, el campo “tipo de instrumento†que aparece en la tabla de productos generales, puede tomar las claves que se muestran en el siguiente catálogo:

Clave Tipo de instrumento
2 Productos de crédito hipotecario
5 Productos de crédito revolvente (tarjetas de crédito)
6 Productos de crédito no revolvente (automotriz, nómina y personal)

Ver Especificación técnica de servicio de catálogos.

Servicios de características y costos de productos: Permite descargar las diferentes tablas que contienen información de las características y los costos de los productos de crédito. La información de cada tipo de crédito se almacena en diferentes tablas dependiendo del tipo de información de que se trate. Es decir, se tienen tablas para cada tipo de información, entre otras, de características generales del producto, de requisitos de elegibilidad, de tasa de interés y CAT, de comisiones, de seguros, de beneficios (en el caso de tarjetas de crédito). Estos servicios de la API permiten obtener la información almacenada en cada una de estas tablas. Para poder asociar la información de las Distintas tablas a un producto específico, se deben usar los identificadores de producto, subproducto y operativos que se incluyen en cada tabla.

Ver Especificación técnica de servicios de características y costos de productos.

Especificación técnica del servicio de token de sesión

Descripción:

Este servicio proporciona un token de sesión que el desarrollador deberá utilizar en todas las consultas que realice durante la sesión. La validez del token es temporal (ver detalle en la página de Administración de la API), en caso de que expire durante la sesión se debe obtener uno nuevo.

URL:

https://comparador.banxico.org.mx/ComparadorCrediticio/api/auth

Método:

POST

Headers:

Nombre Descripción
BMX-Auth El valor del header se formará por la cadena de caracteres concatenados del identificador y la llave asignados, de la siguiente forma: clientId:clientSecret, esta cadena de caracteres deberá usar una codificación Base64

Respuesta:

Se obtiene el access token que debe ser enviado como parámetro para consultar los diferentes servicios.

Respuesta Error Elementos que contiene una respuesta de una peticion procesada con errores.
success false Indica si la peticion fue procesada correctamente.
error Identificador del error
error_description descripción del error
Respuesta correcta Elementos que contiene una respuesta de una petición procesada sin errores.
success true Indica si la peticion fue procesada correctamente.
access_token Token que sera enviado como parámetro al consumir los diferentes servicios.

Especificación técnica del servicio de bitácora

Descripción:

Este servicio proporciona la fecha de la última actualización de los diferentes catálogos y tablas disponibles a través de los servicios de esta API. El desarrollador deberá utilizar este servicio para determinar si requiere actualizar alguno de los catálogos o tablas previamente obtenidos.

URL:

https://comparador.banxico.org/api/estatus

Método:

POST

Parámetros de entrada:

Parámetros obligatorios.

Nombre Descripción
access_token En cada petición se debe enviar el token de sesión que se generó previamente.

Respuesta:

Se obtienen las fechas en las que cada catálogo y tabla se modificaron por última vez.

Status Resultado obtenido al realizar la llamada del servicio
errorMessage Mensaje
errorId Identificador único
actualizaciones Listado de elementos que contienen los siguientes pares de valores:
nombre Nombre del servicio o catálogo
fechaActualizacion Fecha en la que se actualizó el servicio o catálogo.

Especificación técnica del servicios de catálogos

Descripción:

Este servicio proporciona el contenido de los diferentes catálogos asociados a diversos campos en las tablas de características y costos de productos. El servicio requiere de un parámetro de entrada que corresponde al nombre del catálogo que se desea obtener.

El Apéndice A en esta sección lista los nombres de los catálogos disponibles y los tipos de productos a los que aplica, también pueden ser consultados a través del endpoint https://comparador.banxico.org.mx/ComparadorCrediticio/api/catalogos/disponibles

URL:

https://comparador.banxico.org.mx/ComparadorCrediticio/api/catalogos

Método:

POST

Parámetros de entrada:

Parámetros obligatorios.

Nombre Descripción
access_token En cada petición se debe enviar el token de sesión que se generó previamente.
catalogName Nombre del catálogo que se desea obtener.

Respuesta:

Nombre Resultado obtenido al realizar la llamada del servicio
catalogContent Listado de la información del catálogo que está en la base de datos
descripción Valor relacionado al identificador que se proporciona
clave Identificador único que tiene el valor del catálogo en la base de datos de Banxico

Apéndice A:

Nombre Descripción
ENTIDADESFINANCIERAS Listado de entidades financieras para las que se tiene información.
TIPOINSTRUMENTO

Listado de los tipos de instrumentos financieros.

DESTINOCREDITOREVOLVENTE

Listado de destinos para interpretar los destinos de los productos de crédito revolvente.

DESTINOCREDITONOREVOLVENTE

Listado de destinos para interpretar los destinos de los productos de crédito no revolvente.

DESTINOCREDITOHIPOTECARIO

Listado de destinos para interpretar los destinos de los productos de crédito hipotecario.

ESTABLECIMIENTO

Listado de de tipos de establecimientos.

TASAREFERENCIAEST

Indica la tasa de referencia a considerar.

MARCASAUTOS

Indica las marcas de autos disponibles.

BASECOBRO En este catálogo se tiene la información sobre la base que se hace el cobro de las comisiones. Aplica a todos los tipos de crédito.
CLASE En caso de que el producto de crédito revolvente tenga una tarjeta como medio de disposición, indica la clase de dicha tarjeta: básica, clásica, oro o platino. Si el producto de crédito revolvente no es una tarjeta de crédito se debe dejar vacío. Aplica a los tipos de crédito revolvente.
GARANTIACNR Indica el tipo de garantía en caso de que aplique. Para créditos hipotecarios se debe seleccionar si la garantía es la vivienda (hipotecaria) o el saldo de la subcuenta de vivienda. Para créditos revolventes y no revolventes, de no existir garantía, seleccionar la opción “Sin garantía.â€Aplica a los créditos no revolventes.
GARANTIACR Indica el tipo de garantía en caso de que aplique. De no existir garantía, no es necesario usar valor alguno. Aplica a los créditos revolventes.
GARANTIAHIPOTECARIO Indica el tipo de garantía en caso de que aplique. Para créditos hipotecarios se debe seleccionar si la garantía es la vivienda (hipotecaria) o el saldo de la subcuenta de vivienda. Aplica a los créditos hipotecario.
MEDIODISPOSICIONCNR Indica los diferentes medios a través de los cuales se puede disponer de los fondos o crédito disponible. Aplica a los créditos no revolventes.
MEDIODISPOSICIONCR Indica los diferentes medios a través de los cuales se puede disponer de los fondos o crédito disponible. Aplica a los créditos revolventes.
MONEDA Unidad de cuenta en la que se registran los saldos del producto. Aplica a crédito revolvente, crédito no revolvente y crédito hipotecario.
OPERADORES Indica el tipo de vivienda que se debe de tener para los distintos productos que se tienen. Aplicable a crédito hipotecario.
PERIODICIDADPAGO Indica la periodicidad con la que se debe pagar el crédito. Aplica a crédito no revolvente.
PERSONALIDADJURIDICA Muestra los perfiles jurídicos que pueden tener los clientes que soliciten préstamos. Aplica para todos los créditos.
PLAZOTIPOPERI Periodicidad en la que los usuarios pueden realizar el pago de sus préstamos. Aplica para todos los créditos.
PREVTIPOEVENTO Tipo de eventos en los que se ofrecen preventas de boletos. Aplica a créditos revolventes.
PROGRAMAS Indica si el crédito hipotecario se puede contratar con algún tipo de programa de ONAVIs. Aplicable a crédito hipotecario.
PUBLICO_REVOLVENTE_NO_REVOLVENTE_HIPOTECARIO Indica si la persona debe ser cliente, cliente distinguido (pertenecer a un programa de cliente diferenciado), o no necesita ser cliente actual de la institución para acceder al producto. Aplica para créditos revolventes, no revolventes e hipotecarios.
PUNTOSFORMAUTILIZAR Indica la forma en que se podrán utilizar los puntos que se obtengan en los programas de lealtad que ofrecen las distintas instituciones bancarias. Aplica para créditos revolventes.
NOMBREPROGRAMAPUNTOS Indica el nombre del programa de lealtad que ofrecen las distintas instituciones bancarias. Aplica para créditos revolventes.
TASA Indica si la tasa de interés es fija, variable, mixta, creciente o decreciente. Aplicable a crédito revolvente, no revolvente e hipotecario.
MODOCALCTASA Indica el modo de uso de la tasa de referencia. Aplicable a crédito revolvente, no revolvente e hipotecario.
TIPOAUTO Indica el tipo de auto que se ofrece. Aplicable a créditos automotrices.
TIPOBIENCNR Identifica el tipo de bien que se puede adquirir con el crédito. Aplicable a crédito no revolvente.
TIPOCOMISIONCORRESPONSAL Indica el tipo de comisión corresponsal que se cobrará. Aplicable a crédito revolvente, no revolvente e hipotecario.
TIPOCOMISIONPENALIZACIONAUTO Indica el tipo de comisión de penalización que se cobrará. Aplicable a crédito automotriz.
TIPOCOMISIONPENALIZACIONCR Indica el tipo de comisión de penalización que se cobrará. Aplicable a crédito no revolvente.
TIPOCOMISIONPENALIZACIONHIPOTECARIO Indica el tipo de comisión de penalización que se cobrará. Aplicable a crédito hipotecario.
TIPOCOMISIONUSOAUTO Indica le tipo de comisión de uso que se cobrará. Aplica a crédito automotriz.
TIPOCOMISIONUSOCR Indica le tipo de comisión de uso que se cobrará. Aplica a crédito revolvente.
TIPOCOMISIONUSOHIPOTECARIO Indica le tipo de comisión de uso que se cobrará. Aplica a crédito hipotecario.
TIPOCORRESPONSALES Indica las instituciones que pueden aceptar pagos a nombres de instituciones bancarias. Aplicable a crédito revolvente y no revolvente.
TIPOPERIODOTIEMPROM Indica la interpretación del tiempo promedio de aprobación. Aplicable a crédito revolvente, no revolvente e hipotecario.
TIPOPERIODO Indica el periodo en el que se podrá realizar pagos de un producto contratado. Aplicable a crédito revolvente, no revolvente e hipotecario.
TIPOPROGRAMA Indica si el crédito hipotecario se puede contratar con algún tipo de programa de ONAVIs. Reportar “Sin programa†si el crédito no se puede contratar con ayuda de ONAVIs. Aplicable a crédito hipotecario.
TIPOSEGUROAUTO Indica los seguros que se pueden contratar en un crédito automotriz. Aplica a crédito automotriz.
TIPOSEGUROCR Indica los seguros que se pueden contratar en un crédito revolvente. Aplica a crédito revolvente.
TIPOSEGUROHIPOTECARIO Indica los seguros que se pueden contratar en un crédito hipotecario. Aplica a crédito hipotecario.
TIPOVALOR Indica la forma en que se va a calcular el valor del producto. Aplicable a crédito revolvente, no revolvente e hipotecario.
TIPOVIVIENDA Indica el tipo de vivienda que se debe de tener para los distintos productos que se tienen. Aplicable a crédito hipotecario.

Servicios Generales

Con estos servicios, los desarrolladores podrán obtener la lista de productos del tipo de instrumento especificado que están vigentes en la fecha proporcionada y sus características de elegibilidad.


Servicios de Crédito Hipotecario

En esta sección se listan los servicios que se deberán de utilizar únicamente para generar un comparador de crédito hipotecario.


Servicios de Tarjeta de Crédito

En esta sección se listan los servicios que se deberán de utilizar únicamente para generar un comparador de tarjetas de crédito.


Servicios de Crédito Automotriz

En esta sección se listan los servicios que se deberán utilizar al desarrollar un comparador de créditos automotrices.


Servicios de Crédito de Nómina

En esta sección se listan los servicios que se deberán utilizar al desarrollar un comparador de créditos de nómina.