bcs-loans-management-api-services

API INFORMATION

Title: loan-management-api-services

Version: 1.0.0

Protocols: HTTPS

URI Sandbox: https://loan-management-api-services-dev.us-e1.cloudhub.io/loansManagement/v1

URI QA: https://loan-management-api-services-qa.us-e1.cloudhub.io/loansManagement/v1

URILive: https://loan-management-api-services-prod.us-e1.cloudhub.io/loansManagement/v1

DOWLOAD RAML

DESCRIPTION

This service allows saving the document associated with the creation of the Digital application, which allows the following operations:

Summary

-Digital Application Creation

Path:

/loansManagement/v1/Customer:

Headers

Response information:

responseType: Used to return the response

-Consult Status Disbursement

This operation is used to Consult Status Disbursement:

Request example:

/loans-management/v1/status-disbursement

Query Params

refNumber: Request Number
govIssueIdentType: User Identification Type
identSerialNum: User Identification Number

ResponseType:

depAcctStmtRec:

depAcctId: Contains the acctId field which indicates the credit number

disbursement:

depAcctId: Contains the acctId field which indicates disbursement account number
issueDt: disbursement date
issueHourDt: disbursement date
flagDisbursementType: disbursement Type
flagSavingsAcct: Indicates the payment on account

Example

{
  "depAcctStmtRec": {
    "depAcctId": {
      "acctId": "30019759220"
    }
  },
  "disbursement": {
    "depAcctId": {
      "acctId": "000"
    },
    "issueDt": "2020-03-10",
    "issueHourDt": "03:54:33 PM",
    "flagDisbursementType": "03",
    "flagSavingsAcct": "Y"
  }
}

> Errors Code.

Additional the error code of APIKit this resource it has some custom errors code or bussines errors and all errors used the follogin structur.
{
   "responseType": {
       "value": "ER"
   },
  "responseDetail": {
       "errorCode": "00001",
       "errorDesc": "Error En la Consulta.",
       "errorType": "DBA"
   }
}

> Diagram of sequence.

####

##

-Consult Offer Release

This operation is used to Consult offer release:

Request example:

/loans-management/v1/payroll-based

Body

govIssueIdent: Identification given by the local government

identSerialNum: Identification number
govIssueIdentType: Identification type

depAcctStmtRec: Information regarding deposits

depAcctId: Contains the field refNumber which indicates the number of request

offer: Information related to the offers of a credit application

requestType: Type of order
requestVersion: Order Version
viabilityType: Feasibility Type
processStage: Process Stage
cityId: Origin City Code of Filing
flagRecommended: Flag Exception Recommended
momentIndicator: Moment Indicator
executionLine: Execution Line

product: Contains the field productId which contains the fields

ledgerCode: Ledger Code
subLedgerCode: Sub Ledger Code
groupCode: Group Code
ledgerCode2: ledger Code 2
subLedgerCode2: Sub Ledger Code 2
groupCode2: Group Code 2

applicantInfo: Information related to the Applicant containing the objects

• govIssueIdent: Identification given by the local government

identSerialNum: Identification number
govIssueIdentType: Identification type

• personName: Customer information

lastName: Customer's First Last Name
secondLastName: Customer's Second Last Name
firstName: Customer's First Name
middleName: Customer's Middle Name

• personInfo: Information about a person

age: Date birth
maritalStatus: Code marital status
educationLevel: Education level
gender: Gender
typeOfHousing: Housing Type

• vlrRental: rental value
• flagEmployeEFS: Employee Indicator Social Group Foundation

listOcupation: List Ocupation

• businessInfo: Occupation information, contains the fields:

businessType: Occupation
flagPpalActivity: Flag main activity
formality: Formality
labourSector: Labour Sector
market: Market
incomeAmt: Gross income value
netIncomeAmt: Net income value
laborSeniorityAnnual: Years of employment
laborSeniorityMonthly: Years of employment Months
segment: Segment
subSegment: Sub Segment
contractType: Contract Type
discountCapacity: Capacity Discount
flagWordPlace: Indicates WorkPlace

incomeInfo: Income Info

• personInfo: Person Info, contains the field:

incomeAmt: Value Income

• idItem: identifier Item

productInfo: Product Info

• itemGeneric1: Order Item1
• priority: Priority
• productId: product Identifier, contains the fields:

