Documentación

Todo lo que necesitas para llamar al gateway — un contrato para todas las integraciones fintech.

Primeros pasos

Todos los endpoints viven bajo una URL base y siguen las mismas convenciones:

https://api.openbankinggateway.com
💡

Cada página de app tiene un playground en vivo — completa los parámetros y pulsa Send request, sin configuración de cliente. La especificación completa legible por máquina está en la OpenAPI / Swagger UI.

Una integración típica son tres pasos:

  1. Inicia sesión — llama a los endpoints de login de la app con las credenciales / OTP.
  2. Guarda el token — un login exitoso devuelve un token del gateway.
  3. Llama a los endpoints — pasa token= en cada solicitud autenticada.

Autenticación

Cada app usa un flujo de login nativo de su fintech (OTP por SMS, usuario/contraseña, PIN + OTP). Al tener éxito, el gateway emite su propio token de sesión:

{ "code": 200, "data": { "status": "Login successful", "token": "<gateway session token>", ... } }

Pasa ese token como parámetro de consulta token= en cada endpoint siguiente. El gateway lo resuelve a la sesión upstream en el servidor — nunca vuelves a manejar credenciales upstream.

🔑

Los tokens están ligados a la cuenta que inició sesión. Si la sesión upstream caduca, inicia sesión de nuevo para obtener un token nuevo.

Formato de respuesta

Cada respuesta — de éxito o error — se envuelve en el mismo sobre:

{ "code": 200, // HTTP-style status of the gateway call "data": { ..., // normalized fields from the fintech app "upstream": { ... } // the raw, untouched upstream JSON } }

El campo data.upstream siempre lleva la respuesta fintech original, así que puedes usar los campos normalizados por comodidad y aun así auditar o analizar el payload en bruto cuando necesites detalles específicos de la app.

Errores

EstadoSignificado
400Error de validación — falta un parámetro o está mal formado.
401Credenciales inválidas, token incorrecto/caducado o sin sesión activa.
502No se pudo contactar la app fintech upstream o dio error.

Los errores de credenciales y de upstream siguen incluyendo data.upstream cuando está disponible, así que el cuerpo de error del upstream nunca se te oculta.

APIs disponibles

Cada integración incluye documentación completa de endpoints y un playground en vivo: