Web Services para Crear Solicitud de Pago Grupal.

Swagger open api macro

DESCRIPCIÓN.

Este Web Service, permite cargar una Planilla de Solicitud de Pago Grupal en la Aplicación SIFCO WEB. Esto solo carga los montos y detalles del crédito para su cancelación, mas el Pago debe ser Aprobado Manualmente desde la Aplicación SIFCO WEB, o Aplicado a través del WS PCrGrPagoGrupal.

Swagger open api macro

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: "PInsSoliGrupo"
  externalDocs:
    description: "Manual SIFCO"
    url: "https://sifco.atlassian.net/wiki/x/RQCx"
produces:
  - application/json
paths:
  /PInsSoliGrupo:
    post:
      tags:
        - PInsSoliGrupo
      operationId: "PInsSoliGrupo"
      summary: "Web Services para Crear Solicitud de Pago Grupal"
      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: "PInsSoliGrupoInput"
          in: "body"
          required: false
          schema:
            $ref: "#/definitions/PInsSoliGrupoInput"

      responses:
        200:
          description: "Successful operation"
          schema:
            $ref: "#/definitions/PInsSoliGrupoOutput"

        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:

  PInsSoliGrupoInput:
    properties:
      ApEmpCod:
        description: Código de Empresa
        type: "integer"
        format: "int32"
      ApSucCod:
        description: Código de Sucursal
        type: "integer"
        format: "int32"
      SoCrNumero:
        description: Numero de Préstamo
        type: "integer"
        format: "int64"
      GrAfCodigo:
        description: Código de Grupo de Afiliación
        type: "integer"
        format: "int64"
      GrAfCiclo:
        description: Ciclo de Grupo de Afiliación
        type: "integer"
        format: "int64"
      ApPrmCod:
        description: Código de Préstamo
        type: "string"
      ApPrdCod:
        description: Código de Producto
        type: "integer"
        format: "int32"
      ApColCod:
        description: Código SubProducto Colocación
        type: "integer"
        format: "int32"
      SoCrFecha:
        description: Fecha de Crédito
        type: "string"
        format: "date"
      SoCrFecFormalizacion:
        description: Fecha de Formalizacion del Crédito
        type: "string"
        format: "date"
      SoCrReferencia:
        description: Referencia
        type: "string"
      SoCrMonSolicitado:
        description: Monto Solicitado
        type: "number"
        format: "double"
      SoCrMonAutorizado:
        description: Monto Autorizado
        type: "number"
        format: "double"
      SoCrTasaFoV:
        description: Tasa Fija o Variable
        type: "string"
      SoCrTasaBase:
        description: Tasa Base
        type: "number"
        format: "double"
      SoCrSpreCorr:
        description: Correlativo de Spread de Crédito
        type: "number"
        format: "double"
      SoCrBaseMora:
        description: Base de Mora del Crédito
        type: "number"
        format: "double"
      SoCrSpreMora:
        description: Spread de Interés x Mora del Crédito
        type: "number"
        format: "double"
      SoCrFacPlazo:
        description: Factor de Plazo del Crédito
        type: "integer"
        format: "int32"
      SoCrPlazo:
        description: Plazo de Crédito
        type: "integer"
        format: "int32"
      SoCrDiasGracia:
        description: Días de Gracia
        type: "integer"
        format: "int32"
      SoCrFecVencimiento:
        description: Fecha de Vencimiento de Crédito
        type: "string"
        format: "date"
      SoCrTipCom:
        description: Tipo de Compromiso
        type: "integer"
        format: "int32"
      SoCrFreCCod:
        description: Código de Frecuencia de Pago a Capital
        type: "integer"
        format: "int32"
      SoCrFreICod:
        description: Código de Frecuencia de Pago Intereses a Préstamo
        type: "integer"
        format: "int32"
      SoCrFecCap:
        description: Fecha de Pago a Capital
        type: "string"
        format: "date"
      SoCrFecInt:
        description: Fecha de Pago de Interes
        type: "string"
        format: "date"
      SoCrFormaPago:
        description: Forma de Pago del Crédito
        type: "integer"
        format: "int32"
      PreFreCPlanilla:
        description: Frecuencia Pago Planilla
        type: "integer"
        format: "int32"
      BaCtaCodPago:
        description: Código de Cuenta de Pago
        type: "integer"
        format: "int64"
      ApAprCod:
        description: Código de Aprobación
        type: "integer"
        format: "int32"
      FecAprobacion:
        description: Fecha de Aprobación de Crédito
        type: "string"
        format: "date"
      ApGarCod:
        description: Código de Garantía
        type: "integer"
        format: "int32"
      ApOrgCod:
        description: Código de Origen de Fondos
        type: "integer"
        format: "int32"
      TipoDesem:
        description: Tipo de Desembolso
        type: "integer"
        format: "int32"
      BaCtaCod:
        description: Código de Cuenta de Banco
        type: "integer"
        format: "int64"
      ApGrDCod:
        description: Código de Gran División
        type: "integer"
        format: "int32"
      ApAcDCod:
        type: "integer"
        format: "int32"
      ApAgrCod:
        type: "integer"
        format: "int32"
      ApTGaCod:
        type: "integer"
        format: "int32"
      ApGruCod:
        description: Código de Grupo
        type: "integer"
        format: "int32"
      SoCrEstado:
        description: Estado del Crédito
        type: "integer"
        format: "int32"
      FormaCheque:
        description: Si forma de pago es cheque
        type: "string"
      FormaTransferencia:
        description: Si forma de pago es transferencia
        type: "string"
      NombreCheque:
        description: Titular del Cheque
        type: "string"
      Miembros:
        description: Miembros Sol Grupal
        type: array
        items:
          $ref: "#/definitions/MiembrosSolGrupal_MiembrosSolGrupalItem"
      Mode:
        type: "string"
      Error:
        type: "integer"
        format: "int32"

  MiembrosSolGrupal_MiembrosSolGrupalItem:
    properties:
      Id:
        description: Id
        type: "integer"
        format: "int64"

      ClCliCod:
        description: Código del Cliente
        type: "integer"
        format: "int64"

      ClNomSocio:
        description: Nombre del Cliente
        type: "string"

      CrSolMonCicloAnterior:
        description: Monto ciclo anterior
        type: "number"
        format: "double"

      CrSolMonSolicitado:
        description: Monto Solicitado
        type: "number"
        format: "double"

      CrSolMonAutorizado:
        description: Monto Autorizado
        type: "number"
        format: "double"

      CrSolTransfCuentaBancoCliente:
        description: Cuenta bancaria del socio hacia donde se realiza la transacción
        type: "string"

      CrSolTransfNumeroDocumento:
        description: Número de documento de referencia de la transferencia
        type: "integer"
        format: "int64"

      CrSolTransfClienteUnaSolaTransferencia:
        description: Indica si es el cliente seleccionado para una sola transferencia por todo el grupo
        type: "boolean"

  PInsSoliGrupoOutput:
    properties:
      ApEmpCod:
        description: Código de Empresa
        type: "integer"
        format: "int32"
      ApSucCod:
        description: Código de Sucursal
        type: "integer"
        format: "int32"
      SoCrNumero:
        description: Numero de Préstamo
        type: "integer"
        format: "int64"
      GrAfCodigo:
        description: Código de Grupo de Afiliación
        type: "integer"
        format: "int64"
      GrAfCiclo:
        description: Ciclo de Grupo de Afiliación
        type: "integer"
        format: "int64"
      ApPrmCod:
        description: Código de Préstamo
        type: "string"
      ApPrdCod:
        description: Código de Producto
        type: "integer"
        format: "int32"
      ApColCod:
        description: Código SubProducto Colocación
        type: "integer"
        format: "int32"
      SoCrFecha:
        description: Fecha de Crédito
        type: "string"
        format: "date"
      SoCrFecFormalizacion:
        description: Fecha de Formalizacion del Crédito
        type: "string"
        format: "date"
      SoCrReferencia:
        description: Referencia
        type: "string"
      SoCrMonSolicitado:
        description: Monto Solicitado
        type: "number"
        format: "double"
      SoCrMonAutorizado:
        description: Monto Autorizado
        type: "number"
        format: "double"
      SoCrTasaFoV:
        description: Tasa Fija o Variable
        type: "string"
      SoCrTasaBase:
        description: Tasa Base
        type: "number"
        format: "double"
      SoCrSpreCorr:
        description: Correlativo de Spread de Crédito
        type: "number"
        format: "double"
      SoCrBaseMora:
        description: Base de Mora del Crédito
        type: "number"
        format: "double"
      SoCrSpreMora:
        description: Spread de Interés x Mora del Crédito
        type: "number"
        format: "double"
      SoCrFacPlazo:
        description: Factor de Plazo del Crédito
        type: "integer"
        format: "int32"
      SoCrPlazo:
        description: Plazo de Crédito
        type: "integer"
        format: "int32"
      SoCrDiasGracia:
        description: Días de Gracia
        type: "integer"
        format: "int32"
      SoCrFecVencimiento:
        description: Fecha de Vencimiento de Crédito
        type: "string"
        format: "date"
      SoCrTipCom:
        description: Tipo de Compromiso
        type: "integer"
        format: "int32"
      SoCrFreCCod:
        description: Código de Frecuencia de Pago a Capital
        type: "integer"
        format: "int32"
      SoCrFreICod:
        description: Código de Frecuencia de Pago Intereses a Préstamo
        type: "integer"
        format: "int32"
      SoCrFecCap:
        description: Fecha de Pago a Capital
        type: "string"
        format: "date"
      SoCrFecInt:
        description: Fecha de Pago de Interes
        type: "string"
        format: "date"
      SoCrFormaPago:
        description: Forma de Pago del Crédito
        type: "integer"
        format: "int32"
      PreFreCPlanilla:
        description: Frecuencia Pago Planilla
        type: "integer"
        format: "int32"
      BaCtaCodPago:
        description: Código de Cuenta de Pago
        type: "integer"
        format: "int64"
      ApAprCod:
        description: Código de Aprobación
        type: "integer"
        format: "int32"
      FecAprobacion:
        description: Fecha de Aprobación de Crédito
        type: "string"
        format: "date"
      ApGarCod:
        description: Código de Garantía
        type: "integer"
        format: "int32"
      ApOrgCod:
        description: Código de Origen de Fondos
        type: "integer"
        format: "int32"
      TipoDesem:
        description: Tipo de Desembolso
        type: "integer"
        format: "int32"
      BaCtaCod:
        description: Código de Cuenta de Banco
        type: "integer"
        format: "int64"
      ApGrDCod:
        description: Código de Gran División
        type: "integer"
        format: "int32"
      ApAcDCod:
        type: "integer"
        format: "int32"
      ApAgrCod:
        type: "integer"
        format: "int32"
      ApTGaCod:
        type: "integer"
        format: "int32"
      ApGruCod:
        description: Código de Grupo
        type: "integer"
        format: "int32"
      SoCrEstado:
        description: Estado del Crédito
        type: "integer"
        format: "int32"
      FormaCheque:
        description: Si forma de pago es cheque
        type: "string"
      FormaTransferencia:
        description: Si forma de pago es transferencia
        type: "string"
      NombreCheque:
        description: Titular del Cheque
        type: "string"
      Miembros:
        description: Miembros Sol Grupal
        type: array
        items:
          $ref: "#/definitions/MiembrosSolGrupal_MiembrosSolGrupalItem"
      Mode:
        type: "string"
      Error:
        type: "integer"
        format: "int32"

  GxJsonError:
    properties:
      error:
        $ref: "#/definitions/GxJsonError.error"

  GxJsonError.error:
    properties:
      code:
        description: Código de Error
        type: "string"

      message:
        description: Mensaje de Error
        type: "string"


    x-gx-level: "GxJsonError"

