Jump to

• Request
• Response

Get existing collateral details based on the account ID

get

/DmCollateral-service/collateralDetails

This endpoint is used to get existing collateral details based on account ID.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• accountId(required): string
  Account ID to get existing collateral details.

Header Parameters

• appId(required): string
  The application ID of host service.
• branchCode(required): string
  The branch code of requesting branch.
• contentType: string
  The content type of request or response body.
• userId(required): string
  The user ID of requesting user.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Successfully performs the operation.

Body ()

Root Schema : CollateralDataCollection

Type: object

Collection of the Collateral Data

Show Source

• collateralData: array collateralData
  Collateral Data

{
    "description":"Collection of the Collateral Data",
    "type":"object",
    "properties":{
        "collateralData":{
            "description":"Collateral Data",
            "type":"array",
            "items":{
                "$ref":"#/definitions/DmCollateralDTO"
            }
        }
    }
}

Nested Schema : collateralData

Type: array

Collateral Data

Show Source

• Array of: object DmCollateralDTO
  Collateral Object

{
    "description":"Collateral Data",
    "type":"array",
    "items":{
        "$ref":"#/definitions/DmCollateralDTO"
    }
}

Nested Schema : DmCollateralDTO

Type: object

Collateral Object

Show Source

• addressLine1: string
  Address Line1
• addressLine2: string
  Address Line2
• addressLine3: string
  Address Line3
• addressLine4: string
  Address Line4
• assesdDt: string
  Assesd Date
• assesdValAmt: number
  Assesd Value Amount
• bankValAmt: number
  Bank Amount
• city: string
  City
• collateralCat: string
  Collateral Category
• collateralCd: string
  Collateral Code
• collateralCur: string
  Collateral Currency
• collateralDescr: string
  Collateral Description
• collateralId: string
  Collateral ID
• collateralNature: string
  Collateral Nature
• collateralSubTyp: string
  Collateral Sub Type
• collateralTypCd: string
  Collateral Type Code
• collateralTypDesc: string
  Collateral Type Description
• countryCd: string
  Country Code
• createdBy: string
  Created By
• cretDttm: string
  Create Date
• lastUpdatedBy: string
  Last Updated By
• lastUpdtDttm: string
  Last Update Date
• prdProcessrCd: string
  Product Processr Code
• rcdType: string
  Rcd Type
• RealisedAmt: number
  Realised Amount
• realizationStatus: string
  Realization Status
• realizationStatusDesc: string
  Realization Status description
• recoveredAmt: number
  Recovered Amount
• saleDt: string
  Sale Date
• setlmntDt: string
  Settlement Date
• soldBy: string
  Sold By
• stateCd: string
  State Code
• udf1: number
  udf1
• udf10: number
  udf10
• udf11: number
  udf11
• udf12: number
  udf12
• udf13: number
  udf13
• udf14: number
  udf14
• udf15: number
  udf15
• udf16: number
  udf16
• udf17: number
  udf17
• udf18: number
  udf18
• udf19: number
  udf19
• udf2: number
  udf2
• udf20: number
  udf20
• udf21: number
  udf21
• udf22: number
  udf22
• udf23: number
  udf23
• udf24: number
  udf24
• udf25: number
  udf25
• udf26: number
  udf26
• udf27: number
  udf27
• udf28: number
  udf28
• udf29: number
  udf29
• udf3: number
  udf3
• udf30: number
  udf30
• udf31: string
  udf31
• udf32: string
  udf32
• udf33: string
  udf33
• udf34: string
  udf34
• udf35: string
  udf35
• udf36: string
  udf36
• udf37: string
  udf37
• udf38: string
  udf38
• udf39: string
  udf39
• udf4: number
  udf4
• udf40: string
  udf40
• udf41: string
  udf41
• udf42: string
  udf42
• udf43: string
  udf43
• udf44: string
  udf44
• udf45: string
  udf45
• udf46: string
  udf46
• udf47: string
  udf47
• udf48: string
  udf48
• udf49: string
  udf49
• udf5: number
  udf5
• udf50: string
  udf50
• udf6: number
  udf6
• udf7: number
  udf7
• udf8: number
  udf8
• udf9: number
  udf9
• zipCd: string
  Zip Code