ledgerCode: Ledger Code
subLedgerCode: Sub Ledger Code
groupCode: Group Code

• productClass: Product Class
• productType: Product Type
• productTA: Product Code
• amtRequested: Requested amount
• termUnits: Term
• entprType: Agreement type
• entprId: Agreement code
• exemptionAmt: Exemption of amount
• flagPortfolioBuy: Flag Purchase Portfolio
• flagRetank: Retanqueo flag
• flagIncrementQuota: Flag Quota Increase
• flagRequiredDual: Flag Requires Duality
• productLine: Product Line
• currentQuota: Curren quota
• additionalQuota: Additional Quota
• flagProductSelected: Flag Product Selected
• indOfferSelected: Ind Offer Selected
• mortgageInfo: Mortgage Info, contains the fields:

changeMortgageCount: Change Mortgage Count
vlrMortgage: Property value
vlrBusinessBuyingSelling: Negotiation Value Purchase Sale
housingType: Housing Type
location: Location
cityId: City Identifier
district: District
propertyType: Property Type
socialClass: Social Class
govPrg: Solidarity government program
coverageTermValidity: Coverage Validity Time
flagHousingVis: Vis Housing Flag
savingsCapacity: Savings Capacity
periodOfGrace: Period Of Grace
indRenewalUrb: Indicates Urban Renewal Project
indSubQuota: Indicates Sub Quota
indProperty: Indicates Property
indCTYL: Indicates Presents ctyl

• idPayPeriodicity: Indicates Pay Periodicity
• obligationNum: Obligation Num, contains the fields:

flagFNG: Flag applies FNG
vlrAproxFNG: Value Approximate FNG
vlrRentingMortagage: Value Renting Mortagage

relationtInfo: Relationt Info

• govIssueIdent: Identification given by the local government

identSerialNum: Identification number
govIssueIdentType: Identification type

• personName: Customer information

lastName: Customer's First Last Name
secondLastName: Customer's Second Last Name
firstName: Customer's First Name
middleName: Customer's Middle Name

• relationType: Relation Type
• relationShipPpal: Main owner relationship
• flagIndInsurable: Flag Indicates Insurable
• flagContributorING: Flag Contributor ING
• flagReqSignedContract: Flag Request No Signature Deed
• flagPolicyExtremeHousing: Flag Policy External Life Housing

listDataSourceProperty: List Data Source Property

• incomeInfo: Income InfoidItem: Identifier Item
• projectData: Project Info, contains the fields:

projectCode: Project Code
projectType: Project Type
nitBuilder: builder Code
nameBuilder: builder name
nameProject: Project name
postAddr: contains the addr1 field which indicates the direction
flagEscrow: Indicates Fidei Comiso

Example

