1.2.4.2 Consumer Services - Interest and Charges

This topic describes about the consumer services required for Interest and Charges Implementation.

The below endpoints must be configured under Consumer Services in Oracle Banking Routing Hub:

1. Fetch Interest Rate for A Virtual Account (fetchgcScIcRate)
2. Close Virtual Account (closeIEAccount)
3. Event for account group product mapping (CREATE_EXT_IC_GRP_PRD)
4. Fetch Accrued Interest (fetchAccuredInt)
5. Event to create account group (CREATE_EXT_IC_GRP)
6. Event to Liquidate accrued interest for a Virtual account (liquidateInterest)
7. Fetch Bank Level IC Group (fetchExtICGrps)
8. Fetch Product Map For Group (fetchPrdMapForGrp)
9. Virtual accounts creation to IC system (CREATE_IC_ACCOUNT)
10. Event to trigger Value dated balance fetch (vdbalMaster)

Figure 1-17 Consumer Services - Interest and Charges

Description of "Figure 1-17 Consumer Services - Interest and Charges"

fetchgcScIcRate

This API enables the user to fetch the interest rates for a Virtual Account.

Request / Response

SERVICE-CONSUMER = “OBVAM_IC”

SERVICE-CONSUMER-SERVICE = “fetchgcScIcRate”

Request:

{
  "branch": “string”,         
  "account": “string”,         
  "extAccGrp": “string”,         
  "accGrp": “string”,         
  "dateFrom": “string”,         
  "dateTo": “string”,         
  "ccy": “string”,
  "dateType": “string”, 
}

Response:

{ 
  "data": 
  [ 
    { 
      "aclass": "string",  
      "productCode": "string",   
      "ccyCode": "string",   
      "udeEffDt": "string",   
      "branchCode": "string",   
      "RateCategory": "string",   
      "productdesc": "string",   
      "GenUdeValList": 
      [   
        {   
          "udeId": "string",    
          "udeDesc": "string",         
          "udeType": "string",         
          "udeValue": 0,         
          "rateCode": "string",         
          "tdRateCode": "string"    
        }    
      ]  
    } 
  ], 
  "warnings": 
  [
    { 
      "warningCode": "string",   
      "warningDesc": "string" 
    }   
  ],   
  "errors": 
  [ 
    { 
      "errorCode": "string",   
      "errorDesc": "string" 
    }  
  ]
}

closeIEAccount

This API enables the user to close a Virtual Account.

Request / Response

SERVICE-CONSUMER = “OBVAM_IC”

SERVICE-CONSUMER-SERVICE = “closeIEAccount”

Request:

{
  "source": "string",       
  "branch": "string",
  "acc": "string",
  "currency": "string"
}

Response:

{ 
  "warnings": 
  [   
    {                          
      "warningCode": "string",                          
      "warningDesc": "string"   
    } 
  ],
  "errors": 
  [   
    {                          
      "errorCode": "string",                          
      "errorDesc": "string"   
    } 
  ] 
}

CREATE_EXT_IC_GRP_PRD

This API enables the user to generate an event for account group product mapping.

Request / Response

SERVICE-CONSUMER = “OBVAM_IC”

SERVICE-CONSUMER-SERVICE = “CREATE_EXT_IC_GRP_PRD”

Request:

{
  "accGrp": "string",  
  "accGrpDesc": "string",
  "accProdList": 
  [
    {
      "productCode": "string",      
      "productDescription": "string",      
      "ccy": "string",    
      "open": "string"
    }
  ]
}

Response:

{ 
  "warnings": 
  [  
    {      
      "warningCode": "string",      
      "warningDesc": "string"  
    }
  ],  
  "errors": 
  [  
    {      
      "errorCode": "string",      
      "errorDesc": "string"  
    } 
  ] 
}

fetchAccuredInt

This API enables the user to fetch the accrued Interest.

Request / Response

SERVICE-CONSUMER = “OBVAM_IC”

SERVICE-CONSUMER-SERVICE = “fetchAccuredInt”

Request:

{
  "brn": string,  
  "acc": string,  
  "source": string 
}

Response:

{  
  "data": 
  {   
    "brn": "string",   
    "acc": "string",   
    "source": "string",   
    "totalAccrDr": 0,   
    "totalAccrCr": 0,   
    "accruedAmtList":
    [      
      {         
        "acc": "string", 
        "brn": "string",         
        "prod": "string",         
        "frmNo": 0,         
        "accruedAmt": 0,         
        "drcr": "string"      
      }      
    ]   
  }, 
  "warnings": 
  [  
    {  
      "warningCode": "string",    
      "warningDesc": "string"  
    } 
  ], 
  "errors": 
  [ 
    {  
      "errorCode": "string",    
      "errorDesc": "string" 
    }  
  ]
}

CREATE_EXT_IC_GRP

This API enables the user to generate an event to create an account group.

Request / Response

