swagger: '2.0'
info:
  title: "SIFCO_REST_API"
  version: "1.0"
  termsOfService: "https://sifco.org/sobre-nosotros/"
  contact:
    email: "soporte@sifco.org"
  license:
    name: "Apache 2.0"  
    url: "http://www.apache.org/licenses/LICENSE-2.0.html"
host: "<SERVER>"
schemes:
  - https
  - http
basePath: /<APPDIR>/rest
tags:
- name: "API.HUB.V1.PlanesPagoHubSifco"
  externalDocs:
    description: "Manual SIFCO"
    url: "https://sifco.atlassian.net/wiki/x/ugWo"
produces:
  - application/json
paths:
  /API/HUB/V1/PlanesPagoHubSifco:
    post:
      tags:
        - API.HUB.V1.PlanesPagoHubSifco
      operationId: "API.HUB.V1.PlanesPagoHubSifco"
      summary: "Registrar Planes de Pago en Hub de Créditos"
      parameters:
        - in: header
          name: Content-Type
          type: "string"
          required: true
          default: application/json
        - in: header
          name: Authorization
          type: "string"
          required: true
          default: OAuth <Access Token>
        - in: header
          name: GENEXUS-AGENT
          type: "string"
          required: true
          default: SmartDevice Application
        - name: "PlanesPagoHubSifcoInput"
          in: "body"
          required: false
          schema:
            $ref: "#/definitions/API.HUB.V1.PlanesPagoHubSifcoInput"

      responses:
        200:
          description: "Successful operation"
          schema:
            $ref: "#/definitions/API.HUB.V1.PlanesPagoHubSifcoOutput"

        401:
          description: "Not Authenticated"
          schema:
            $ref: "#/definitions/GxJsonError"
        404:
          description: "Not found"
          schema:
            $ref: "#/definitions/GxJsonError"
        400:
          description: "Bad request"
          schema:
            $ref: "#/definitions/GxJsonError"
        500:
          description: "Internal server error"
          schema:
            $ref: "#/definitions/GxJsonError"
security:
  - OAuth2: []
    ApiKeyAuth1: []
securityDefinitions:
  OAuth2:
    type: oauth2
    flow: password
    tokenUrl: https://test.sifco.org/DemoCoopGT/oauth/access_token
    scopes:
      Execute: Permite el método tipo GET
      Insert: Permite el método tipo POST
      Update: Permite el método tipo PUT
      Delete: Permite el método tipo DELETE
      FullControl: Permite el manejo de los Cuatro Métodos GET, POST, PUT,DELETE, sobre el Web Service
  ApiKeyAuth1:
    type: apiKey
    in: header
    name: granttype

definitions:

  nameAPI.HUB.V1.PlanesPagoHubSifcoInput:
Authorization    properties:
      typedata: "string"

         requireddescription: trueSDTConsulta Planes Pago
        default$ref: OAuth <Access Token>
"#/definitions/SDTConsultaPlanesPago"
  
  SDTConsultaPlanesPago:
    properties:
  - in: header  idHub:
        namedescription: GENEXUS-AGENTid  Hub
        type: "string"

      idTransaccion:
  required:  true    description: id Transacción
    default:   SmartDevice Applicationtype: "integer"
       - nameformat: "PlanesPagoHubSifcoInputint64"

      idNegocio:
  in: "body"     description: id Negocio
   required: false    type: "integer"
     schema:   format: "int64"

       $reftipoIdentidadCliente:
"#/definitions/API.HUB.V1.PlanesPagoHubSifcoInput"        responses:description: tipo Identidad Cliente
        200type: "integer"
         descriptionformat: "int32"Successful

  operation"    identidadCliente:
      schema:  description: identidad Cliente
        $reftype: "#/definitions/API.HUB.V1.PlanesPagoHubSifcoOutputstring"

        401fechaCompra:
 
        description: "Notfecha Authenticated"Compra
          schematype: "string"

          $refobservacion:
"#/definitions/GxJsonError"         404description: observación
         descriptiontype: "Not foundstring"


        schemaidRelacionTP:
        description: id Relación TP
$ref: "#/definitions/GxJsonError"         400type: "integer"
         descriptionformat: "Bad requestint64"

         schemaidPrestador:
        description: id Prestador
 $ref: "#/definitions/GxJsonError"      type: "integer"
 500:       format: "int64"

 description: "Internal server error"  idRelacionPN:
        schemadescription: id Relación PN
         $reftype: "#/definitions/GxJsonError"
security:
integer"
 - OAuth2: []     ApiKeyAuth1format: []
securityDefinitions:"int64"

  OAuth2:     typemontoSolicitado:
oauth2     flow: password  description: monto  tokenUrl: https://test.sifco.org/DemoCoopGT/oauth/access_tokenSolicitado
        scopestype: "number"
        Executeformat: Permite"double"
el método tipo
GET  API.HUB.V1.PlanesPagoHubSifcoOutput:
    Insertproperties:
Permite     el métodoresult:
tipo POST       Updatedescription: PermiteSDTPlanes elPago métodoResult
tipo PUT       Delete$ref: Permite el método tipo DELETE
 "#/definitions/SDTPlanesPagoResult"
  
  SDTPlanesPagoResult:
    FullControlproperties:
Permite el manejo de los Cuatro Métodos GET, POST, PUT,DELETE, sobre el Web ServiceidTransaccion:
        ApiKeyAuth1description: id Transacción
  type: apiKey     intype: header