{

    "govIssueIdent":{
        "identSerialNum":"1234567890",
        "govIssueIdentType":"CC"
    },
    "depAcctStmtRec":{
        "depAcctId":{
            "refNumber":"550100000000001"
        }
    },
    "offer":{
        "requestType":"Sales Order",
        "requestVersion":"1",
        "viabilityType":"1",
        "processStage":"02",
        "cityId":"11001",
        "flagRecommended":"N",
        "momentIndicator":"1.",
        "executionLine":"C"
    },
    "product":[
        {
            "productId":{
                "ledgerCode":"C ",
                "subLedgerCode":"C ",
                "groupCode":"C ",
                "ledgerCode2":"C ",
                "subLedgerCode2":"C ",
                "groupCode2":"C "
            }
        }
    ],
    "applicantInfo":[
        {
            "govIssueIdent":{
                "identSerialNum":"1234567890",
                "govIssueIdentType":"CC"
            },
            "personName":{
                "lastName":"DE_FRANCISCO",
                "secondLastName":"LOPEZ",
                "firstName":"CARLOS",
                "middleName":"MARIO"
            },
            "personInfo":{
                "age":"22",
                "maritalStatus":"S",
                "educationLevel":"04. ",
                "gender":"F",
                "typeOfHousing":"P "
            },
            "vlrRental":"0",
            "flagEmployeEFS":"N"}
        ],
    "listOcupation":[
        {
            "businessInfo":{
                "businessType":"14",
                "flagPpalActivity":"Y.",
                "formality":"FORMAL ",
                "labourSector":"MX ",
                "market":"MASIVO ",
                "incomeAmt":"20000000",
                "netIncomeAmt":"0",
                "laborSeniorityAnnual":"0",
                "laborSeniorityMonthly":"0",
                "segment":"02",
                "subSegment":"ASALARIADO",
                "contractType":"01",
                "discountCapacity":"N",
                "flagWordPlace": "Y"
            }
        }
    ],
    "incomeInfo":[
        {
            "personInfo":{
                "incomeAmt":"20000000"
            },
            "idItem":"1-3LU2K1"
        }
            ],
    "productInfo":[{
        "itemGeneric1": "1",
        "priority": "1",
        "productId":{
            "ledgerCode":"C",
            "subLedgerCode":"C",
            "groupCode":"C"
        },
        "productClass": "18",
        "productType": "ACTIVO",
        "productTA": "980000",
        "amtRequested": "0",
        "termUnits": "60",
        "entprType": "1",
        "entprId": "1",
        "exemptionAmt": "S",
        "flagPortfolioBuy": "S",
        "flagRetank": "S",
        "flagIncrementQuota": "S",
        "flagRequiredDual": "S",
        "productLine" : "1",
        "currentQuota": "0",
        "additionalQuota": "1",
        "flagProductSelected": "1",
        "indOfferSelected": "1",
        "mortgageInfo":{
            "changeMortgageCount": "1",
            "vlrMortgage": "1",
            "vlrBusinessBuyingSelling": "1",
            "housingType": "1",
            "location": "1",
            "cityId": "1",
            "district": "1",
            "propertyType" : "1",
            "socialClass": "1",
            "govPrg": "1",
            "coverageTermValidity": "1",
            "flagHousingVis": "1",
            "savingsCapacity": "1",
            "periodOfGrace": "1",
            "indRenewalUrb": "1",
            "indSubQuota": "1",
            "indProperty": "1",
            "indCTYL": "1"
        },
        "idPayPeriodicity": "01",
        "obligationNum":{
            "flagFNG": "S",
            "vlrAproxFNG": "0",
            "vlrRentingMortagage": "0"
        }
    }],
    "relationtInfo":[{
        "govIssueIdent":{
            "identSerialNum":"1234567890",
            "govIssueIdentType":"CC"
        },
        "personName":{
            "firstName":"CARLOS",
            "middleName":"MARIO",
            "lastName":"DE_FRANCISCO"
            "secondLastName":"LOPEZ"
        },
        "relationType": "01",
        "relationShipPpal": "01",
        "flagIndInsurable": "S",
        "flagContributorING": "S",
        "flagReqSignedContract": "Y",
        "flagPolicyExtremeHousing": "Y"
}],
"listDataSourceProperty":[{
   "incomeInfo":{
      "idItem": "1"
   },
   "projectData":{
    "projectCode": "1",
    "projectType": "1",
    "nitBuilder": "1",
    "nameBuilder": "1",
    "nameProject": "1",
    "postAddr":{
        "addr1": "1"
    },
    "flagEscrow": "N"
   }
}]
}

ResponseType:

offer: Contains the offer data