EJEMPLOS DE REQUEST Y RESPONSE, PARA LOS SERVICIOS RESTful BAJO PROTOCOLO HTTP.

A continuación se muestra una tabla con un ejemplo de una Solicitud y un Respuesta para este Web Service.

METODO POST

Este método para este Web Service en especifico permite cargar una Planilla de Solicitud de Pago Grupal en la Aplicación SIFCO WEB.

El siguiente ejemplo permite realizar una Solicitud de Pago Grupal en la Aplicación SIFCO WEB.

Tipo de Mensaje HTTP

Ejemplo

REQUEST

URL:

Code Block

language	html

https://test.sifco.org/democoopgt/rest/PInsSoliGrupo

HEADERS

Code Block

language	json

content-type: application/json
authorization: OAuth f2a9ec34-cf83-46f5-8862-f78........
genexus-agent: SmartDevice Application

BODY:

Code Block

language	json

{
  "ApEmpCod": 1,
  "ApSucCod": 1,
  "SoCrNumero": 0,
  "GrAfCodigo": 1,
  "GrAfCiclo": 0,
  "ApPrmCod": "admin",
  "ApPrdCod": 0,
  "ApColCod": 0,
  "SoCrFecha": "2019-10-01",
  "SoCrFecFormalizacion": "2019-10-01",
  "SoCrReferencia": "string",
  "SoCrMonSolicitado": 10000,
  "SoCrMonAutorizado": 2000,
  "SoCrTasaFoV": "string",
  "SoCrTasaBase": 0,
  "SoCrSpreCorr": 0,
  "SoCrBaseMora": 0,
  "SoCrSpreMora": 0,
  "SoCrFacPlazo": 0,
  "SoCrPlazo": 0,
  "SoCrDiasGracia": 0,
  "SoCrFecVencimiento": "2019-10-01",
  "SoCrTipCom": 0,
  "SoCrFreCCod": 0,
  "SoCrFreICod": 0,
  "SoCrFecCap": "2019-10-01",
  "SoCrFecInt": "2019-10-01",
  "SoCrFormaPago": 0,
  "PreFreCPlanilla": 0,
  "BaCtaCodPago": 105,
  "ApAprCod": 0,
  "FecAprobacion": "2019-10-01",
  "ApGarCod": 1,
  "ApOrgCod": 0,
  "TipoDesem": 0,
  "BaCtaCod": 105,
  "ApGrDCod": 0,
  "ApAcDCod": 0,
  "ApAgrCod": 0,
  "ApTGaCod": 0,
  "ApGruCod": 1,
  "SoCrEstado": 0,
  "FormaCheque": "string",
  "FormaTransferencia": "string",
  "NombreCheque": "string",
  "Miembros": [
    {
      "Id": 0,
      "ClCliCod": 1,
      "ClNomSocio": "FLORENCIO LUIS ARMANDO AJ LUCAS",
      "CrSolMonCicloAnterior": 0,
      "CrSolMonSolicitado": 0,
      "CrSolMonAutorizado": 0,
      "CrSolTransfCuentaBancoCliente": "string",
      "CrSolTransfNumeroDocumento": 0,
      "CrSolTransfClienteUnaSolaTransferencia": true
    }
  ],
  "Mode": "INS",
  "Error": 0
}

