Documentación técnica · Versión 1.0 · Septiembre 2026
API SB Software
Guía de integración para entidades financieras y fintech. La API permite integrar sus sistemas con la plataforma de gestión de créditos personales de SB: consultar y dar de alta préstamos y clientes, registrar cobranzas, calificar prospectos, validar identidad y vías de contacto, administrar el legajo digital y extraer la cartera para herramientas de análisis.
ProtocoloHTTPS · REST
FormatoJSON
AutenticaciónJWT Bearer
Endpoints96
Características generales
URL base: en esta guía se representa con la variable {{SB.url}}. SB Software informa la URL base correspondiente a cada entorno (pruebas y producción).
Formato de datos: JSON (Content-Type: application/json; charset=utf-8).
Fechas: en los requests, formato aaaa-mm-dd; en las respuestas, ISO 8601 (2021-07-13T00:00:00) salvo donde se indique otro formato.
Recursos para administrar la calificación automática de prospectos y la cartera de preaprobados. Con estos métodos podrá incorporar una landing page que se integre a la plataforma para recibir solicitudes de crédito.
El onboarding permite a aquellas entidades que quieran integrar los servicios desde una app o web y no quieran realizar la integración mediante una calificación o bien para aquellas entidades que quieran brindar servicios a su cartera de clientes vigentes.
Los endpoints del módulo Referidos no usan JWT: se autentican con el header x-api-key, cuyo valor es un token permanente que asigna SB Software.
Convenciones de respuesta
Los endpoints de alta, modificación y acciones devuelven en general errorCode (0 = sin error; otro valor = código de error) y status ("OK" o el mensaje de error).
Si faltan datos obligatorios, la API responde 400 Bad Request con un objeto {"Message": "..."} que describe el problema.
Los campos de código (provincia, banco, forma de pago, línea de crédito, sucursal, etc.) se completan con los valores de los endpoints de listados de cada módulo.
Los ejemplos son ilustrativos: las respuestas se muestran recortadas (primer registro de cada listado) y los datos personales son ficticios.
Login
El método login que debe utilizar para acceder a la API. El mismo es del tipo Json Web Token.
Realiza una simulación de liquidación de un préstamo.
idCliente (código de cliente ): Es el código de un cliente en cartera. OPCIONAL
fechaAlta: Fecha de alta del préstamo.
comercializadora_Sucursal (Comercializadora o sucursal): Es el código de la sucursal o comercializadora que otorga el préstamo. Puede disponer el listado en el end-point /loans/office.
monto: Monto del préstamo.
cuotas: Cantidad de cuota .
tna: Permite especificar una TNA personalizada.
lineaCredito (Línea de crédito): El código de la línea de crédito del préstamo. Puede disponer el listado en el end-point /loans/creditLines.
importeCuota (Importe de cuota): Si especifica el valor cero, se calculará de forma automático basado en la tasa de la línea de crédito.
primerVto (Primer vencimiento): El vencimiento de la primera cuota.
diaPago: Permite establecer el día de vencimiento de cuota. Si es null, se utilizará el día configurado en la línea de crédito. Los posibles valores son:
Opera y administra la firma electrónica de un contrato.
Se debe indicar el idPrestamo (número de préstamo) y un código de acción:
0: Estado de documento. Al brindar un número de préstamo indica cual es el estado de firma electrónica. Si no informa estado es que debe generar el mismo.
1: Generar y enviar documento para firma electrónica. Según el servicio contratado y la configuración en la plataforma SB, será enviado por mail, SMS o WhatsApp.
2: Reenviar documento para firma electrónica.
3: Cancelar documento.
4: Descargar documento. En la respuesta, se completará el campo "URL" de donde podrá descargar el mismo.
Autenticación
Bearer token
Body
JSON
Ejemplo de request
{
"idPrestamo": 1000001,
"accion": 0
}
Respuesta 200 OK
{
"errorCode": 0,
"idPrestamo": 1000074,
"status": "OK",
"estadoFirma": "Visualizado con firma pendiente",
"estadoFecha": "2022-09-28T00:00:00",
"URL": "https://app.sbfintech.net/Uploads/1000074_Alta.pdf"
}
POST
Alta de préstamo
{{SB.url}}/loans/new
Realiza el alta de un préstamo. Deberá especificar un IdCliente existente. Los estados permitidos son 9 (genera un pendiente de liquidación) y 0 (realiza el alta y liquida).
idCliente (código de cliente ): Es el código de un cliente en cartera. Si el cliente es nuevo, primero debe realizar el alta de cliente.
fechaAlta: Fecha de alta del préstamo.
comercializadora_Sucursal (Comercializadora o sucursal): Es el código de la sucursal o comercializadora que otorga el préstamo. Puede disponer el listado en el end-point /loans/office.
monto: Monto del préstamo.
cuotas: Cantidad de cuota .
tna: Permite especificar una TNA personalizada.
lineaCredito (Línea de crédito): El código de la línea de crédito del préstamo. Puede disponer el listado en el end-point /loans/creditLines.
destinoFondos (Destino de los fondos): Código de destino de los fondos. Puede disponer el listado en el end-point /loans/purpose
importeCuota (Importe de cuota): Si especifica el valor cero, se calculará de forma automático basado en la tasa de la línea de crédito.
primerVto (Primer vencimiento): El vencimiento de la primera cuota.
formaPago (forma de liquidación): La forma en que entregará los fondos del préstamo. Este no es un dato que se suele poner a disponibilidad del cliente, sino una definición de la entidad de como entregará los fondos. Puede disponer el listado en el end-point /payments/paymentMethods.
estado (Estado inicial): Puede indicar estado 9, que genera un pendiente de liquidación o estado 0 (cero) que liquida inmediatamente el préstamo.
referencia (Texto de referencia): Opcionalmente puede especificar un texto de observarción o referencia.
tag (Etiqueta): código de etiqueda. Si desea asignar una etiqueta, puede crearla en la plataforma previamente y asignarla. Las etiquetas son identificaciones de uso interno. Puede disponer el listado en el end-point /loans/tags.
diaPago: Permite establecer el día de vencimiento de cuota. Si es null, se utilizará el día configurado en la línea de crédito. Los posibles valores son:
Realiza una cobranza sobre un préstamo. Existen 2 escenarios posibles en el cobro de cuota:
1 – Si se especifica el número de cuota (variable “nroCuota” > 0):
El pago se aplica solamente a la cuota especificada. Si el importe es inferior al del saldo de cuota, la cuota permanece en estado pendiente de cancelación y se reduce el saldo de dicha cuota. Si el pago es igual o superior al saldo de cuota, la misma se cancela. Si el pago es superior al saldo de cuota, el monto excedente se lo aplica como si fuera un pago de punitorios por mora a la misma cuota de modo que si el saldo de cuota es 1000 y se pagan 1500. El sistema actualiza el valor de cuota a 1500 y pone 500 como interés por mora.
2 – Si NO se especifica el número de cuota (variable “nroCuota” = 0)
Hace un barrido de cuotas con el importe de pago.
En el caso que el pago sea superior, si la empresa activo la administración de pagos excedentes, lo envía a un panel de excedentes del sistema y la empresa puede elegir si devuelve el monto excedente o lo acredita en primer cuota pendiente de cualquier préstamo vigente de dicho cliente. Si no está activado el panel de excedentes, directamente lo aplica en la primer cuota siguiente.
{
"errorCode": -23,
"idPago": 0,
"status": "Ya se encuentra registrado un pago para el débito."
}
POST
Link de pago MP
{{SB.url}}/payments/checkOutLinkMP
Genera un link de pago para Mercadopago.
Al realizarse el pago, se impacta automáticamente en el sistema y hace un barrido de cuotas con el importe de pago.
En el caso que el pago sea superior, si la empresa activo la administración de pagos excedentes, lo envía a un panel de excedentes del sistema y la empresa puede elegir si devuelve el monto excedente o lo acredita en primer cuota pendiente de cualquier préstamo vigente de dicho cliente. Si no está activado el panel de excedentes, directamente lo aplica en la primer cuota siguiente.
Respuesta:
errorCode: Código de error (si aplica).
link: Link de pago en formato URL corta.
status: "OK" si se genero correctamente o motivo de error.
Autenticación
Bearer token
Body
JSON
Ejemplo de request
{
"idPrestamo": 1000004,
"importe": 1000,
"fechaVencimiento": "2022-05-10",
"comentario": "Prueba de cobranza por link"
}
Anula una cobranza realizada. Debe indicar un idPago existente.
Autenticación
Bearer token
Body
JSON
Ejemplo de request
{
"idPago": 1
}
Respuesta 200 OK
{
"errorCode": -1,
"idPago": 0,
"status": "No existe el pago."
}
Preaprobados
Recursos para administrar la calificación automática de prospectos y la cartera de preaprobados. Con estos métodos podrá incorporar una landing page que se integre a la plataforma para recibir solicitudes de crédito.
Presenta el estado de los checkpoints de validación configurados en la plataforma para un preaprobado (código, nombre, valores inicial y final, fecha y estado).
Recibe una solicitud de préstamo. El sistema validará dicha solicitud y responderá si el misma fué preaprobada rechazada.
Todas las solicitudes preaprobadas podrán realizar las validaciones de otorgamiento.
nombre: Nombre del solicitante
apellido:Apellido del solicitante
genero":Sexo del solicitante,
nroDocumento": Nro de documento (DNI o CUIL)
fechaNacimiento": Fecha de nacimiento del solicitante
email: e-mail del solicitante
celular: teléfono mobil del solicitante
ingresos: Ingresos mensuales del solicitante
monto: Monto que solicita
cuotas: Cantidad de cuota en las que quiere pagar
lineaCredito: Línea de crédito para evaluar (debe estar previamente cargada en la plataforma SB)
diaPago: Día del mes en que desea pagar las cuotas
importeCuota: Importe de cuota deseado (Si pone cero el sistema lo calcula)
comercializadora_sucursal: Código de comercializadora o sucursal asociada a la solicitud (Debe estar previamente cargada en la plataforma SB).
origen: Origen de datos. Este campo sirve para identificar desde donde se esta solicitando está realizando esta solicitud
enviarMailOnboarding: Si indica true y el solicitante es preaprobado, se enviará un mail para que realice una validación por mediod de autogestión.
Actualización 2026:
En el response se incorpora monto, cuotas, importeCuota que corresponden a la mejor oferta y en la llave "grillaOferta", tendrá todas las opciones de financiamiento a las que accede.
Debe ingresar al menos los datos de "Ingresos" y el "DNI/CUIT/CUIL" (en los casos de DNI, si el mismo fuera duplicado, se deberá ingresar el CUIT/CUIL).
El response, brindará un primer conjunto de datos con todas las opciones de financiación a las que califica la persona. El segundo conjunto de datos presentará el resultado de la calificación de la persona.
La calificación se realiza de acuerdo a la parametría que ingresa en cada línea de crédito. En caso que tenga configurada una bureau de crédito, se obtiene la calificación en la bureau, de BCRA y se ejecuta según el criterio de aceptación de la línea de crédito.
Datos de request:
"CUIT": Número de DNI/CUIT/CUIL de persona física a calificar.
"ingresos": Monto de ingresos mensuales de la persona a calificar.
"maxMonto": OPCIONAL monto máximo por el que desea obtener las opciones de calificación. Si indica NULL o 0 (cero), presentará todas las opciones de financiación.
"maxImporteCuota": OPCIONAL importe de cuota máximo por el que desea obtener las opciones de financiación. Si indica NULL o 0 (cero), presentará todas las opciones de financiación.
"lineaCredito": OPCIONAL código de línea de crédito por la que se calificará a la persona. Si indica NULL o 0 (cero), calificará con todas las líneas habilitadas.
Establece el estado de un preaprobado. Los estados disponibles para asignar los puede consultar en el end-point /lending/statusCodes.
Si el estado, genera la liquidación del préstamo, en el response obtendrá el número en "idPrestamo".
Autenticación
Bearer token
Body
JSON
Ejemplo de request
{
"idPreaprobado": 35,
"nuevoEstado": 10,
"fecha": "2022-05-27",
"formaLiquidacion": 6,
"observaciones": "Prueba de liquidación con forma de pago transferencia (end-point con formas de pago: /payments/paymentMethods)."
}
Envía un SMS a un dispositivo celular con un código, el cual, lo podrá validar con el método savePhone. Es requisito informar el número de preaprobado que obtuvo en la calificación para que la plataforma pueda relacionar la validación con el preaprobado.
Envía un e-mail, el cual, lo podrá validar con el método saveMail. Es requisito informar el número de preaprobado que obtuvo en la calificación para que la plataforma pueda relacionar la validación con el preaprobado.
Si indica "enviarCodigo":true, se enviará un mail con un código de 4 dígitos.
si indica "enviarCodigo":true, se enviará un mail de validación con un link. El link y la plantilla de mail, deberá configurarla previamente en la plataforma SB.
Actualiza los datos de un prospecto que realizó la solicitud de calificación y resultó preaprobado. Todos los campos de códigos deben ser completados con los códigos de los listados especificados en el párrafo de Clientes.
Importante: Para documentos de Argentina, debe completar el CUIL. El número de documento, debe coincidir con el número de documento de la solicitud de preaprobado. Se recomienda utilizar los datos ya completados en el preaprobado para evitar que el prospecto cargue dos veces los mismos.
Guarda para un documento la aceptación de los términos y condiciones. Es requisito indicar el id de preaprobado, documento y la IP desde la cual se está aceptando.
Genera una suscripción a Mobbex indicando el documento del cliente, el número de preaprobado asociado y la URL a la que debe redirigir cuando complete la suscripción.
Envío:
nroDocumento: número de documento del cliente.
idPreaprobado: número de preaprobado asociado.
returnURL: URL que reenviará mobbex al cliente una vez que complete la suscripción.
customTheme OPCIONAL: permite completar el JSON original de Mobbex para personalizar la UI. Para completarlo debe vertificar la documentación de mobbex. Si no cumple las caracteristicas definidas por Mobbex puede presentar errores o no funcionar la UI personalizada.
Respuesta:
nroDocumento: número de documento del cliente.
idPreaprobado: número de preaprobado asociado.
status: "OK" o mensaje de error.
subscriptionURL: URL a la que deberá acceder para realizar la suscripción.
Verifica estado de una suscripción a Mobbex indicando el documento del cliente o el número de preaprobado asociado.
Envío:
nroDocumento: número de documento del cliente.
idPreaprobado: número de preaprobado asociado.
si indica idPreaprobado, no se requiere el número de documento.
Respuesta:
nroDocumento: número de documento del cliente.
idPreaprobado: número de preaprobado asociado.
status: "OK" indica que esta suscripto, "" (vacío) indica que no hay suscripción, "PENDING" indica que se generó suscripción pero no hay una tarjeta tokenizada. Cualquier otro status corresponde a un mensaje de error.
subscriptionURL: URL de mobbex donde se puede ver/actualizar la suscripción.
El onboarding permite a aquellas entidades que quieran integrar los servicios desde una app o web y no quieran realizar la integración mediante una calificación o bien para aquellas entidades que quieran brindar servicios a su cartera de clientes vigentes.
Aquí podrá encontrar distintos métodos para validar identidad y vías de contacto con los clientes.
Presenta los puntos de onboarding que un cliente inicio o completo. El end-point debe completarlo de la siguiente forma:
lending/statusOnboarding/{DNI}
donde {DNI} debe completar el DNI del cliente.
Los códigos de onboarding son los siguientes:
1 - Validación de identidad
2 - Validación de CBU
3 - Validación de celular
4 - Validación de e-mail
5 - Suscripción tarjeta de débito
99 - Aceptar términos y condiciones
La respuesta es la siguiente
Código: código de onboarding.
ValorInicial: Cuando se inicia la validación en el end-point correspondiente a la misma, se guardan los valores iniciales. Por ejemplo, en validación de celular, se guarda el código enviado al celular del cliente.
ValorFinal: Cuando se completa la validación del punto, se guarda un valor final.
Fecha: Fecha en que se realizó la validación.
Estado: 1 significa que la validación está completada. 9 significa que la validación se inicio y aún no se completó.
Realiza un alta o actualización de prospecto/cliente. Todos los campos de códigos deben ser completados con los códigos de los listados especificados en el párrafo Clientes.
En el caso de clientes ya registrados, puede recuperar la contraseña ingresando el DNI y un mensaje SMS será enviado a su celular con el código de validación.
Autenticación
Bearer token
Body
JSON
Ejemplo de request
{
"nroDocumento": 30000000
}
Respuesta 200 OK
{
"nroDocumento": 20300000001,
"idPreaprobado": 0,
"status": "Verifique el SMS enviado a 11********00 para continuar.",
"codigo": "8669"
}
POST
Ingresar nueva contraseña SMS
{{SB.url}}/lending/resetLoginSMS
En el caso de coincidencia con el código enviado en los últimos 5 min. por celular podrá ingresar una nueva contraseña de acceso.
Genera una suscripción a Mobbex indicando el documento del cliente, el número de preaprobado asociado y la URL a la que debe redirigir cuando complete la suscripción.
Envío:
nroDocumento: número de documento del cliente.
returnURL: URL que reenviará mobbex al cliente una vez que complete la suscripción.
customTheme OPCIONAL: permite completar el JSON original de Mobbex para personalizar la UI. Para completarlo debe vertificar la documentación de mobbex. Si no cumple las caracteristicas definidas por Mobbex puede presentar errores o no funcionar la UI personalizada.
Respuesta:
nroDocumento: número de documento del cliente.
idPreaprobado: valor fijo cero.
status: "OK" o mensaje de error.
subscriptionURL: URL a la que deberá acceder para realizar la suscripción.
Permite generar un legajo digital de cliente, adjuntando, visualizando y descargando documentación relacionada al mismo a sus solicitudes.
Para referenciar a un cliente o solicitud debe utilizar "idReferencia" indicando el número de cliente o número de preaprobado.
IMPORTANTE: Recuerde configurar el idCliente y idPreaprobado en distintos rangos numéricos, si es que utilizará ambas referencias para el legajo digital.
Permite adjuntar documentación referenciando a un idCliente o idPreaprobado. El documento debe estar en formato Base64.
Envio:
idReferencia: Id de cliente o nro. de documento.
idComplementario: Id de preaprobado.
nombreArchivo: El nombre del archivo que se está adjuntando.
descripcion: Una descripción opcional del archivo que está adjuntando.
base64: El archivo en formato base64.
Respuesta:
errorCode: 0 si se adjunto exitosamente o el código de error.
idReferencia: idReferencia enviado.
idAdjunto: Código asignado al adjunto enviado.
status: "OK" si se adjunto exitosamente o el mensaje de error.
Si indica idComplementario no debe indicar el idReferencia.
Ejemplo de uso. Si esta completando una solicitud de preaprobado, la documentación debe ser enviada con idReferencia en cero y idComplementario con el número de preaprobado.
Si está completando un onboarding de un prospecto, que no es cliente, debe indicar en idReferencia el nro. de documento.
Si está adjuntando documentación sobre préstamos, pagos o cualquier referencia sobre clientes de la cartera, debe ingresar idReferencia con el número de cliente.
Para el alta de usuarios API, la URL base de cada entorno, la habilitación de módulos (cuotario, Data Analytics, firma electrónica, onboarding) o cualquier consulta sobre la integración, contactar a la mesa de ayuda de SB Software.