SERVICE-CONSUMER = “OBVAM_IC”

SERVICE-CONSUMER-SERVICE = “CREATE_EXT_IC_GRP”

Request:

{
  "accGrp": "string"  
  "accGrpDesc": "string"  
  "extAccGrp": "string"  
  "extAccGrpDesc": "string"
  "extAccGrpType": "string"
}

Response:

{ 
  "warnings": 
  [  
    {      
      "warningCode": "string", 
      "warningDesc": "string"   
    } 
  ], 
  "errors": 
  [  
    {      
      "errorCode": "string",      
      "errorDesc": "string"   
    }                 
  ] 
}

liquidateInterest

This API enables the user to generate an event to liquidate accrued interest for a Virtual account.

Request / Response

SERVICE-CONSUMER = “OBVAM_IC”

SERVICE-CONSUMER-SERVICE = “liquidateInterest”

Request:

{
  "onliq":
  [
    {
      "branchCode": "string",      
      "accountNumber": "string",      
      "productCode": "string",
      "liquidationDate": "string"
    }
  ]
}

Response:

{ 
  "onliq": 
  [   
    {       
      "msgStat": "string",       
      "onliq": {},       
      "warnings":
      [                    
        {           
          "warningCode": "string",           
          "warningDesc": "string"        
        } 
      ],      
      "errors": 
      [                   
        {          
          "errorCode": "string",          
          "errorDesc": "string"       
        }       
      ]   
    }  
  ] 
}

fetchExtICGrps

This API enables the user to fetch a Bank-Level IC Group.

Request / Response

SERVICE-CONSUMER = “OBVAM_IC”

SERVICE-CONSUMER-SERVICE = “fetchExtICGrps”

Request:

{
  "accGrp": "string",
  "extAccGrpType": "string"
}

Response:

{ 
  "data":   
  {  
    "AccGrpList": 
    [
      {                      
        "accGrp": "string",
        "accGrpDesc": "string",         
        "extAccGrpType": "string"   
      }   
    ] 
  }, 
  "errors": 
  [  
    {      
      "errorCode": "string",      
      "errorDesc": "string"  
    }         
  ] 
}

fetchPrdMapForGrp

This API enables the user to fetch a Product Map for Group.

Request / Response

SERVICE-CONSUMER = “OBVAM_IC”

SERVICE-CONSUMER-SERVICE = “fetchPrdMapForGrp”

Request:

{
  "accGrp": "string",  
  "productCode": "string",
  "ccy": "string"
}

Response:

{ 
  "data":   
  {  
    "IcGrpPrdList":
    [      
      {         
        "accGrp": "string",         
        "accGrpDesc": "string",         
        "accProdList":
        [          
          { 
            "productCode": "string",             
            "productDescription": "string",
            "ccy": "string",
            "open": "string"          
          } 
        ]  
      }   
    ] 
  },  
  "errors": 
  [  
    {       
      "errorCode": "string",       
      "errorDesc": "string"   
    } 
  ] 
}

CREATE_IC_ACCOUNT

This API enables the user to create a Virtual account for the IC system.

Request / Response

SERVICE-CONSUMER = “OBVAM_IC”

SERVICE-CONSUMER-SERVICE = “CREATE_IC_ACCOUNT”

Request:

{
  "accMasterList":
  [   
    {
      "acc": "string",       
      "childAcc": "string",       
      "accountClass": "string",       
      "accType": "string",       
      "acOpenDate": "string",       
      "bookAcc": "string",       
      "bookBrn": "string",       
      "bookCcy": "string",       
      "brn": "string",       
      "calcAcc": "string",       
      "ccy": "string",       
      "custNo": "string",       
      "consolChgAcc": "string",       
      "intStartDate": "string",       
      "sourceSystem": "string",       
      "sourceSystemBrn": "string",       
      "sourceSystemAcc": "string",       
      "chargeBookAcc": "string",       
      "chargeBookBrn": "string",       
      "chargeBookCcy": "string",       
      "chgStartDate": "string"   
    } 
  ]
}

Response:

{ 
  "warnings": 
  [   
    {    
      "warningCode": "string",        
      "warningDesc": "string"   
    }   
  ],  
  "errors": 
  [  
    {      
      "errorCode": "string",      
      "errorDesc": "string"   
    } 
  ] 
}

vdbalMaster

This API enables the user to fetch a Virtual account balance.

Request / Response

SERVICE-CONSUMER = “OBVAM_IC”

SERVICE-CONSUMER-SERVICE = “vdbalMaster”

Request:

{
  "type" : "string",
  "extRefNo" : "string",
  "sourceCode" :"string",
  "vdBalList":[
    {
    "acc" : "string",
    "brn": "string",
    "ccy": "string",
    "valDt":"string"
    }
  ]
}

Response:

{ 
  "warnings": 
  [   
    {    
      "warningCode": "string",        
      "warningDesc": "string"   
    }   
  ],  
  "errors": null
}