Skip to content

S
swagger
Commit 00b5d376 by Cristian_Camargo
Options

Update credito-creditos.json

parent 1bd04176
Showing with 108 additions and 1029 deletions
apigee/credito-creditos.json
{
"openapi": "3.0.0",
"servers": [
"resultado": [
{
"description": "Calidad",
"url": "https://colsubsidio-test.apigee.net/api"
},
{
"description": "Producción",
"url": "https://colsubsidio-prod.apigee.net/api"
}
],
"info": {
"description": "Información de los servicios del producto credito.",
"version": "1.0.0",
"title": "Credito creditos",
"termsOfService": "http://172.16.95.36/wiki/index.php/T%C3%A9rminos_de_servicio_Swagger",
"contact": {
"email": "operacionesti@colsubsidio.com"
},
"license": {
"name": "Colsubsidio",
"url": "http://172.16.95.36/wiki/index.php/T%C3%A9rminos_de_servicio_Swagger"
}
},
"tags": [
{
"name": "cols-credito-obligaciones",
"description": "Consulta de obligacion crediticia"
},
{
"name": "cols-credito-solicitudes",
"description": "Consulta de solicitudes de credito."
"codigo": "-respuesta",
"descripcion": ""
}
],
"paths": {
"/v2/credito/obligaciones/{obligacionId}": {
"get": {
"tags": [
"cols-credito-obligaciones"
],
"summary": "Consulta obligacion detallada",
"description": "Obtener información de una obligación crediticia en detalle.",
"operationId": "getObligacionesDetalle",
"parameters": [
"obtenerHistoriaCredito": [
{
"name": "obligacionId",
"in": "path",
"description": "Identificador de la obligación crediticia de la que se quiere conocer el detalle.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Operación exitosa",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/getObligacionesDetalleResponse"
}
}
}
},
"400": {
"description": "Estado inválido"
}
"independiente": "-esIndependiente",
"validada": "naturalNacional.-validada",
"edadMinima": "naturalNacional.-min",
"edadMaxima": "naturalNacional.-max",
"fechaConsulta": "-fechaConsulta",
"informacionPersonal":{
"nombre": {
"primero": "naturalNacional.-nombres",
"segundo": "",
"primerApellido": "naturalNacional.-primerApellido",
"segundoApellido": "naturalNacional.-segundoApellido",
"completo": "naturalNacional.-nombreCompleto"
},
"security": [
{
"apigee_auth": [
"write:apigee",
"read:apigee"
]
}
]
}
"documento": {
"numero": "naturalNacional.identificacion.-numero",
"fecha": "naturalNacional.identificacion.-fechaExpedicion",
"vigencia": "naturalNacional.identificacion.-estado"
},
"/v2/credito/solicitudes": {
"get": {
"tags": [
"cols-credito-solicitudes"
],
"summary": "Consulta de solicitudes de credito usuario.",
"description": "Consulta de solicitudes de credito para un usuario.",
"operationId": "getSolicitudesCredito",
"parameters": [
{
"name": "tipoId",
"in": "query",
"description": "Tipo de identificacion.",
"required": true,
"schema": {
"type": "string"
}
"direccion": {
"departamento": {
"nombre": "naturalNacional.identificacion.-departamento"
},
{
"name": "numId",
"in": "query",
"description": "Numero de identificacion.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Operación exitosa",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/getSolicitudesCreditoResponse"
}
}
"ciudad": {
"nombre": "naturalNacional.identificacion.-ciudad"
}
},
"400": {
"description": "Estado inválido"
"genero": {
"codigo": "naturalNacional.-genero"
}
},
"security": [
"puntuacion": {
"valor": "score.-puntaje",
"tipo": "score.-tipo",
"razon": [
{
"apigee_auth": [
"write:apigee",
"read:apigee"
]
"codigo": "score.razon"
}
]
}
},
"/v2/credito/solicitudes/natural": {
"get": {
"tags": [
"cols-credito-solicitudes"
],
"summary": "Consulta de historia de credito PN.",
"description": "Consulta de historia de credito para personas naturales.",
"operationId": "consultaHistoriaCreditoNatural",
"parameters": [
"cuenta": [
{
"name": "usuarioId",
"in": "query",
"description": "Numero de identificacion del usuario.",
"required": true,
"schema": {
"type": "number"
}
"tipo": "ahorro o corriente",
"bloqueada": "-bloqueada",
"numero": "-numeroCuenta",
"fechaApertura": "-fechaApertura",
"fechaActualizacion": "-ultimaActualizacion",
"situacionTitular": "-situacionTitular",
"estado": {
"codigo": "-estado"
},
{
"name": "tipoId",
"in": "query",
"description": "Tipo del documento de identificacion del usuario.",
"required": true,
"schema": {
"type": "number"
}
"ciudad": {
"nombre": "-ciudad"
},
{
"name": "numId",
"in": "query",
"description": "Numero del documento de identificacion del usuario.",
"required": true,
"schema": {
"type": "number"
"entidad": {
"nombre": "-entidad",
"sede": {
"ciudad":{
"nombre":"-oficina"
}
},
{
"name": "primerApellido",
"in": "query",
"description": "Primer apellido del usuario.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "clave",
"in": "query",
"description": "Clave del producto.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Operación exitosa",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/consultaHistoriaCreditoNaturalResponse"
}
}
}
},
"400": {
"description": "Estado inválido"
}
},
"security": [
"obligacion": [
{
"apigee_auth": [
"write:apigee",
"read:apigee"
]
}
]
}
}
},
"externalDocs": {
"description": "Encontrar más información en EnterpriseArchitect",
"url": "http://172.16.95.36/wiki/index.php/Enterprise_Architect"
},
"components": {
"schemas": {
"resultado": {
"type": "object",
"properties": {
"codigo": {
"type": "string",
"description": "Código del resultado"
},
"descripcion": {
"type": "string",
"description": "Descripción del resultado"
}
},
"xml": {
"name": "resultado"
}
},
"cuota": {
"type": "object",
"properties": {
"valor": {
"type": "string",
"description": "Numero de cuotas pactadas"
},
"pactada": {
"type": "string",
"description": "Numero de cuotas pactadas"
},
"pagada": {
"type": "string",
"description": "Numero de cuotas pagadas"
},
"vencida": {
"type": "string",
"description": "Numero de cuotas vencidas"
},
"solicitado": {
"type": "string",
"description": "Numero de cuotas solicitadas"
},
"aprobado": {
"type": "string",
"description": "Numero de cuotas aprobadas"
}
},
"xml": {
"name": "cuota"
}
},
"canal": {
"type": "object",
"properties": {
"codigo": {
"type": "string",
"description": "Codigo del canal."
},
"descripcion": {
"type": "string",
"description": "Descripcion del canal."
}
},
"xml": {
"name": "canal"
}
},
"edad": {
"type": "object",
"properties": {
"valor": {
"type": "string",
"description": "Numero de la edad."
},
"numeroVeces": {
"type": "string",
"description": "Numero de veces de la edad."
}
},
"xml": {
"name": "edad"
}
},
"mora": {
"type": "object",
"properties": {
"saldo": {
"type": "string",
"description": "Saldo de la mora."
},
"maxima": {
"type": "string",
"description": "Maximo valor de la mora."
},
"dias": {
"type": "string",
"description": "Dias de mora."
},
"edad": {
"$ref": "#/components/schemas/edad"
}
},
"xml": {
"name": "mora"
}
},
"garantia": {
"type": "object",
"properties": {
"tipo": {
"type": "string",
"description": "Tipo de garantia."
},
"descripcion": {
"type": "string",
"description": "Descripcion de la garantia."
}
},
"xml": {
"name": "garantia"
}
},
"consultaDetalle": {
"type": "object",
"properties": {
"cuota": {
"$ref": "#/components/schemas/cuota"
},
"canal": {
"$ref": "#/components/schemas/canal"
},
"mora": {
"$ref": "#/components/schemas/mora"
},
"garantia": {
"$ref": "#/components/schemas/garantia"
},
"sistema": {
"$ref": "#/components/schemas/sistema"
},
"valorDesembolsado": {
"type": "string",
"description": "Valor desembolsado del credito."
},
"tasaInteres": {
"type": "string",
"description": "Valor de la tasa de interes corriente."
},
"diaFijoPago": {
"type": "string",
"description": "Dia fijo de pago"
}
},
"xml": {
"name": "consultaDetalle"
}
},
"getObligacionesDetalleResponse": {
"type": "object",
"required": [
"resultado"
],
"properties": {
"resultado": {
"type": "array",
"xml": {
"name": "resultado"
},
"items": {
"$ref": "#/components/schemas/resultado"
}
},
"consultaDetalle": {
"type": "array",
"items": {
"$ref": "#/components/schemas/consultaDetalle"
}
}
}
},
"fecha": {
"type": "object",
"properties": {
"radicacion": {
"type": "string",
"format": "date-time",
"description": "Fecha de radicacion."
},
"proceso": {
"type": "string",
"format": "date-time",
"description": "Fecha de proceso."
},
"pago": {
"type": "string",
"format": "date-time",
"description": "Fecha de pago."
}
},
"xml": {
"name": "fecha"
}
},
"plazo": {
"type": "object",
"properties": {
"solicitado": {
"type": "string",
"description": "Plazo solicitado."
},
"aprobado": {
"type": "string",
"description": "Plazo aprobado."
}
},
"xml": {
"name": "plazo"
}
},
"valor": {
"type": "object",
"properties": {
"cuota": {
"$ref": "#/components/schemas/cuota"
},
"solicitado": {
"type": "string",
"description": "Valor solicitado."
},
"aprobado": {
"type": "string",
"description": "Valor aprobado."
}
},
"xml": {
"name": "valor"
}
},
"sistema": {
"type": "object",
"properties": {
"financiacion": {
"type": "string",
"description": "Sistema de financiacion"
},
"amortizacion": {
"type": "string",
"description": "Sistema de amortizacion"
}
},
"xml": {
"name": "sistema"
}
},
"solicitudCredito": {
"type": "object",
"properties": {
"fecha": {
"$ref": "#/components/schemas/fecha"
},
"plazo": {
"$ref": "#/components/schemas/plazo"
},
"valor": {
"$ref": "#/components/schemas/valor"
},
"sistema": {
"$ref": "#/components/schemas/sistema"
},
"linea": {
"type": "string",
"description": "Linea."
},
"lineaOriginal": {
"type": "string",
"description": "Linea original."
},
"garantia": {
"type": "string",
"description": "Garantia."
},
"procesoActual": {
"type": "string",
"description": "Proceso actual"
},
"codigo": {
"type": "string",
"description": "Codigo de la solicitud"
}
},
"xml": {
"name": "solicitudCredito"
}
},
"obligacionEndeudamiento": {
"type": "object",
"properties": {
"tipo": {
"type": "string",
"description": "Tipo de obligacion. Posibles valores: 'credito' o 'cartera'."
},
"numero": {
"type": "string",
"description": "Numero de la cuenta."
"tipo": "credito o cartera",
"bloqueada": "-bloqueada",
"numero": "-numero",
"fechaApertura": "-fechaApertura",
"fechaActualizacion": "-ultimaActualizacion",
"situacionTitular": "-situacionTitular",
"amparada": "-amparada",
"obligacion": "-tipoObligacion",
"cupo": "valores.-cupo",
"saldo": "valores.-saldoActual",
"saldoInicial": "valores.-valorInicial",
"garantia": "-garante",
"comportamiento": "-comportamiento",
"positivoNegativo": "-positivoNegativo",
"fechaVencimiento": "-fechaVencimiento",
"estado": {
"codigo": "-estado",
"origen": "-estadoOrigen"
},
"entidad": {
"$ref": "#/components/schemas/entidad"
"nombre": "-entidad",
"sede": {
"ciudad":{
"nombre":"-oficina"
}
},
"xml": {
"name": "obligacion"
}
},
"obligacion": {
"type": "object",
"properties": {
"tipo": {
"type": "string",
"description": "Tipo de obligacion. Posibles valores: 'credito' o 'cartera'."
},
"bloqueada": {
"type": "boolean",
"description": "Valida si la cuenta esta bloqueada."
},
"numero": {
"type": "string",
"description": "Numero de la cuenta."
},
"fechaApertura": {
"type": "string",
"format": "date-time",
"description": "Fecha de apertura de la cuenta."
},
"fechaActualizacion": {
"type": "string",
"format": "date-time",
"description": "Fecha de actualizacion."
},
"situacionTitular": {
"type": "string",
"description": "situacion del titular."
},
"amparada": {
"type": "boolean",
"description": "Si tiene garante esta amparada. True si esta amparada, false de lo contrario."
},
"obligacion": {
"type": "string",
"description": "Tipo de obligacion."
},
"cupo": {
"type": "string",
"description": "Cupo de la obligacion."
},
"saldo": {
"type": "string",
"description": "Saldo de la obligacion."
},
"saldoInicial": {
"type": "string",
"description": "Saldo inicial de la obligacion."
},
"garantia": {
"type": "string",
"description": "Garantia."
},
"comportamiento": {
"type": "string",
"description": "Comportamiento."
},
"positivoNegativo": {
"type": "string",
"description": "positivoNegativo."
},
"fechaVencimiento": {
"type": "string",
"format": "date-time",
"description": "Fecha de vencimiento de la obligacion."
},
"estado": {
"$ref": "#/components/schemas/estado"
},
"ciudad": {
"$ref": "#/components/schemas/ciudad"
},
"entidad": {
"$ref": "#/components/schemas/entidad"
},
"cuenta": {
"type": "object",
"properties": {
"tipo": {
"type": "string",
"description": "Tipo de la cuenta."
}
}
"tipo": "-tipoCuenta"
},
"contrato": {
"$ref": "#/components/schemas/contrato"
"tipo": "-tipoContrato",
"permanencia": "-mesePermanencia",
"tiempo": "-ejecucionContrato"
},
"pago": {
"$ref": "#/components/schemas/pago"
"forma": "-formaPago",
"periodicidad": "-periodicidad"
},
"cuota": {
"$ref": "#/components/schemas/cuota"
"valor": "valores.-cuota",
"pagada": "valores.-cuotasCanceladas",
"pactada": "valores.-totalCuotas"
},
"mora": {
"$ref": "#/components/schemas/mora"
"saldo": "valores.-saldoMora",
"maxima": "valores.-maximaMora"
}
},
"xml": {
"name": "obligacion"
}
},
"consulta": {
"type": "object",
"properties": {
"fecha": {
"type": "string",
"format": "date-time",
"description": "Fecha de consulta."
},
"razon": {
"type": "string",
"description": "Razon de consulta."
},
"cuenta": {
"type": "object",
"properties": {
"tipo": {
"type": "string",
"description": "Tipo de cuenta"
}
}
},
"ciudad": {
"$ref": "#/components/schemas/ciudad"
},
"entidad": {
"$ref": "#/components/schemas/entidad"
}
},
"xml": {
"name": "consulta"
}
},
"endeudamiento": {
"type": "object",
"properties": {
"calificacion": {
"type": "string",
"description": "Calificacion de endeudamiento."
},
"saldoPendiente": {
"type": "string",
"description": "Saldo pendiente."
},
"fechaReporte": {
"type": "string",
"format": "date-time",
"description": "Fecha de reporte."
},
"garantia": {
"type": "string",
"description": "Garante."
},
"moneda": {
"type": "string",
"description": "Moneda."
},
"obligacion": {
"$ref": "#/components/schemas/obligacionEndeudamiento"
}
},
"xml": {
"name": "endeudamiento"
}
},
"pago": {
"type": "object",
"properties": {
"forma": {
"type": "string",
"description": "Forma de pago."
},
"periodicidad": {
"type": "string",
"description": "Periodicidad pago."
}
},
"xml": {
"name": "pago"
}
},
"contrato": {
"type": "object",
"properties": {
"tipo": {
"type": "string",
"description": "Tipo de contrato."
},
"permanencia": {
"type": "string",
"description": "Permanencia del contrato."
},
"tiempo": {
"type": "string",
"description": "Nombre de la entidad."
}
},
"xml": {
"name": "contrato"
}
},
],
"endeudamiento": [
{
"calificacion": "endeudamientoGlobal.-calificacion",
"saldoPendiente": "endeudamientoGlobal.-saldoPendiente",
"fechaReporte": "endeudamientoGlobal.-fechaReporte",
"garantia": "endeudamientoGlobal.-garantia",
"moneda": "endeudamientoGlobal.-moneda",
"obligacion":{
"tipo": "endeudamientoGlobal.-tipoCredito",
"numero":"endeudamientoGlobal.-numeroCreditos",
"entidad": {
"type": "object",
"properties": {
"nombre": {
"type": "string",
"description": "Nombre de la entidad."
},
"sede": {
"$ref": "#/components/schemas/ciudad"
"nombre": "endeudamientoGlobal.-entidad"
}
},
"xml": {
"name": "entidad"
}
},
"estado": {
"type": "object",
"properties": {
"codigo": {
"type": "string",
"description": "codigo de estado."
},
"origen": {
"type": "string",
"description": "Origen del estado."
}
},
"xml": {
"name": "estado"
}
},
],
"consulta": [
{
"fecha": "consulta.-fecha",
"razon": "consulta.-razon",
"cuenta": {
"type": "object",
"properties": {
"tipo": {
"type": "string",
"description": "Tipo de cuenta. Posibles valores: 'ahorro' o 'corriente'."
},
"bloqueada": {
"type": "boolean",
"description": "Valida si la cuenta esta bloqueada."
},
"numero": {
"type": "string",
"description": "Numero de la cuenta."
},
"fechaApertura": {
"type": "string",
"format": "date-time",
"description": "Fecha de apertura de la cuenta."
},
"fechaActualizacion": {
"type": "string",
"format": "date-time",
"description": "Fecha de actualizacion."
},
"situacionTitular": {
"type": "string",
"description": "situacion del titular."
},
"estado": {
"$ref": "#/components/schemas/estado"
"tipo":"consulta.-tipoCuenta"
},
"ciudad": {
"$ref": "#/components/schemas/ciudad"
"nombre": "consulta.-ciudad"
},
"entidad": {
"$ref": "#/components/schemas/entidad"
}
},
"xml": {
"name": "cuenta"
}
},
"razon": {
"type": "object",
"properties": {
"codigo": {
"type": "string",
"description": "Codigo de razon."
}
},
"xml": {
"name": "razon"
}
},
"puntuacion": {
"type": "object",
"properties": {
"valor": {
"type": "string",
"description": "Valor del puntuacion o score."
},
"tipo": {
"type": "string",
"description": "Tipo de puntuacion o score."
},
"razon": {
"type": "array",
"items": {
"$ref": "#/components/schemas/razon"
}
}
},
"xml": {
"name": "puntuacion"
}
},
"genero": {
"type": "object",
"properties": {
"codigo": {
"type": "string",
"description": "Codigo del genero."
}
},
"xml": {
"name": "genero"
}
},
"departamento": {
"type": "object",
"properties": {
"nombre": {
"type": "string",
"description": "Nombre del departamento."
}
},
"xml": {
"name": "departamento"
}
},
"ciudad": {
"type": "object",
"properties": {
"nombre": {
"type": "string",
"description": "Nombre de la ciudad."
}
},
"xml": {
"name": "ciudad"
}
},
"direccion": {
"type": "object",
"properties": {
"departamento": {
"$ref": "#/components/schemas/departamento"
},
"ciudad": {
"$ref": "#/components/schemas/ciudad"
}
},
"xml": {
"name": "direccion"
}
},
"documento": {
"type": "object",
"properties": {
"numero": {
"type": "string",
"description": "Numero de documento."
},
"fecha": {
"type": "string",
"format": "date-time",
"description": "fecha de expedicion del documento."
},
"vigencia": {
"type": "string",
"description": "Vigencia del documento."
}
},
"xml": {
"name": "documento"
}
},
"nombre": {
"type": "object",
"properties": {
"primero": {
"type": "string",
"description": "Primer nombre."
},
"segundo": {
"type": "string",
"description": "segundo nombre."
},
"primerApellido": {
"type": "string",
"description": "Primer apellido."
},
"segundoApellido": {
"type": "string",
"description": "Segundo apellido."
},
"completo": {
"type": "string",
"description": "Nombre completo."
}
},
"xml": {
"name": "nombre"
}
},
"informacionPersonal": {
"type": "object",
"properties": {
"nombre": {
"$ref": "#/components/schemas/nombre"
},
"documento": {
"$ref": "#/components/schemas/documento"
},
"direccion": {
"$ref": "#/components/schemas/direccion"
},
"genero": {
"$ref": "#/components/schemas/genero"
}
},
"xml": {
"name": "informacionPersonal"
}
},
"obtenerHistoriaCredito": {
"type": "object",
"properties": {
"independiente": {
"type": "boolean",
"description": "Indica si la persona es independiente."
},
"validada": {
"type": "boolean",
"description": "True si esta validado contra la registraduría, false si esta validado contra otras fuentes de información, lo cual incluye otros suscriptores."
},
"edadMinima": {
"type": "string",
"description": "Edad minima."
},
"edadMaxima": {
"type": "string",
"description": "Edad maxima."
},
"fechaConsulta": {
"type": "string",
"format": "date-time",
"description": "Fecha en que se realiza la consulta."
},
"informacionPersonal": {
"$ref": "#/components/schemas/informacionPersonal"
},
"puntuacion": {
"$ref": "#/components/schemas/puntuacion"
},
"cuenta": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cuenta"
}
},
"obligacion": {
"type": "array",
"items": {
"$ref": "#/components/schemas/obligacion"
}
},
"endeudamiento": {
"type": "array",
"items": {
"$ref": "#/components/schemas/endeudamiento"
}
},
"consulta": {
"type": "array",
"items": {
"$ref": "#/components/schemas/consulta"
}
}
},
"xml": {
"name": "obtenerHistoriaCredito"
}
},
"consultaHistoriaCreditoNaturalResponse": {
"type": "object",
"required": [
"resultado"
],
"properties": {
"resultado": {
"type": "array",
"xml": {
"name": "resultado"
},
"items": {
"$ref": "#/components/schemas/resultado"
}
},
"obtenerHistoriaCredito": {
"type": "array",
"items": {
"$ref": "#/components/schemas/obtenerHistoriaCredito"
}
}
}
},
"getSolicitudesCreditoResponse": {
"type": "object",
"required": [
"resultado"
],
"properties": {
"resultado": {
"type": "array",
"xml": {
"name": "resultado"
},
"items": {
"$ref": "#/components/schemas/resultado"
}
},
"solicitudCredito": {
"type": "array",
"items": {
"$ref": "#/components/schemas/solicitudCredito"
}
}
}
}
},
"requestBodies": {},
"securitySchemes": {
"apigee_auth": {
"type": "oauth2",
"flows": {
"clientCredentials": {
"tokenUrl": "https://colsubsidio-test.apigee.net/oauth/client_credential/accesstoken?grant_type=client_credentials",
"scopes": {
"write:apigee": "Permisos de escritura",
"read:apigee": "Permisos de lectura"
}
"nombre": "consulta.-entidad",
"sede": {
"ciudad":{
"nombre":"consulta.-oficina"
}
}
}
}
]
}
]
}
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment