Sign in

v1

latestOpenAPI 3.0.02026-08-04134348905.1 KB
Collateral Management

Update an operation

Permissions required: Manage Collateral Packages and Read vault activity

Update an existing operation in the Collateral Management service. Only the fields provided in the request body will be updated.

patch/collateral_management/operations/{operationId}

Path parameters

operationIdstring required

The unique identifier of the operation 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

action'INITIAL_DEPOSIT' | 'INITIAL_FUNDING' | 'MARGIN_RETURN' | 'PAY_DOWN' | 'PAY_UP' | 'INTEREST_PAYDOWN' | 'INTEREST_ACCRUAL' | 'TOP_UP' | 'CLOSE_RETURN' | 'REHYPE_IN' | 'REHYPE_OUT'

The specific action to be performed in the operation.

Valid actions for exposures are:

  1. INITIAL_FUNDING
  2. PAY_DOWN
  3. PAY_UP
  4. INTEREST_PAYDOWN
  5. INTEREST_ACCRUAL

Valid actions for collateral packages are:

  1. INITIAL_DEPOSIT
  2. MARGIN_RETURN,
  3. TOP_UP
  4. CLOSE_RETURN.
  5. REHYPE_IN
  6. REHYPE_OUT
notesstring

Optional notes or comments related to the operation. Providing a new value will overwrite existing notes.

quantitystring

The quantity of the asset to be used in the operation, expressed as a decimal string.

type'COLLATERAL_PACKAGE' | 'EXPOSURE'

The type of entity the operation is being performed on. This can be either a COLLATERAL_PACKAGE or an EXPOSURE.

typeIdstring

The ID of the collateral package (packageId) or exposure (exposureId) for this operation

Response

The updated operation.

action'INITIAL_DEPOSIT' | 'INITIAL_FUNDING' | 'MARGIN_RETURN' | 'PAY_DOWN' | 'PAY_UP' | 'INTEREST_PAYDOWN' | 'INTEREST_ACCRUAL' | 'TOP_UP' | 'CLOSE_RETURN' | 'FULL_LIQUIDATION' | 'PARTIAL_LIQUIDATION' | 'SWEEP' | 'REHYPE_IN' | 'REHYPE_OUT' | 'GAS_FEE' required

The specific action to be performed in the operation.

Valid actions for exposures are:

  1. INITIAL_FUNDING
  2. PAY_DOWN
  3. PAY_UP
  4. INTEREST_PAYDOWN
  5. INTEREST_ACCRUAL

Valid actions for collateral packages are:

  1. INITIAL_DEPOSIT
  2. MARGIN_RETURN
  3. TOP_UP
  4. CLOSE_RETURN.
  5. REHYPE_IN
  6. REHYPE_OUT
createdAtstring date-time required

The timestamp of when this record was created not necessarily when the operation was executed.

idstring required

Unique identifier for the operation (operationId)

liquidationCollateralPackageIdstring

The unique identifier of the collateral package that is being liquidated

liquidationProceedQuantitystring

The decimal quantity of the proceeds received from the liquidation

notesstring

An optional field for additional comments or contextual information related to the operation.

quantitystring required

The decimal amount of the asset being added, removed, or modified in the operation, expressed as a string

type'COLLATERAL_PACKAGE' | 'EXPOSURE' | 'LIQUIDATION' required

The type of entity the operation is being performed on. This can be either a COLLATERAL_PACKAGE or an EXPOSURE.

typeIdstring required

Contains the unique identifier of either the collateral package (packageId) or exposure (exposureId) that the operation is being performed on, depending on the value in the type field

updatedAtstring date-time required

The timestamp of when this record was last updated

Example response

{
  "createdAt": "2019-01-02T12:34:56.000Z",
  "updatedAt": "2019-01-02T12:34:56.000Z"
}