200 (Successful operation)

Operación Exitosa

Code Block

language	json

{
  "ApEmpCod": 1,
  "ApSucCod": 1,
  "SoCrNumero": "0",
  "GrAfCodigo": 1,
  "GrAfCiclo": 0,
  "ApPrmCod": "admin",
  "ApPrdCod": 0,
  "ApColCod": 0,
  "SoCrFecha": "2019-10-01",
  "SoCrFecFormalizacion": "2019-10-01",
  "SoCrReferencia": "string",
  "SoCrMonSolicitado": "10000.00",
  "SoCrMonAutorizado": "2000.00",
  "SoCrTasaFoV": "string",
  "SoCrTasaBase": "0.0000",
  "SoCrSpreCorr": "0.0000",
  "SoCrBaseMora": "0.0000",
  "SoCrSpreMora": "0.0000",
  "SoCrFacPlazo": 0,
  "SoCrPlazo": 0,
  "SoCrDiasGracia": 0,
  "SoCrFecVencimiento": "2019-10-01",
  "SoCrTipCom": 0,
  "SoCrFreCCod": 0,
  "SoCrFreICod": 0,
  "SoCrFecCap": "2019-10-01",
  "SoCrFecInt": "2019-10-01",
  "SoCrFormaPago": 0,
  "PreFreCPlanilla": 0,
  "BaCtaCodPago": 105,
  "ApAprCod": 0,
  "FecAprobacion": "2019-10-01",
  "ApGarCod": 1,
  "ApOrgCod": 0,
  "TipoDesem": 0,
  "BaCtaCod": 105,
  "ApGrDCod": 0,
  "ApAcDCod": 0,
  "ApAgrCod": 0,
  "ApTGaCod": 0,
  "ApGruCod": 1,
  "SoCrEstado": 1,
  "FormaCheque": "string",
  "FormaTransferencia": "string",
  "NombreCheque": "string",
  "Miembros": [
    {
      "Id": 0,
      "ClCliCod": "1",
      "ClNomSocio": "FLORENCIO LUIS ARMANDO AJ LUCAS",
      "CrSolMonCicloAnterior": "0.00",
      "CrSolMonSolicitado": "0.00",
      "CrSolMonAutorizado": "0.00",
      "CrSolTransfCuentaBancoCliente": "string",
      "CrSolTransfNumeroDocumento": "0",
      "CrSolTransfClienteUnaSolaTransferencia": true
    }
  ],
  "Mode": "INS",
  "Error": 429
}

