Sign in
Collateral Management

Update a collateral package

Permissions required: Manage Collateral Packages and Read vault activity

Updates an existing collateral package in the Collateral Management service.

patch/collateral_management/packages/{packageId}

Path parameters

packageIdstring required

The unique identifier of the package to update.

Headers

Api-Signaturestring required

A hex-encoded Ed25519 signature of timestamp_epoch_seconds + uppercase(http_method) + request_path + request_body.

Construction example:

toHex(
  ed25519Sign(
    signing_key,
    '{}{}{}{}'.format(timestamp_epoch_seconds, toUpper(httpMethod), httpRequestPath, httpBody)
  )
)
Api-Timestampinteger required

Current timestamp, represented as unix epoch seconds

Request body

clientReferenceIdstring

A reference identifier provided by the client for this collateral package

isActiveboolean

Indicates whether the package should be activated for monitoring or not

ltvRoundingPrecisioninteger

Number of decimal places to round LTV values to

priceStrategy'DEFAULT' | 'BID' | 'ASK' | 'MID' | 'LAST'

This field specifies the pricing strategy to be used for the collateral package. To be implemented in the future

Response

Successfully updated collateral package

activeboolean required

Indicates whether the package has been activated for monitoring or not

clientReferenceIdstring required

Client-provided reference ID for this Collateral Package

currentLtvstring

The current Loan-to-Value (LTV) ratio for the Collateral Package, expressed as a decimal string

exposureValuestring required

The current total value of the Exposure(s) associated with this Collateral Package, expressed in USD

ltvTimestampstring

Timestamp indicating the last time the currentLtv was calculated and updated. This timestamp provides context for the recency of the LTV value

packageIdstring required

Unique identifier for the Collateral Package

packageValuestring required

The current total value of the Collateral Package, calculated using the configured pricing methodology and real-time price data, expressed in USD

pledgorIdstring required

Collateral management participant ID of the Pledgor (borrower) associated with this collateral package

securedPartyIdstring required

Collateral management participant ID of the Secure Party (lender) associated with this collateral package

state'MARGIN_RETURN' | 'HEALTHY' | 'MARGIN_CALL' | 'CRITICAL' | 'CLOSED' | 'CURE_PERIOD_EXPIRED' | 'DEFAULTED'

Current state of the Collateral Package

Changes

No recorded changes to this endpoint across all 1 revision of this API.