cboj-loans-prc-api

1.0.x
(0 reviews)

Loans Process API

Base URLs

EnvironmentBase URLs
Mockhttps://eu1.anypoint.mulesoft.com/mocking/api/v1/sources/exchange/assets/4be2e19f-42da-4571-80fd-19077a31ce58/cboj-loans-prc-api/1.0.36/m
Devhttps://maictrldev.capitalbank.jo/loans-prc/v1
Staginghttps://maictrlstg.capitalbank.jo/loans-prc/v1
ProductionNA

Description

This document covers the business logics of Loan Interface. Loan interface deals with the services :

  1. Get loan details
  2. Get loan schedule Dates
  3. Get loan Past Dues
  4. Get New Loan Simulation
  5. Create and Update Loan Simulation
  6. Create Loan Disbursement
  7. Get Existing Liabilities
  8. Get Existing Collateral
  9. Get Schedule Projection
  10. Create Collateral Right or Amendment
  11. Get Eligible Loan Products
  12. Get Guarantor Details
  13. Get Active Lending Products
  14. Get Insurance Company Details
  15. Get Global Child Limits
  16. Get Effective Interest Rate
  17. Get Car Types
  18. LOS Get Floating Rates
  19. LOS Get Periodic Rates
  20. Get CustomerAcct interest Details
  21. LOS Create PD Loan

Technical Specifications

Headers

Below are the headers that are set with every HTTP Request

Header NameSample ValueOptional?
client_id9712801dbaaffg90d43a0b09c59fdaf21e65524235436Mandatory
client_secret234d8AeC33e34bE1b3eiud31b2887cD4Mandatory
AuthorizationBearer afdca88b-9ed0-344b-8af0-b2195e382574Optional
x-channel-idDEVCHLMandatory
x-correlation-id13243564564Mandatory
x-bank-idCBOJMandatory
x-debug-flag0Optional (enum - 0 or 1)
x-customer-id2100122Optional (mandatory for customer facing channels)
x-user-id1234Optional
x-sub-channel-iddevchannelOptional

Error handling

HTTP Status:

The HTTP error codes are:

  • 400 - Bad Request: An error in the client request (Mostly due to validations)
  • 401 - Unauthorized: User can't be authenticated
  • 403 - Forbidden: The server cannot give access to the resource
  • 404 - Not Found: The resource defined in the URL doesn't exist
  • 405 - Method Not Allowed
  • 406 - Not Acceptable
  • 415 - Unsupported Media Type
  • 500 - Internal Server Error: The server encountered an unexpected condition
  • 501 - Not Implemented

Error Response

A REST API should reply with an error code and a message to be shown to the consumer.

{
    "status": {
        "success": false,
        "code": "400",
        "reasonCode": "BadRequest",
        "arabicMessage": "لم يتم العثور على سجلات تطابق محددات البحث",
        "englishMessage": "No records were found that matched the selection criteria",
        "backendError": "No records were found that matched the selection criteria",
        "backendCode": "T24003790"
    }
}

Api Security

Below polices are applied.

NameDescriptionExample
Client ID EnforcementIt restricts access to a protected resourceclient_id: 9d41a8940c5e4181aace6fc5e6cfffc3 client_secret: aB9D5Bd7450d49F584F23250D96872fD
IP Allowlistallows a list or range of IP addresses to access and interacts with a configured API endpoint.192.168.61.1
192.168.61.2
192.168.62.1

Config Information

  1. If there is new endpoint comes in which needs to access t24 version which is not already available in config, then add the version name,field and operator in config properties under tag t24 and access it in code.

Reviews