/api/v1, y nada se versiona en el host. Un listado de productos es GET /api/v1/loan-products.
Esta página es el mapa, no el territorio. Cubre lo que las operaciones comparten y luego las agrupa por el trabajo que hacen. Cada operación tiene su propia página bajo el anchor Lender en la Referencia de API, con las formas completas de request y response.
Los documentos OpenAPI de este portal son fuentes de renderizado para las páginas de referencia. No son contratos de cliente ni base para generar un SDK.
Autenticación
Lender acepta un token bearer JWT. Un solo esquema de seguridad aplica a todo el documento:
/health, /readyz y /version.
Autorización
Lender autoriza cada request contra la aplicación
lender, un recurso y una acción. El recurso sigue a la superficie, y las acciones son granulares en lugar de una sola escritura:
Otorga al rol del oficial solo las acciones que su trabajo necesita.
make generate-casdoor escribe los roles y permisos de Lender en un archivo semilla que cargas en tu proveedor de identidad — Prerrequisitos muestra el conjunto mínimo para originar.
Identidad de tenant y de oficial
El tenant nunca es un header, un parámetro de query ni un campo del body. Lender lo resuelve desde la identidad validada del request. Consulta Multi-tenancy. El oficial asignado sale del subject del token de la misma forma. Ningún body de solicitud de préstamo lleva un campo de oficial, y ningún valor enviado por el cliente sobrescribe el subject.
Requests y responses
Cada operación que lleva body envía y devuelve
application/json.
Envía todo campo de dinero y de tasa como string decimal, nunca como número JSON — "50000.00", "0.01500000". Lender los devuelve igual. Las marcas de tiempo son RFC 3339 en UTC.
Idempotencia
Las escrituras de dinero y de cronograma aceptan el header de request
X-Idempotency.
Envía tu propia clave. Las cinco operaciones que exigen
X-Idempotency comparten un comportamiento:
- Un reintento de una llamada completada repite la primera respuesta y le pone
X-Idempotency-Replayed: true. Nada se registra por segunda vez. - Un reintento mientras la primera llamada sigue en vuelo responde
409. - La clave tiene alcance de tenant y expira tras la ventana que fija
IDEMPOTENCY_RETRY_WINDOW_SEC, con default de 300 segundos.
X-Request-ID y caen de vuelta a X-Idempotency cuando ese falta. Envía uno de los dos: una llamada que no lleva ninguno responde 422.
Lender guarda el id del request en la base de datos junto con los datos de la llamada. Un reintento que lleva el mismo id y los mismos datos repite la primera respuesta por la ruta normal de respuesta, sin header de repetición. El mismo id de request con datos distintos responde 409 en lugar de repetir, así que un id nunca puede registrar dos montos diferentes. Ese registro no expira.
Los datos que Lender compara cambian según la operación:
Paginación
La paginación es por operación, no global. Lee la página de referencia de la operación que llamas, y envía solo los parámetros que ella declara.
Un valor fuera del rango se rechaza en lugar de ajustarse al límite. Cada otra lectura declara sus propios parámetros, así que acótala con los identificadores y filtros de su página de referencia.
Errores
Todo error responde
application/problem+json y sigue RFC 9457.
Ramifica por el estado y, para un
422, por los valores de location en errors. Un 422 nombra cada campo que falló. Una falla del lado del servidor responde con un detail genérico, así que una causa cruda nunca llega a un cliente.
Las operaciones por trabajo
Catalogar un producto
Ocho operaciones son dueñas del catálogo. Crear un producto y agregar una versión construyen los términos a los que se ata una solicitud. La versión es inmutable. Vincular un perfil contable mapea cada evento contable a cuentas del libro mayor, y Lender lo necesita en el desembolso. Aplicar un cargo y leer tasas flotantes completan la superficie, junto a listar, obtener y activar. Lee Definir un producto de préstamo.Originar
Seis operaciones llevan una solicitud de enviada a desembolsada: crear, luego una de aprobar, rechazar o retirar, y después desembolsar. Previsualizar un cronograma calcula las cuotas para una cotización y no persiste nada. Las respuestas de creación y de decisión son las únicas lecturas de una solicitud, así que guarda el body que devuelve cada llamada. Lee Cómo funciona la originación para la máquina de estados e Inicio rápido para las seis llamadas de punta a punta.Hacer servicing de un préstamo vivo
Cinco lecturas describen la cuenta: la cuenta, su cronograma, sus transacciones, sus cargos y su historia de auditoría. Cinco escrituras mueven dinero o el cronograma: previsualizar un pago antes de registrarlo, prepagar, reprogramar y reversar una transacción. Nada reescribe la historia. Una reversión registra una nueva transacción que compensa la original. Lee Servicing de un préstamo.Contabilizar y asentar
Iniciar una ejecución de devengo reconoce intereses de un período de competencia. Lista las referencias de asiento por id de correlación y lee una para encontrar el registro contable que escribió una ejecución. Lee Contabilidad y ejecuciones de devengo.Descubrir jurisdicciones
Las dos lecturas públicas informan qué códigos de jurisdicción lleva este despliegue y qué decide cada perfil. Lee Jurisdicciones.Brasil
El paquete Brasil agrega lecturas y escrituras reguladas bajo/api/v1/br: divulgación de CET, el descriptor de operación de crédito, etapa PDD y sus transiciones, una cotización de prepago con su estado de liquidación, previsualización de impuestos y consentimiento de capitalización. El paquete también lleva sus propias rutas de producto, que se comportan como las genéricas bajo reglas brasileñas. Lee Pack regulatorio de Brasil.
La jornada con descuento en nómina es una conversación por eventos con el riel de nómina, no un conjunto de llamadas REST. Lee Consignado privado.
Próximos pasos
Inicio rápido
Seis llamadas de una base vacía a un préstamo desembolsado.
Eventos
Suscríbete a la jornada de crédito en lugar de hacer polling.
Referencia de API
Cada operación, con las formas completas de request y response.
Prerrequisitos
Los servicios, las migraciones y la configuración que necesita una primera llamada.