Skip to main content
POST
Create a new collateral package

Authorizations

Api-Access-Key
string
header
required

An API key associated with a security role

Headers

Api-Signature
string
required

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

Construction example:

Pattern: ^[0-9A-Fa-f]{128,160}$
Api-Timestamp
integer<int64>
required

Current timestamp, represented as unix epoch seconds

Body

application/json

The details for creating a new collateral package

The request payload for creating a new collateral package.

collateralAssetsConfig
object[]
required
pledgorId
string
required

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

securedPartyId
string
required

Unique identifier of the secured party (lender) associated with this collateral package

acceleratedMarginCall
object

Accelerated Margin Call level config

clientReferenceId
string

A reference identifier provided by the client for this collateral package

critical
object

Critical level config

ltvRoundingPrecision
integer

Number of decimal places to round LTV values to

marginCall
object

Margin Call level config

marginReturn
object

Margin Return level config

priceStrategy
enum<string>
deprecated

Deprecated: set priceStrategy on each collateralAssetsConfig entry instead. When sent, every asset takes this value, and no collateralAssetsConfig entry may carry its own priceStrategy.

Available options:
DEFAULT,
BID,
ASK,
MID,
LAST,
CHAINLINK_STRATEGY

Response

Successfully created collateral package

packageId
string
required