Jump to

• Request
• Response

Query the Collateral details through a Backoffice Service

get

/backoffice-services/backoffice/loans/elcm/collateral

This operation queries the collateral details through a Backoffice Service.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• branchCode(optional): string
  branch Code
• collateralCategory(optional): string
  Category of the Collateral
• collateralCode(optional): string
  Collateral Code
• collateralCurrency(optional): string
  Collateral Currency
• collateralType(optional): string
  Type of the Collateral
• liabilityNo(optional): string
  Liability Number of the Collateral
• startDate(optional): string
  Start Date of the Collateral

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Successful performs the operation

Body ()

Root Schema : ELCMCollateralModelCollection

Type: object

Collection of ELCM Collateral.

Show Source

• data(optional): array data

{
    "description":"Collection of ELCM Collateral.",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ELCMCollateralModel"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object ELCMCollateralModel
  Collateral model

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ELCMCollateralModel"
    }
}

Nested Schema : ELCMCollateralModel

Type: object

Collateral model

Show Source

• availableAmount(optional): number(double)
  Available Amount
• branchCode(optional): string
  Branch Code
• collateralAmount(optional): number(double)
  Collateral Amount
• collateralCategory(optional): string
  Collateral Category
• collateralCode(optional): string
  Collateral Code
• collateralCurrency(optional): string
  Collateral Currency
• collateralDescription(optional): string
  Collateral Description
• collateralType(optional): string
  Collateral Type
• liabilityNo(optional): string
  Liability Number
• startDate(optional): string
  Start Date
• utilizedAmount(optional): number(double)
  Utilized Amount

{
    "description":"Collateral model",
    "type":"object",
    "properties":{
        "collateralCode":{
            "description":"Collateral Code",
            "type":"string"
        },
        "collateralType":{
            "description":"Collateral Type",
            "type":"string"
        },
        "collateralCategory":{
            "description":"Collateral Category",
            "type":"string"
        },
        "collateralDescription":{
            "description":"Collateral Description",
            "type":"string"
        },
        "branchCode":{
            "description":"Branch Code",
            "type":"string"
        },
        "collateralCurrency":{
            "description":"Collateral Currency",
            "type":"string"
        },
        "availableAmount":{
            "description":"Available Amount",
            "type":"number",
            "format":"double"
        },
        "utilizedAmount":{
            "description":"Utilized Amount",
            "type":"number",
            "format":"double"
        },
        "startDate":{
            "description":"Start Date",
            "type":"string"
        },
        "liabilityNo":{
            "description":"Liability Number",
            "type":"string"
        },
        "collateralAmount":{
            "description":"Collateral Amount",
            "type":"number",
            "format":"double"
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

500 Response

Internal error

Back to Top