Skip to main content

Retrieves the collateral by collateral code.

HEAD 
/Collaterals/:code

Retrieves the collateral by collateral code.

Request​

Path Parameters

    code stringrequired

    Collateral code

Query Parameters

    api-version string

Header Parameters

    X-Request-ID stringrequired

Responses​

Collateral details if found, otherwise an error response

Schema
    id int32required

    Collateral id.

    code stringnullablerequired

    Collateral code.

    collateralTypeCode stringnullablerequired

    Collateral type code.

    collateralTypeTitle stringnullablerequired

    Collateral type title.

    collateralStatusCode stringnullablerequired

    Collateral status code.

    collateralStatusTitle stringnullablerequired

    Collateral status title.

    collateralStatus object nullable

    Collateral status.

    oneOf

    string

    Possible values: [NonPerforming, Performing, InActive]

    ownersCode stringnullablerequired

    Collateral owner or cheque issuer code. The owner can be customer or transactor.

    ownersName stringnullablerequired

    Collateral owner or cheque issuer name.

    customerCode stringnullablerequired

    Collateral Customer's code.

    customerName stringnullablerequired

    Collateral Customer's name.

    branchCode stringnullablerequired

    Issuing branch code.

    branchTitle stringnullablerequired

    Issuing branch title.

    category object nullable

    Collateral category. It derives from the collateral type.

    oneOf

    string

    Possible values: [Other, Cheques, Cash, ResidentialEstate, OtherGuarantees, LetterOfGuarantee, CommercialEstate, OtherEstate, GovernmentGuarantee, Vessels, IndustrialEquipment, InventoriesCommodities, AssignedReceivables, AssignedReceivablesState, Bonds]

    expiryDate date-timenullablerequired

    Expiry Date.

    estateProperties object[]nullable

    For real estate, these are the properties from the property registry connected to the collateral.

  • Array [
    • propertyCode stringrequired

    Property code.

    propertyTitle stringnullablerequired

    Property title

    streetAddress stringnullablerequired

    Street address.

    postalCode stringnullablerequired

    Postal code.

    municipalityCode stringnullablerequired

    Municipality code.

    municipalityTitle stringnullablerequired

    Municipality title.

    isLiquidated booleannullablerequired

    If the collateral is liquidated.

    notes stringnullablerequired

    Collateral property notes.

    isActive booleannullablerequired

    If the connection of the property to the collateral is active.

    insuranceValue decimalnullablerequired

    Insurance value.

    objectiveValue decimalnullablerequired

    Objective value.

    commercialValue decimalnullablerequired

    Commercial value.

  • ]
Loading...