{ "openapi": "3.0.0", "servers": [ { "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 tarjeta", "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-bolsillo", "description": "Consulta tarjeta" } ], "paths": { "/v2/credito/bolsillos": { "get": { "tags": [ "cols-credito-bolsillo" ], "summary": "Consulta saldo disponible", "description": "Obtener informacion del saldo disponible", "operationId": "getConsultaBolsillo", "parameters": [ { "name": "tipoId", "in": "query", "description": "Tipo de identificacion.", "required": true, "schema": { "type": "string" } }, { "name": "numId", "in": "query", "description": "Número de documento de identificación.", "required": true, "schema": { "type": "string" } }, { "name": "codBolsillo", "in": "query", "description": "Codigo de bolsillo.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Operación exitosa", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getConsultaBolsilloResponse" } } } }, "400": { "description": "Estado inválido" } }, "security": [ { "apigee_auth": [ "write:apigee", "read:apigee" ] } ] } }, "/v2/credito/bolsillos/{cardNumber}": { "get": { "tags": [ "cols-credito-bolsillo" ], "summary": " información del estado de cada bolsillo de la Tarjeta Multiservicios", "description": "Servicio para obtener la información del estado de cada bolsillo de la Tarjeta Multiservicios.", "operationId": "getConsultaEstado", "parameters": [ { "name": "cardNumber", "in": "path", "description": "Número de la tarjeta Multiservicios.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Operación exitosa", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EstadoPorTarjetaResponse" } } } }, "400": { "description": "Estado inválido" } }, "security": [ { "apigee_auth": [ "write:apigee", "read:apigee" ] } ] } }, "/v2/credito/bolsillos/movimiento": { "get": { "tags": [ "cols-credito-bolsillo" ], "summary": "Consulta de movimiento", "description": "Obtener informacion de los movimientos", "operationId": "obtenerMovimiento", "parameters": [ { "name": "numTarjeta", "in": "query", "description": "Numero de la tarjeta de credito.", "required": true, "schema": { "type": "string" } }, { "name": "codBolsillo", "in": "query", "description": "Codigo del bolsillo.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Operación exitosa", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/obtenerMovimientoResponse" } } } }, "400": { "description": "Estado inválido" } }, "security": [ { "apigee_auth": [ "write:apigee", "read:apigee" ] } ] } }, "/v2/credito/bolsillos/cupo": { "get": { "tags": [ "cols-credito-bolsillo" ], "summary": "Consulta cupo de cliente.", "description": "Obtener informacion del cupo de clientes.", "operationId": "obtenerCupo", "parameters": [ { "name": "codBolsillo", "in": "query", "description": "Codigo de bolsillo de cliente.", "required": true, "schema": { "type": "string" } }, { "name": "numTarjeta", "in": "query", "description": "Numero de tarjeta del cliente.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Operación exitosa", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/obtenerCupoResponse" } } } }, "400": { "description": "Estado inválido" }, "500": { "description": "Error en el servidor" } }, "security": [ { "apigee_auth": [ "write:apigee", "read:apigee" ] } ] } }, "/v2/credito/bolsillos/estado": { "get": { "tags": [ "cols-credito-bolsillo" ], "summary": "Consulta estado de bolsillo.", "description": "Obtener informacion del estado del bolsillo.", "operationId": "consultaEstadoBolsillo", "parameters": [ { "name": "numTarjeta", "in": "query", "description": "Numero de la tarjeta del cliente.", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "description": "Operación exitosa", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/consultaEstadoBolsilloResponse" } } } }, "400": { "description": "Estado inválido" } }, "security": [ { "apigee_auth": [ "write:apigee", "read:apigee" ] } ] } }, "/v2/credito/bolsillos/tarjetas": { "get": { "tags": [ "cols-credito-bolsillo" ], "summary": "Consulta tarjetas del cliente.", "description": "Obtener informacion de las tarjetas del cliente.", "operationId": "consultaTarjetaDocumento", "parameters": [ { "name": "tipoId", "in": "query", "description": "Tipo de documento de identificacion.", "required": true, "schema": { "type": "number" } }, { "name": "numId", "in": "query", "description": "Numero del documento de identificacion.", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "description": "Operación exitosa", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/consultaTarjetaDocumentoResponse" } } } }, "400": { "description": "Estado inválido" } }, "security": [ { "apigee_auth": [ "write:apigee", "read:apigee" ] } ] } }, "/v2/credito/bolsillos/pago": { "get": { "tags": [ "cols-credito-bolsillo" ], "summary": "Consulta pago del bolsillo de la tarjeta.", "description": "Obtener informacion del pago del bolsillo de la tarjeta.", "operationId": "consultaPagoBolsillo", "parameters": [ { "name": "numTarjeta", "in": "query", "description": "Numero de la tarjeta del cliente.", "required": true, "schema": { "type": "number" } }, { "name": "codBolsillo", "in": "query", "description": "Codigo de bolsillo.", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "description": "Operación exitosa", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/consultaPagoBolsilloResponse" } } } }, "400": { "description": "Estado inválido" } }, "security": [ { "apigee_auth": [ "write:apigee", "read:apigee" ] } ] } }, "/v2/credito/bolsillos/movimiento/debito": { "get": { "tags": [ "cols-credito-bolsillo" ], "summary": "Consulta pago del bolsillo de la tarjeta débito.", "description": "Obtener informacion del pago del bolsillo de la tarjeta débito.", "operationId": "consultaMovimientoBolsilloDebito", "parameters": [ { "name": "numTarjeta", "in": "query", "description": "Numero de la tarjeta del cliente.", "required": true, "schema": { "type": "number" } }, { "name": "codBolsillo", "in": "query", "description": "Codigo de bolsillo.", "required": true, "schema": { "type": "string" } }, { "name": "rangoTiempo", "in": "query", "description": "Rango de tiempo.", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "description": "Operación exitosa", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/consultaPagoBolsilloDebitoResponse" } } } }, "400": { "description": "Estado inválido" } }, "security": [ { "apigee_auth": [ "write:apigee", "read:apigee" ] } ] } }, "/v2/credito/bolsillos/abono/debito": { "get": { "tags": [ "cols-credito-bolsillo" ], "summary": "Consulta pago en abono de la tarjeta débito.", "description": "Consulta pago en abono de la tarjeta débito.", "operationId": "consultaAbonoBolsilloDebito", "parameters": [ { "name": "numTarjeta", "in": "query", "description": "Numero de la tarjeta del cliente.", "required": true, "schema": { "type": "number" } }, { "name": "codBolsillo", "in": "query", "description": "Codigo de bolsillo.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Operación exitosa", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/consultaAbonoDebitoResponse" } } } }, "400": { "description": "Estado inválido" } }, "security": [ { "apigee_auth": [ "write:apigee", "read:apigee" ] } ] } }, "/v2/credito/bolsillos/saldo/debito": { "get": { "tags": [ "cols-credito-bolsillo" ], "summary": "Saldo de la tarjeta débito.", "description": "Saldo de la tarjeta débito.", "operationId": "consultaSaldoDisponibleDebito", "parameters": [ { "name": "tipoId", "in": "query", "description": "Tipo Documento.", "required": true, "schema": { "type": "number" } }, { "name": "numId", "in": "query", "description": "Número de documento.", "required": true, "schema": { "type": "number" } }, { "name": "codBolsillo", "in": "query", "description": "Codigo de bolsillo.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Operación exitosa", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/consultaSaldoDebitoResponse" } } } }, "400": { "description": "Estado inválido" } }, "security": [ { "apigee_auth": [ "write:apigee", "read:apigee" ] } ] } }, "/v2/credito/bolsillos/extracto/tarjeta": { "get": { "tags": [ "cols-credito-bolsillo" ], "summary": "Extracto de la TMS.", "description": "Informacion de extracto de la TMS.", "operationId": "consultaExtractoTms.v2", "parameters": [ { "name": "tipoId", "in": "query", "description": "Tipo de Documento.", "required": true, "schema": { "type": "number" } }, { "name": "numId", "in": "query", "description": "Número de documento.", "required": true, "schema": { "type": "number" } }, { "name": "mes", "in": "query", "description": "Mes del extracto.", "required": true, "schema": { "type": "string" } }, { "name": "ano", "in": "query", "description": "Año del extracto.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Operación exitosa", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/consultaExtractoTmsResponse" } } } }, "400": { "description": "Estado inválido" } }, "security": [ { "apigee_auth": [ "write:apigee", "read:apigee" ] } ] } }, "/v2/credito/bolsillos/estado/pago": { "get": { "tags": [ "cols-credito-bolsillo" ], "summary": "Informacion del estado de pago de la TMS.", "description": "Informacion del estado de pago de la Tarjeta multiservicio.", "operationId": "consultaEstadoPagoTms.v2", "parameters": [ { "name": "idTransaccion", "in": "query", "description": "Numero de identificacion de la transaccion que se consulta el estado de pago.", "required": true, "schema": { "type": "integer" } }, { "name": "tipoTerminal", "in": "query", "description": "Tipo de terminal.", "required": true, "schema": { "type": "string" } }, { "name": "idTerminal", "in": "query", "description": "Numero de identificacion del terminal.", "required": true, "schema": { "type": "string" } }, { "name": "idAdquirente", "in": "query", "description": "Numero de identificacion del adquirente.", "required": true, "schema": { "type": "integer" } }, { "name": "idTransaccionTerminal", "in": "query", "description": "Numero de identificacion de la transaccion del terminal.", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Operación exitosa", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/consultaEstadoPagoTmsResponse" } } } }, "400": { "description": "Estado inválido" } }, "security": [ { "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": { "consultaEstadoPagoTmsResponse": { "type": "object", "required": [ "resultado" ], "properties": { "resultado": { "type": "array", "xml": { "name": "resultado" }, "items": { "$ref": "#/components/schemas/resultado" } }, "consultaEstadoPago": { "type": "array", "items": { "$ref": "#/components/schemas/consultaEstadoPago" } } } }, "consultaEstadoPago": { "type": "object", "properties": { "transaccion": { "$ref": "#/components/schemas/consultaEstadoPagoTransaccion" } } }, "consultaEstadoPagoTransaccion": { "type": "object", "properties": { "estado": { "type": "string", "description": "Estado de transaccion." }, "idAdquirente": { "type": "string", "description": "Numero de identificacion del adquirente." }, "terminal": { "type": "object", "properties": { "id": { "type": "string", "description": "Numero de identificacion del terminal." }, "idTransaccion": { "type": "string", "description": "Numero de identificacion de la transaccion." }, "tipo": { "type": "string", "description": "Tipo del terminal." } } } } }, "consultaExtractoTmsResponse": { "type": "object", "required": [ "resultado" ], "properties": { "resultado": { "type": "array", "xml": { "name": "resultado" }, "items": { "$ref": "#/components/schemas/resultado" } }, "extractoCupoCredito": { "type": "array", "items": { "$ref": "#/components/schemas/consultaExtractoTms" } } } }, "afiliadoConsultaExtractoTms": { "type": "object", "properties": { "nombre": { "type": "object", "properties": { "completo": { "type": "string", "description": "Nombre completo del afiliado." }, } }, "direccion": { "type": "object", "properties": { "direccionPrincipal": { "type": "string", "description": "Direccion principal del afiliado." }, "barrio": { "type": "string", "description": "Barrio del afiliado." }, } }, "departamento": { "type": "object", "properties": { "nombre": { "type": "string", "description": "Nombre del departamento." }, } }, "ciudad": { "type": "object", "properties": { "nombre": { "type": "string", "description": "Nombre de la ciudad." } } } } }, "cupoConsultaExtractoTms": { "type": "object", "properties": { "total": { "type": "string", "description": "Total del cupo" }, "saldo": { "type": "string", "description": "Saldo del cupo" }, "avance": { "type": "object", "properties": { "total": { "type": "string", "description": "Total del cupo avance" }, "saldo": { "type": "string", "description": "Saldo del cupo avance" } } } } }, "minimoConsultaExtractoTms": { "type": "object", "properties": { "saldoMora": { "type": "string", "description": "Saldo en mora" }, "consumoMes": { "type": "string", "description": "Consumo del mes" }, "avanceMes": { "type": "string", "description": "Avance del mes" }, "tasaTramite": { "type": "string", "description": "Tasa de tramite" }, "ajuste": { "type": "string", "description": "Ajuste de debito" }, "valor": { "type": "string", "description": "Valor del pago minimo" }, "diferido": { "type": "object", "properties": { "cargo": { "type": "string", "description": "Cargos anteriores diferidos" } } }, "interes": { "type": "object", "properties": { "corriente": { "type": "string", "description": "Interes corriente" }, "mora": { "$ref": "#/components/schemas/moraConsultaExtractoTms" } } } } }, "moraConsultaExtractoTms": { "type": "object", "properties": { "valor": { "type": "string", "description": "Interes en mora" } } }, "totalConsultaExtractoTms": { "type": "object", "properties": { "saldoAnterior": { "type": "string", "description": "Saldo anterior" }, "creditos": { "type": "string", "description": "Creditos" }, "consumoMes": { "type": "string", "description": "Consumo del mes" }, "avanceMes": { "type": "string", "description": "Avance del mes" }, "tasaTramite": { "type": "string", "description": "Tasa de tramite" }, "ajuste": { "type": "string", "description": "Ajuste de debito" }, "valor": { "type": "string", "description": "Valor del pago total" }, "interes": { "type": "object", "properties": { "corriente": { "type": "string", "description": "Interes corriente" }, "mora": { "$ref": "#/components/schemas/moraConsultaExtractoTms" } } } } }, "interesConsultaExtractoTms": { "type": "object", "properties": { "mora": { "type": "object", "properties": { "efectivoAnual": { "type": "string", "description": "Interes en mora efectivo anual" }, "nominalMensual": { "type": "string", "description": "Interes en mora nominal mensual" }, } }, "compra": { "type": "object", "properties": { "efectivoAnual": { "type": "string", "description": "Interes de compra efectivo anual" }, "nominalMensual": { "type": "string", "description": "Interes de compra nominal mensual" }, } }, "cuota": { "type": "object", "properties": { "efectivoAnual": { "type": "string", "description": "Interes de cuota efectivo anual" }, "nominalMensual": { "type": "string", "description": "Interes de cuota nominal mensual" }, } } } }, "pagoConsultaExtractoTms": { "type": "object", "properties": { "fechaVencimiento": { "type": "string", "format": "date-time", "description": "Fecha de vencimiento del pago" }, "minimo": { "$ref": "#/components/schemas/minimoConsultaExtractoTms" }, "total": { "$ref": "#/components/schemas/totalConsultaExtractoTms" } } }, "movimientoConsultaExtractoTms": { "type": "object", "properties": { "id": { "type": "string", "description": "Id del movimiento" }, "fecha": { "type": "string", "format": "date-time", "description": "Fecha del movimiento" }, "descripcion": { "type": "string", "description": "Descripcion del movimiento" }, "valor": { "type": "string", "description": "Valor del movimiento" }, "restante": { "type": "string", "description": "Saldo restante" }, "cuota": { "type": "object", "properties": { "valor": { "type": "string", "description": "Valor de la cuota" }, "numeroOriginal": { "type": "string", "description": "Numero original de cuotas" }, "numeroRestante": { "type": "string", "description": "Numero restante de cuotas" } } }, "interes": { "type": "object", "properties": { "tasa": { "type": "string", "description": "Valor de la tasa de interes" } } } } }, "puntosConsultaExtractoTms": { "type": "object", "properties": { "saldoAnterior": { "type": "string", "description": "Saldo anterior de puntos" }, "mesActual": { "type": "string", "description": "Mes actual" }, "redimido": { "type": "string", "description": "Puntos redimidos" } } }, "tarjetaConsultaExtractoTms": { "type": "object", "properties": { "id": { "type": "string", "description": "Id del credito" }, "numero": { "type": "string", "description": "Numero de la tarjeta de credito" }, "fechaFacturacion": { "type": "string", "format": "date-time", "description": "fecha de facturacion de la tms." }, "cupo": { "$ref": "#/components/schemas/cupoConsultaExtractoTms" }, "pago": { "$ref": "#/components/schemas/pagoConsultaExtractoTms" }, "interes": { "$ref": "#/components/schemas/interesConsultaExtractoTms" }, "movimiento": { "type": "array", "items":{ "$ref": "#/components/schemas/movimientoConsultaExtractoTms" } }, "puntos": { "$ref": "#/components/schemas/puntosConsultaExtractoTms" }, } }, "consultaExtractoTms": { "type": "object", "properties": { "afiliado": { "$ref": "#/components/schemas/afiliadoConsultaExtractoTms" }, "tarjeta": { "$ref": "#/components/schemas/tarjetaConsultaExtractoTms" } } }, "resultado": { "type": "object", "properties": { "codigo": { "type": "string", "description": "Código del resultado" }, "descripcion": { "type": "string", "description": "Descripción del resultado" } }, "xml": { "name": "resultado" } }, "estado": { "type": "object", "properties": { "codigo": { "type": "number", "description": "Codigo del estado." }, "descripcion": { "type": "string", "description": "Descripcion del estado." } }, "xml": { "name": "estado" } }, "bolsillo": { "type": "object", "properties": { "codigo": { "type": "number", "description": "Codigo del bolsillo." }, "estado": { "$ref":"#/components/schemas/estado" } }, "xml": { "name": "bolsillo" } }, "diferido": { "type": "object", "properties": { "ajuste": { "type": "number", "description": "Diferido vencido facturado ajuste." }, "avance": { "type": "number", "description": "Diferido vencido facturado avance." }, "compra": { "type": "number", "description": "Diferido vencido facturado compra." }, "venta": { "type": "number", "description": "Diferido vendido facturado." } }, "xml": { "name": "diferido" } }, "interes": { "type": "object", "properties": { "valor": { "type": "number", "description": "Valor del interes por el pago minimo." }, "pendiente": { "type": "number", "description": "Valor de intereses pendientes por cobros." } }, "xml": { "name": "interes" } }, "mora": { "type": "object", "properties": { "capital": { "type": "number", "description": "Valor del capital en mora." }, "saldo": { "type": "number", "description": "Valor del saldo de mora." } }, "xml": { "name": "mora" } }, "minimo": { "type": "object", "properties": { "valor": { "type": "number", "description": "Valor del pago minimo." }, "cuotaManejo": { "type": "number", "description": "Valor de la cuota de manejo." }, "cargoNoDiferido": { "type": "number", "description": "Cargos no diferidos." }, "diferido": { "$ref":"#/components/schemas/diferido" }, "interes": { "$ref":"#/components/schemas/interes" }, "mora": { "$ref":"#/components/schemas/mora" } }, "xml": { "name": "minimo" } }, "total": { "type": "object", "properties": { "valor": { "type": "number", "description": "Valor del pago total." }, "avanceMes": { "type": "number", "description": "Total de avances totales no pagados en el mes." }, "deudores": { "type": "number", "description": "Total de dudores." }, "venta": { "type": "number", "description": "Total de ventas al mes no pagas." }, "diferido": { "$ref":"#/components/schemas/diferido" } }, "xml": { "name": "total" } }, "pago": { "type": "object", "properties": { "cuota": { "type": "number", "description": "Valor de la cuota de la tarjeta." }, "ultimo": { "type": "string", "description": "Valor del ultimo pago." }, "fechaUltimo": { "type": "string", "format":"date-time", "description": "Fecha de ultimo pago." }, "minimo": { "$ref":"#/components/schemas/minimo" }, "total": { "$ref":"#/components/schemas/total" } }, "xml": { "name": "pago" } }, "tarjetaCompleto": { "type": "object", "properties": { "tipo": { "type": "string", "description": "Tipo de la tarjeta" }, "descripcion": { "type": "string", "description": "Descripcion del tipo de la tarjeta" }, "numero": { "type": "number", "description": "Numero de la tarjeta" }, "cupo": { "type": "number", "description": "Cupo de la tarjeta." }, "saldo": { "type": "number", "description": "Saldo disponible de la tarjeta." }, "fechaActivacion": { "type": "string", "format":"date-time", "description": "Fecha de activacion de la tarjeta" }, "fechaCorte": { "type": "string", "format":"date-time", "description": "Fecha de corte de la tarjeta" }, "fechaLimite": { "type": "string", "format":"date-time", "description": "Fecha de limite de pago de la tarjeta" }, "movimiento": { "$ref":"#/components/schemas/movimiento" }, "estado": { "$ref":"#/components/schemas/estado" }, "bolsillo": { "$ref":"#/components/schemas/bolsillo" }, "pago": { "$ref":"#/components/schemas/pago" }, "mora": { "$ref":"#/components/schemas/mora" }, "abono": { "$ref":"#/components/schemas/abono" } }, "xml": { "name": "tarjetaCompleto" } }, "abono": { "type": "object", "properties": { "valor": { "type": "string", "description": "Valor del abono" }, "fecha": { "type": "string", "format":"date-time", "description": "Fecha del abono" } }, "xml": { "name": "abono" } }, "tarjeta": { "type": "object", "properties": { "tipo": { "type": "string", "description": "Tipo de tarjeta" }, "descripcion": { "type": "string", "description": "Descripcion del tipo de tarjeta" }, "numero": { "type": "string", "description": "Numero de tarjeta" }, "fechaActivacion": { "type": "string", "format":"date-time", "description": "Fecha de activacion de tarjeta" }, "estado": { "$ref":"#/components/schemas/estado" }, "bolsillo": { "$ref":"#/components/schemas/bolsillo" } }, "xml": { "name": "tarjeta" } }, "consultaBolsillo": { "type": "object", "properties": { "tarjeta": { "$ref": "#/components/schemas/tarjeta" }, "fecha": { "type": "string", "description": "Fecha actual" }, "saldo": { "type": "string", "description": "Saldo disponible" }, "codigo": { "type": "string", "description": "Codigo de bolsillo" } }, "xml": { "name": "consultaBolsillo" } }, "getConsultaBolsilloResponse": { "type": "object", "required": [ "resultado" ], "properties": { "resultado": { "type": "array", "xml": { "name": "resultado" }, "items": { "$ref": "#/components/schemas/resultado" } }, "consultaBolsillo": { "type": "array", "items": { "$ref": "#/components/schemas/consultaBolsillo" } } } }, "movimiento": { "type": "object", "properties": { "tipo": { "type": "string", "description": "Tipo de movimiento." }, "codigo": { "type": "string", "description": "Codigo de movimiento." }, "fecha": { "type": "string", "format": "date-time", "description": "Fecha de movimiento." } }, "xml": { "name": "movimiento" } }, "plazo": { "type": "object", "properties": { "pendiente": { "type": "string", "description": "Plazo pendiente." } }, "xml": { "name": "plazo" } }, "transaccion": { "type": "object", "properties": { "valor": { "type": "string", "description": "Valor de transaccion." }, "fecha": { "type": "string", "description": "Fecha de transaccion." }, "vencimiento": { "type": "string", "description": "Plazo de transaccion." } }, "xml": { "name": "transaccion" } }, "movimientoBolsillo": { "type": "object", "properties": { "tarjeta": { "$ref": "#/components/schemas/tarjeta" }, "movimiento": { "$ref": "#/components/schemas/movimiento" }, "plazo": { "$ref": "#/components/schemas/plazo" }, "transaccion": { "$ref": "#/components/schemas/transaccion" }, "oficina": { "type": "string", "description": "Oficina." }, "establecimiento": { "type": "string", "description": "Establecimiento." }, "idAmparador": { "type": "string", "description": "Id amparador." }, "saldoPendiente": { "type": "string", "description": "Saldo pendiente." }, "tasaInteres": { "type": "string", "description": "Tasa de interes." } }, "xml": { "name": "obtenerMovimiento" } }, "obtenerMovimientoResponse": { "type": "object", "required": [ "resultado" ], "properties": { "resultado": { "type": "array", "xml": { "name": "resultado" }, "items": { "$ref": "#/components/schemas/resultado" } }, "movimientoBolsillo": { "type": "array", "items": { "$ref": "#/components/schemas/movimientoBolsillo" } } } }, "ciudad": { "type": "object", "properties": { "direccion": { "$ref": "#/components/schemas/direccion" }, "nombre": { "type": "string", "description": "Nombre de la ciudad." } }, "xml": { "name": "ciudad" } }, "direccion": { "type": "object", "properties": { "direccionPrincipal": { "type": "string", "description": "Direccion de residencia." } }, "xml": { "name": "direccion" } }, "nombre": { "type": "object", "properties": { "primero": { "type": "string", "description": "Nombre del cliente." } }, "xml": { "name": "nombre" } }, "residencia": { "type": "object", "properties": { "ciudad": { "$ref": "#/components/schemas/ciudad" } }, "xml": { "name": "residencia" } }, "grupoAfinidad": { "type": "object", "properties": { "codigo": { "type": "string", "description": "Codigo de grupo de afinidad." }, "descripcion": { "type": "string", "description": "Descripcion del grupo de afinidad." } }, "xml": { "name": "grupoAfinidad" } }, "sistema": { "type": "object", "properties": { "financiacion": { "type": "string", "description": "Sistema de financiacion." }, "fechaUltimoCambio": { "type": "string", "description": "Fecha de ultimo cambio de sistema de financiacion." } }, "xml": { "name": "sistema" } }, "item": { "type": "object", "properties": { "codigoBolsillo": { "type": "integer", "description": "Código identificador." }, "descripcionEstadoBolsillo": { "type": "integer", "description": "Estado del bolsillo." }, "descripcionEstadoTarjeta": { "type": "string", "description": "Estado de la tarjeta." }, "descripcionTipoTarjeta": { "type": "string", "description": "Descripción tipo de tarjeta." }, "estadoBolsillo": { "type": "integer", "description": "Código de estado de bolsillo." }, "estadoTarjeta": { "type": "integer", "description": "Estado de la tarjeta." }, "tipoTarjeta": { "type": "integer", "description": "Tipo de tarjeta." } }, "xml": { "name": "sistema" } }, "alturaMora": { "type": "object", "properties": { "fecha": { "type": "string", "description": "Fecha de facturacion de altura de mora." }, "mes": { "type": "string", "description": "Mes de altura de mora." }, "mora": { "type": "string", "description": "Dias de altura de mora." } }, "xml": { "name": "alturaMora" } }, "informacionPersonal": { "type": "object", "properties": { "nombre": { "$ref": "#/components/schemas/nombre" }, "residencia": { "$ref": "#/components/schemas/residencia" }, "telefono": { "type": "string", "description": "Telefono del cliente." } }, "xml": { "name": "informacionPersonal" } }, "clienteCupo": { "type": "object", "properties": { "informacionPersonal": { "$ref": "#/components/schemas/informacionPersonal" }, "grupoAfinidad": { "$ref": "#/components/schemas/grupoAfinidad" }, "sistema": { "$ref": "#/components/schemas/sistema" }, "alturaMora": { "type": "array", "items": { "$ref": "#/components/schemas/alturaMora" } }, "cupoAsignado": { "type": "string", "description": "Cupo asignado." }, "cicloFacturacion": { "type": "string", "description": "Ciclo de facturacion." }, "idAmparado": { "type": "string", "description": "Id amparador." }, "moraActual": { "type": "string", "description": "Mora actual." } }, "xml": { "name": "obtenerMovimiento" } }, "obtenerTarjeta": { "type": "object", "properties": { "tarjeta": { "type": "array", "items":{ "$ref": "#/components/schemas/tarjeta" } }, "fechaActual": { "type": "string", "description": "Fecha del dia de la consulta." } }, "xml": { "name": "obtenerTarjeta" } }, "obtenerEstadoBolsillo": { "type": "object", "properties": { "tarjeta": { "type": "array", "items":{ "$ref": "#/components/schemas/tarjeta" } } }, "xml": { "name": "obtenerEstadoBolsillo" } }, "consultaPagoBolsillo": { "type": "object", "properties": { "tarjeta": { "$ref": "#/components/schemas/tarjetaCompleto" } }, "xml": { "name": "consultaPagoBolsillo" } }, "consultaSaldoDebitoResponse": { "type": "object", "required": [ "resultado" ], "properties": { "resultado": { "type": "array", "xml": { "name": "resultado" }, "items": { "$ref": "#/components/schemas/resultado" } }, "consultaSaldoDebito": { "type": "array", "items": { "$ref": "#/components/schemas/SaldoDebito" } } } }, "SaldoDebito":{ "type":"object", "properties":{ "fecha": { "type": "string", "format": "date-time", "description": "Fecha actual." }, "tarjeta":{ "$ref": "#/components/schemas/tarjetaCompleto" } } }, "consultaPagoBolsilloResponse": { "type": "object", "required": [ "resultado" ], "properties": { "resultado": { "type": "array", "xml": { "name": "resultado" }, "items": { "$ref": "#/components/schemas/resultado" } }, "consultaPagoBolsillo": { "type": "array", "items": { "$ref": "#/components/schemas/consultaPagoBolsillo" } } } }, "consultaAbonoDebitoResponse": { "type": "object", "required": [ "resultado" ], "properties": { "resultado": { "type": "array", "xml": { "name": "resultado" }, "items": { "$ref": "#/components/schemas/resultado" } }, "abonoBolsilloDebito": { "type": "array", "items": { "$ref": "#/components/schemas/abonoBolsillo" } } } }, "abonoBolsillo": { "type": "object", "properties": { "establecimiento":{ "type":"string", "description":"Establecimiento" }, "tatjeta":{ "$ref": "#/components/schemas/tarjetaCompleto" } } }, "consultaPagoBolsilloDebitoResponse": { "type": "object", "required": [ "resultado" ], "properties": { "resultado": { "type": "array", "xml": { "name": "resultado" }, "items": { "$ref": "#/components/schemas/resultado" } }, "movimientoBolsilloDebito": { "type": "array", "items": { "$ref": "#/components/schemas/consultaPagoBolsilloDebito" } } } }, "consultaPagoBolsilloDebito":{ "type":"object", "properties":{ "establecimiento":{ "type":"string", "description":"Establecimiento" }, "tarjeta":{ "$ref": "#/components/schemas/tarjetaCompleto" } } } , "consultaTarjetaDocumentoResponse": { "type": "object", "required": [ "resultado" ], "properties": { "resultado": { "type": "array", "xml": { "name": "resultado" }, "items": { "$ref": "#/components/schemas/resultado" } }, "obtenerTarjeta": { "type": "array", "items": { "$ref": "#/components/schemas/obtenerTarjeta" } } } }, "consultaEstadoBolsilloResponse": { "type": "object", "required": [ "resultado" ], "properties": { "resultado": { "type": "array", "xml": { "name": "resultado" }, "items": { "$ref": "#/components/schemas/resultado" } }, "obtenerEstadoBolsillo": { "type": "array", "items": { "$ref": "#/components/schemas/obtenerEstadoBolsillo" } } } }, "EstadoPorTarjetaResponse": { "type": "object", "required": [ "resultado" ], "properties": { "resultado": { "type": "array", "xml": { "name": "resultado" }, "items": { "$ref": "#/components/schemas/resultado" } }, "arrayBolsillos": { "type": "object", "properties":{ "item":{ "type": "array", "items":{ "$ref": "#/components/schemas/item" } } } } } }, "obtenerCupoResponse": { "type": "object", "required": [ "resultado" ], "properties": { "resultado": { "type": "array", "xml": { "name": "resultado" }, "items": { "$ref": "#/components/schemas/resultado" } }, "clienteCupo": { "type": "array", "items": { "$ref": "#/components/schemas/clienteCupo" } } } } }, "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" } } } } } } }