400 (Bad Request).

Solicitud Errada

Code Block
{ "error": { "code": "string", "message": "string" } }

401 (This service needs an Authorization Header)

(No Autenticado, asociado normalmente a que no se respetaron las cabeceras obligatorias para el consumo de este Web Service, para mayores detalles consultar (Configuración de Seguridad para Obtener Token de Acceso y Consumir de los Web Services) ).

Code Block

language	json

{
  "error": {
    "code":"0",
    "message":"This service needs an Authorization Header"
  }
}
{
  "Miembros": []
}

404 (Not Found).

Respuesta Vacía (Web Service, no encontrado)

500 (Internal Server Error)

(Error Interno del Servidor de las API’s REST).

Code Block

language	json

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Info

INFORMACIÓN

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

Note

NO DEBE OLVIDAR

NO olvide tomar en cuenta para el uso de este Web Service, el Flujo de Trabajo descrito en Web Services de Créditos, dado a que en caso de no seguirlo al pie de la letra puede generar errores inesperados en la ejecución.

Note
RESPETE LOS ENCABEZADOS OBLIGATORIOS para que pueda consumir el WEB SERVICE respectivo.

Code Block

language	json

Content-Type: application/json
Authorization: OAuth f2a9ec34-cf83-46f5-8862-f78ac03670d1!171380a787a9152688ab61a94d66e0eb77...
GENEXUS-AGENT: SmartDevice Application