"integer"
   name: granttype  definitions:    API.HUB.V1.PlanesPagoHubSifcoInput:
    properties:format: "int64"

      dataidNegocio:
        description: SDTConsultaid PlanesNegocio
Pago         $reftype: "#/definitions/SDTConsultaPlanesPagointeger"
     SDTConsultaPlanesPago:   format: "int64"
properties:
      idHubidPrestador:
        description: id HubPrestador
        type: "stringinteger"
        idTransaccionformat: "int64"

      descriptionobservacion:
id Transacción         typedescription: "integer"observación
        formattype: "int64string"

      idNegociomontoSolicitado:
        description: idmonto NegocioSolicitado
        type: "integer"
        format: "int64"

      tipoIdentidadClientemontoAprobado:
        description: tipo Identidadmonto ClienteAprobado
        type: "integernumber"
        format: "int32double"

      identidadClienteidTransaccionSifco:
        description: identidadid Transacción ClienteSifco
        type: "string"

      fechaCompraplanesPago:
        descriptiontype: fecha Compraarray
        typeitems: "string"
       observacion:   description: planesPagoItem
    description: observación         type$ref: "string#/definitions/SDTPlanesPagoResult.planesPago"


  SDTPlanesPagoResult.planesPago:
  idRelacionTP:  properties:
      descriptionidPlanPagoSifco:
 id Relación TP     description: id Plan Pago type:Sifco
"integer"         formattype: "int64string"

      idPrestadoridRelacionPN:
        description: id PrestadorRelación PN
        type: "integer"
        format: "int64"

      idRelacionPNidRelacionTP:
        description: id RelaciónRelacion PNTP
        type: "integer"
        format: "int64"

      montoSolicitadonombrePlanPago:
        description: nombre montoPlan SolicitadoPago
        type: "numberstring"

       format: "double"descripcionPlanPago:
        description: descripción Plan Pago
     API.HUB.V1.PlanesPagoHubSifcoOutput:   type: "string"
properties:
      resultnumeroCuotasPlanPago:
        description: numero SDTPlanesCuotas Plan Pago
Result         $reftype: "#/definitions/SDTPlanesPagoResultinteger"
     SDTPlanesPagoResult:   format: "int32"
properties:
      idTransaccionvalorCuotaPlanPago:
        description: id Transacciónvalor Cuota Plan Pago
        type: "integernumber"
        format: "int64double"

      idNegociodiaVencimiento:
        description: iddia NegocioVencimiento
        type: "integer"
        format: "int64"

      idPrestador: "int32"

      descriptionvencimientoPrimeraCuota:
id Prestador       description: vencimiento type: "integer"Primera Cuota
        formattype: "int64string"

      observacionvencimientoUltimaCuota:
        description: vencimiento Ultima observaciónCuota
        type: "string"

      montoSolicitadotasaMensualPlanPago:
        description: tasa Mensual montoPlan SolicitadoPago
        type: "integernumber"
        format: "int64double"

      montoAprobadotasaAnualPlanPago:
        description: tasa Anual montoPlan AprobadoPago
        type: "number"
        format: "double"

      idTransaccionSifcotasaInteresPlanPago:
        description: tasa idInterés TransacciónPlan SifcoPago
        type: "stringnumber"
        planesPagoformat: "double"

      typecae:
array         itemsdescription: cae
         descriptiontype: planesPagoItem"number"
          $refformat: "#/definitions/SDTPlanesPagoResult.planesPagodouble"

   SDTPlanesPagoResult.planesPago:   montoCostosAsociados:
 properties:       idPlanPagoSifcodescription: monto Costos Asociados
     description: id Plan Pago Sifcotype: "number"
        typeformat: "stringdouble"

      idRelacionPNmontoCredito:
        description: idmonto Relación PNCrédito
        type: "integernumber"
        format: "int64double"


     idRelacionTPx-gx-level: "SDTPlanesPagoResult"

  GxJsonError:
    properties:
   description: id Relacion TPerror:
        type$ref: "integer#/definitions/GxJsonError.error"

  GxJsonError.error:
    formatproperties: "int64"
       nombrePlanPagocode:
        description: nombreCódigo Plande PagoError
        type: "string"

      descripcionPlanPagomessage:
        description: descripciónMensaje Plande PagoError
        type: "string"


     numeroCuotasPlanPago:
        description: numero Cuotas Plan Pago
        type: "integer"
        format: "int32"

      valorCuotaPlanPago:
        description: valor Cuota Plan Pago
        type: "number"
        format: "double"

      diaVencimiento:
        description: dia Vencimiento
        type: "integer"
        format: "int32"

      vencimientoPrimeraCuota:
        description: vencimiento Primera Cuota
        type: "string"

      vencimientoUltimaCuota:
        description: vencimiento Ultima Cuota
        type: "string"

      tasaMensualPlanPago:
        description: tasa Mensual Plan Pago
        type: "number"
        format: "double"

      tasaAnualPlanPago:
        description: tasa Anual Plan Pago
        type: "number"
        format: "double"

      tasaInteresPlanPago:x-gx-level: "GxJsonError"

INFORMACIÓN

Para identificar el MENSAJE DE ERROR remitirse a la pagina de (Listado de Errores) External Call Out, donde se describe el listado de errores que arroja las API’s REST de la Aplicación SIFCO WEB, con su respectiva Descripción.