requestType: Request Type
requestVersion: Request Version
viabilityResult: Viability Result
creditRating: Credit Rating
flagException:
flagBuroQuery:
scoreType:
score:
dataCreditBuroPriority:
cifinBuroPriority:
flagOfferBalanced:
indMoment:`
executionLine: Execution Line

depAcctStmtRec: Contains reference information

• depAcctId: Contains reference number

refNumber: reference number

aplicantInfo: Aplicant Information

• govIssueIdent: Identification given by the local government

identSerialNum: Identification number
govIssueIdentType: Identification type

• goodCustomer: Good Customer

productInfo: Contains product information

• ItemGeneric1:
• ItemGeneric2:
• product: roduct information, contains the field "productId" which indicates Product identifiers, with the fields:

ledgerCode: Ledger Code
subLedgerCode: Sub Ledger Code
groupCode: Group Code

• informedOfferAmt: Informed offer amount
• intRateInfo: Product identifiers, containing the fields:

rate: Informed offer amount

• term: Term
• entprAgreement: Product identifiers, containing the fields:

entprType: Agreement type
entprId: Agreement type

• viabilityResultInformed: Viability Result Informed
• fortfolioBuy: Product identifiers, containing the field:

flagPortfolioBuy: Flag Portfolio Buy

• estimateAmt: Estimate quota
• amortSystem: Amortization system
• periodOfGrace: Period Of Grace
• changePropertyCount: Real estate change counter
• propertyAmt: Property value
• vlrBusinessBuyingSelling: Value business purchase sale
• housingType: Housing Type
• postAddr: Product identifiers, containing the fields:

addr2: Address
cityId: City
neighborhood: Neighborhood

• propertyType: Property Type
• socialClass: Social Class
• govPrg: Solidarity government program
• coverageTermValidity: Coverage Term Validity
• flagHousingVis: Flag Housing Vis
• suggestedTerm: suggested minimum term
• initialQuotaOwnResouces: Own resources initial fee
• vlrQuotaSubsidyFrech: Quota Subsidy Frech
• indRenewalUrb: Indicates urban renewal project
• indSubQuota: Indicate subsidy Quota
• rateWithBenefit: Profit rate
• indProperty: Defined furniture
• indCTYL: Presents CTYL
• payPeriodicityId: Payment periodicity
• vlrAproxFNG: Approximate value FNG

relationtInfo: Contains relationship information

• govIssueIdent: Identification given by the local government, containing the fields:

identSerialNum: Identification number
govIssueIdentType: Identification type

• personName: Customer information, containing the fields:

lastName: Customer's First Last Name
secondLastName: Customer's Second Last Name
firstName: Customer's First Name
middleName: Customer's Middle Name

• relationType: Relation Type
• flagIndInsurable: Insurable
• flagContributorING: Contributor ING
• flagReqSignedContract: Signed Contract
• viabilityResult: Viability Result
• creditRating: Credit Rating
• flagBuroQuery: Bureau consulted Flag
• scoreType: Score Type
• score: Score
• flagPolicyExtremeHousing: External life housing policy
• dataCreditBuroPriority: DataCredit Bureau Priority
• cifinBuroPriority: Priority Bureau Data CIFIN
• flagExcludeCollection: Exclude participant
• financialExperience: Financial Experience
• clientType: Client type, containing the field "name" which indicates the Client type

listOrigPropertyData: Project data

Example

{
    "offer":{
        "requestType": "Sales Order",
        "requestVersion": "1",
        "viabilityResult": "01",
        "creditRating": "AAA",
        "flagException": "Y",
        "flagBuroQuery": "Y",
        "scoreType": "07",
        "score": "927",
        "dataCreditBuroPriority": "Y",
        "cifinBuroPriority": "Y",
        "flagOfferBalanced": "Y",
        "indMoment": "1",
        "executionLine": "C"
    },
    "depAcctStmtRec": {
        "depAcctId": {
            "refNumber": "1-218073594"
        }
    },
    "aplicantInfo":[{
        "govIssueIdent":{
            "govIssueIdentType": "CC",
            "identSerialNum": "123456789"
        },
        "goodCustomer": "SI"
    }],
    "productInfo": [{
        "ItemGeneric1": "1",
        "ItemGeneric2": "1",
        "product":{
            "productId": {
                "ledgerCode": "300120",
                "subLedgerCode": "300120",
                "groupCode": "300120"
            },
        "informedOfferAmt": "91000000",
        "intRateInfo": {
            "rate": "16"
        },
        "term": "240",
        "entprAgreement": {
          "entprType": "41",
          "entprId": "40000010"
        },
        "viabilityResultInformed": "Y",
        "fortfolioBuy": {
          "flagPortfolioBuy": "Y"
        },
        "estimateAmt": "1190217",
        "amortSystem": "01",
        "periodOfGrace": "0",
        "changePropertyCount": "0",
        "propertyAmt": "130000000",
        "vlrBusinessBuyingSelling": "150000000",
        "housingType": "01",
        "postAddr": {
          "addr2": "02",
          "cityId": "11001",
          "neighborhood": "SUBA"
        },
        "propertyType": "01",
        "socialClass": "3",
        "govPrg": "04",
        "coverageTermValidity": "84",
        "flagHousingVis": "02",
        "suggestedTerm": "234",
        "initialQuotaOwnResouces": "3.9",
        "vlrQuotaSubsidyFrech": "0",
        "indRenewalUrb": "N",
        "indSubQuota": "N",
        "rateWithBenefit": "0",
        "indProperty": "01",
        "indCTYL": "02",
        "payPeriodicityId": "01",
        "vlrAproxFNG": "0"
        }
    }],
    "relationtInfo": [{
        "govIssueIdent":{
            "govIssueIdentType": "CC",
            "identSerialNum": "123456789"
        },
        "personName":{
            "lastName":"DE_FRANCISCO",
            "secondLastName":"LOPEZ",
            "firstName":"CARLOS",
            "middleName":"MARIO"
        },
        "relationType": "01",
        "flagIndInsurable": "N",
        "flagContributorING": "S",
        "flagReqSignedContract": "N",
        "viabilityResult": "01",
        "creditRating": "AAA",
        "flagBuroQuery": "N",
        "scoreType": "07",
        "score": "927",
        "flagPolicyExtremeHousing": "N",
        "dataCreditBuroPriority": "Y",
        "cifinBuroPriority": "Y",
        "flagExcludeCollection": "N",
        "financialExperience": "02",
        "clientType": {
            "name": "N"
        }
    }],
    "listOrigPropertyData": [{
        "product":{
            "idItem": "1-3P0SPR",
            "projectData": {
              "projectCode": "192160001975",
              "projectType": "02",
              "nitBuilder": "8300558977",
              "nameBuilder": "PATRIMONIOS AUTONOMOS FIDUCIAR",
              "nameProject": "CIUDAD VERDE CIPRES",
              "postAddr": {
                "addr1": "UPER MANZANA 45 LOTE 3 ET. 7A CIUDAD VERDE"
              },
              "flagEscrow": "N"
            }
        }
    }]
}

> Errors Code.

Additional the error code of APIKit this resource it has some custom errors code or bussines errors and all errors used the follogin structur.
{
   "responseType": {
       "value": "ER"
   },
  "responseDetail": {
       "errorCode": "00001",
       "errorDesc": "Error En la Consulta.",
       "errorType": "DBA"
   }
}

> Diagram of sequence.

####

-Update automatic debit

Description: This service allows you to register or unregister an account to program the automatic debit for the payment of a credit.

###

Put:

/loan-managment/v1/automatic-debit

Request information (Body):

productId: (Contains information related to return product identification.) (Optional)
    ledgerCode: First classification of the type of product according to the bank's product catalog (Optional)
    subledgerCode: Second classification of the type of product according to the bank's product catalog. (Optional)
    groupCode: Third classification of the type of product according to the bank's product catalog. (Optional)
depAcctId: (depAcctId object)
    term:  (term object)
       flagAutomDebit: Contains information related to Automatic Debit Indicator. (Required)
    acctId: Contains information related to Account number to debit, Mandatory to Program Automatic Debit, and optional to eliminate Automatic Debit.
depAcctIdFrom: (depAcctIdFrom object)
    acctId: Contains information related to loan account number. (Required)

> Body request example:

{
   "depAcctId": {
    "term": {
      "flagAutomDebit": true
    },
    "acctId": "5345678678"
  },
  "depAcctIdFrom": {
    "acctId": "5654446777"
  }
}

Response information:

responseType: Response type object.

value: Response Value

> Example response 201.

{
    "responseType": {
        "value": "OK"
    }
}

> Example response Error.

Additional the error code of APIKit this resource it has some custom errors code or bussines errors and all errors used the follogin structur.
{
  "responseType": {
    "value": "ER"
  },
  "responseDetail": {
    "errorCode": "00001",
    "errorDesc": "NO EXISTE NUMERO DE PRESTAMO",
    "errorType": "RGN"
  }
}

> Errors codes

> Diagram of sequence

####

- CoreCobranza- Payment Online.

Path:

GET:

/loans-management/v1/payments/{acctId}?operationType={operationType}:

UriParams

QueryParams

Headers

Mapping Data:

- Response:

Examples:

Example of Body Response:

{
  "pmtInfo": [
    {
      "pmtId": "12312312",
      "pmtType": "E",
      "loanAcctId": {
        "acctId": "24519839999"
      },
      "govIssueIdent": {
        "identSerialNum": "1234567890",
        "govIssueIdentType": "CC"
      },
      "origDt": "2022-09-22",
      "effDt": "2022-09-22",
      "curAmt": {
        "amt": 10000.00
      },
      "channel": "CBR",
      "submitOffice": {
        "branchId": "1114"
      }
    }
  ],
  "responseType": {
    "value": "OK"
  }
}

Error Code Response:

Diagrama.