{
    "description":"Collateral Object",
    "type":"object",
    "properties":{
        "rcdType":{
            "description":"Rcd Type",
            "type":"string"
        },
        "collateralId":{
            "description":"Collateral ID",
            "type":"string"
        },
        "collateralCd":{
            "description":"Collateral Code",
            "type":"string"
        },
        "prdProcessrCd":{
            "description":"Product Processr Code",
            "type":"string"
        },
        "collateralTypCd":{
            "description":"Collateral Type Code",
            "type":"string"
        },
        "collateralTypDesc":{
            "description":"Collateral Type Description",
            "type":"string"
        },
        "collateralSubTyp":{
            "description":"Collateral Sub Type",
            "type":"string"
        },
        "collateralCat":{
            "description":"Collateral Category",
            "type":"string"
        },
        "collateralCur":{
            "description":"Collateral Currency",
            "type":"string"
        },
        "assesdValAmt":{
            "description":"Assesd Value Amount",
            "type":"number"
        },
        "assesdDt":{
            "description":"Assesd Date",
            "type":"string"
        },
        "bankValAmt":{
            "description":"Bank Amount",
            "type":"number"
        },
        "soldBy":{
            "description":"Sold By",
            "type":"string"
        },
        "saleDt":{
            "description":"Sale Date",
            "type":"string"
        },
        "collateralNature":{
            "description":"Collateral Nature",
            "type":"string"
        },
        "RealisedAmt":{
            "description":"Realised Amount",
            "type":"number"
        },
        "setlmntDt":{
            "description":"Settlement Date",
            "type":"string"
        },
        "realizationStatus":{
            "description":"Realization Status",
            "type":"string"
        },
        "realizationStatusDesc":{
            "description":"Realization Status description",
            "type":"string"
        },
        "recoveredAmt":{
            "description":"Recovered Amount",
            "type":"number"
        },
        "collateralDescr":{
            "description":"Collateral Description",
            "type":"string"
        },
        "addressLine1":{
            "description":"Address Line1",
            "type":"string"
        },
        "addressLine2":{
            "description":"Address Line2",
            "type":"string"
        },
        "addressLine3":{
            "description":"Address Line3",
            "type":"string"
        },
        "addressLine4":{
            "description":"Address Line4",
            "type":"string"
        },
        "city":{
            "description":"City",
            "type":"string"
        },
        "stateCd":{
            "description":"State Code",
            "type":"string"
        },
        "countryCd":{
            "description":"Country Code",
            "type":"string"
        },
        "zipCd":{
            "description":"Zip Code",
            "type":"string"
        },
        "cretDttm":{
            "description":"Create Date",
            "type":"string"
        },
        "lastUpdtDttm":{
            "description":"Last Update Date",
            "type":"string"
        },
        "createdBy":{
            "description":"Created By",
            "type":"string"
        },
        "lastUpdatedBy":{
            "description":"Last Updated By",
            "type":"string"
        },
        "udf1":{
            "description":"udf1",
            "type":"number"
        },
        "udf2":{
            "description":"udf2",
            "type":"number"
        },
        "udf3":{
            "description":"udf3",
            "type":"number"
        },
        "udf4":{
            "description":"udf4",
            "type":"number"
        },
        "udf5":{
            "description":"udf5",
            "type":"number"
        },
        "udf6":{
            "description":"udf6",
            "type":"number"
        },
        "udf7":{
            "description":"udf7",
            "type":"number"
        },
        "udf8":{
            "description":"udf8",
            "type":"number"
        },
        "udf9":{
            "description":"udf9",
            "type":"number"
        },
        "udf10":{
            "description":"udf10",
            "type":"number"
        },
        "udf11":{
            "description":"udf11",
            "type":"number"
        },
        "udf12":{
            "description":"udf12",
            "type":"number"
        },
        "udf13":{
            "description":"udf13",
            "type":"number"
        },
        "udf14":{
            "description":"udf14",
            "type":"number"
        },
        "udf15":{
            "description":"udf15",
            "type":"number"
        },
        "udf16":{
            "description":"udf16",
            "type":"number"
        },
        "udf17":{
            "description":"udf17",
            "type":"number"
        },
        "udf18":{
            "description":"udf18",
            "type":"number"
        },
        "udf19":{
            "description":"udf19",
            "type":"number"
        },
        "udf20":{
            "description":"udf20",
            "type":"number"
        },
        "udf21":{
            "description":"udf21",
            "type":"number"
        },
        "udf22":{
            "description":"udf22",
            "type":"number"
        },
        "udf23":{
            "description":"udf23",
            "type":"number"
        },
        "udf24":{
            "description":"udf24",
            "type":"number"
        },
        "udf25":{
            "description":"udf25",
            "type":"number"
        },
        "udf26":{
            "description":"udf26",
            "type":"number"
        },
        "udf27":{
            "description":"udf27",
            "type":"number"
        },
        "udf28":{
            "description":"udf28",
            "type":"number"
        },
        "udf29":{
            "description":"udf29",
            "type":"number"
        },
        "udf30":{
            "description":"udf30",
            "type":"number"
        },
        "udf31":{
            "description":"udf31",
            "type":"string"
        },
        "udf32":{
            "description":"udf32",
            "type":"string"
        },
        "udf33":{
            "description":"udf33",
            "type":"string"
        },
        "udf34":{
            "description":"udf34",
            "type":"string"
        },
        "udf35":{
            "description":"udf35",
            "type":"string"
        },
        "udf36":{
            "description":"udf36",
            "type":"string"
        },
        "udf37":{
            "description":"udf37",
            "type":"string"
        },
        "udf38":{
            "description":"udf38",
            "type":"string"
        },
        "udf39":{
            "description":"udf39",
            "type":"string"
        },
        "udf40":{
            "description":"udf40",
            "type":"string"
        },
        "udf41":{
            "description":"udf41",
            "type":"string"
        },
        "udf42":{
            "description":"udf42",
            "type":"string"
        },
        "udf43":{
            "description":"udf43",
            "type":"string"
        },
        "udf44":{
            "description":"udf44",
            "type":"string"
        },
        "udf45":{
            "description":"udf45",
            "type":"string"
        },
        "udf46":{
            "description":"udf46",
            "type":"string"
        },
        "udf47":{
            "description":"udf47",
            "type":"string"
        },
        "udf48":{
            "description":"udf48",
            "type":"string"
        },
        "udf49":{
            "description":"udf49",
            "type":"string"
        },
        "udf50":{
            "description":"udf50",
            "type":"string"
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

405 Response

Invalid input.

500 Response

Internal error.

Back to Top