Warning

EN CASO DE ERROR HTTP 401 (Not Authenticated)

Por favor validar que esta colocando los Encabezados Adecuadamente, y de persistir el problema dirigirse a la Pagina (Configuración de Seguridad para Obtener Token de Acceso y Consumir de los Web Services), para generar nuevamente su Token de Acceso, y/o verificar problemas con su acceso al API REST.

Live Search

spaceKey	DOC
placeholder	Búsqueda en esta Pagina
type	page

Enlaces Relevantes

Artículos Actualizados Recientemente

Recent updates

types	page
max	5
spaces	DOC
theme	concise
hideHeading	true

Change History

Versions Compared

Old Version 2

New Version Current

Key

Web Services para Crear Solicitud de Pago Grupal.

DESCRIPCIÓN.

EJEMPLOS DE REQUEST Y RESPONSE, PARA LOS SERVICIOS RESTful BAJO PROTOCOLO HTTP.

METODO POST

Tipo de Mensaje HTTP

Ejemplo

Enlaces Relevantes

Artículos Relacionados

Artículos Actualizados Recientemente

Page Comparison

Versions Compared

Old Version 2

New Version Current

Key

Web Services para Crear Solicitud de Pago Grupal.

DESCRIPCIÓN.

EJEMPLOS DE REQUEST Y RESPONSE, PARA LOS SERVICIOS RESTful BAJO PROTOCOLO HTTP.

METODO POST

Tipo de Mensaje HTTP

Ejemplo

Enlaces Relevantes

Artículos Relacionados

Artículos Actualizados Recientemente