Docs
EN

Esta guía te lleva desde una cuenta recién creada hasta una respuesta valid de la API. Asume que ya iniciaste sesión en la consola.

1. Obtener tu API key

Desde la consola, ve a la sección API (atajo: /api) y abre el panel Keys. Haz clic en Regenerar y copia la clave que aparece en el modal. Solo se muestra una vez.

Tu key tiene este shape:

mxcep_<64 caracteres hexadecimales>

2. Haz tu primera request

POST /v1/validate valida una transferencia SPEI contra el CEP de Banxico. El body mínimo necesita fecha, monto y al menos uno entre clave_rastreo y referencia_numerica.

curl -X POST 'https://api.example.com/v1/validate' \
  -H 'Authorization: Bearer mxcep_••••' \
  -H 'Content-Type: application/json' \
  -d '{
    "fecha": "2025-03-15",
    "monto": 15000.50,
    "clave_rastreo": "MXBA20250315001234",
    "cuenta_beneficiaria": "012180004412345678"
  }'

Ejemplo en Python — próximamente.

Ejemplo en JavaScript — próximamente.

Ejemplo en PHP — próximamente.

Los campos emisor y receptor son opcionales cuando cuenta_beneficiaria es una CLABE o número de tarjeta: el banco se infiere del prefijo. Para celulares DiMo (10 dígitos), el receptor se intenta resolver desde tu directorio de beneficiarios y desde el catálogo global.

3. Interpretar la respuesta

Una respuesta exitosa vuelve con HTTP 200 y este envelope:

{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "type": "direct",
    "status": "valid",
    "fecha": "2025-03-15",
    "monto": 15000.50,
    "has_cep": true
  },
  "meta": {
    "version": "1.x.x",
    "api_version": "v1",
    "request_id": "...",
    "datetime": { "timezone": "UTC", "format": "ISO 8601" }
  }
}

Lo importante:

  • data.id es el UUID de la validación. Guárdalo: lo necesitas para descargar el CEP, consultar reintentos, o anclar idempotencia del lado tuyo.
  • data.status es el veredicto. valid significa que el CEP existe y los datos coinciden; not_found que el CEP fue consultado pero no encontró match; cep_unavailable que Banxico no está respondiendo; error que hubo una falla no recuperable.
  • meta.request_id te sirve para reportar problemas a soporte — inclúyelo cuando abras un ticket.
  • Todos los timestamps están en UTC con sufijo Z. Conviértelos a tu zona del lado cliente.

4. Cómo continuar