Sign in

v1

latestOpenAPI 3.0.02026-08-04134348905.1 KB
Collateral Management

Create a new operation

Permissions required: Manage Collateral Packages and Read vault activity

Create a new operation in the Collateral Management service.

post/collateral_management/operations

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' 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
idempotentIdstring

Idempotency single key

notesstring

Optional notes or comments related to the operation

quantitystring required

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

type'COLLATERAL_PACKAGE' | 'EXPOSURE' required

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

typeIdstring required

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

Response

operationId

operationIdstring required