Utility.Collateral.App.Model.Collateral

A collateral agreement between two counterparties and corresponding workflows.

Templates

template CollateralAgreement

Collateral agreement on-ledger which reflects an existing CSA.

Signatory: partyA, partyB, operator

Field	Type	Description
partyA	Party	The party for Party A in the CSA.
partyB	Party	The party for Party B in the CSA.
operator	Party	The Collateral App operator party.
id	Text	Agreement id.
terms	Terms	Collateral agreement terms.

• Choice Archive

  Controller: partyA, partyB, operator

  Returns: ()

  (no fields)

• Choice CollateralAgreement_ProposeChange

  Request a modification to the collateral agreement.

  Controller: actor, operator

  Returns: CollateralAgreement_ProposeChange_Result

  Field	Type	Description
  actor	Party	The party exercising the choice.
  updatedTerms	Terms	Updated collateral agreement terms.

• Choice CollateralAgreement_Terminate

  Terminate the collateral agreement.

  Controller: actor, operator

  Returns: CollateralAgreement_Terminate_Result

  Field	Type	Description
  actor	Party	The actor to terminate the contract.
  collateralStateCid	ContractId CollateralState	Collateral State.

• Choice CollateralAgreement_TransferCollateral

  Initiate process to transfer collateral to the counterparty.

  Controller: actor, operator

  Returns: CollateralAgreement_TransferCollateral_Result

  Field	Type	Description
  actor	Party	The party calling the choice. Will be the pledgor to the positions being transferred.
  positions	[InstrumentQuantity]	The positions that will be transferred.
  reference	Text	Textual reference, used for deduplication. Please, ensure this is unique.
  createdAt	Time	Time at which the request to Transfer Collateral is created.
  allocateBefore	Time	Until when (exclusive) the senders are given time to allocate their assets.
  settleBefore	Time	Until when (exclusive) the executor is given time to execute the settlement.

template CollateralAgreementChangeRequest

A request to change the terms of an existing collateral agreement.

Signatory: requestor, operator

Field	Type	Description
operator	Party	The Collateral App operator party.
requestor	Party	The requesting party.
counterparty	Party	The counterparty to the request.
id	Text	Id of the collateral agreement.
terms	Terms	Updated collateral agreement terms.
collateralAgreementCid	ContractId CollateralAgreement	The collateral agreement to modify.

• Choice Archive

  Controller: requestor, operator

  Returns: ()

  (no fields)

• Choice CollateralAgreementChangeRequest_Accept

  Counterparty accepts the request.

  Controller: counterparty, operator

  Returns: CollateralAgreementChangeRequest_Accept_Result

  (no fields)

• Choice CollateralAgreementChangeRequest_Cancel

  Requestor cancels the request.

  Controller: requestor

  Returns: CollateralAgreementChangeRequest_Cancel_Result

  (no fields)

• Choice CollateralAgreementChangeRequest_Reject

  Receiver rejects the request.

  Controller: counterparty

  Returns: CollateralAgreementChangeRequest_Reject_Result

  Field	Type	Description
  reason	Text	Rejection reason. The rejection reason is not recorded on-ledger but should be available in the requestor’s and the operator’s transaction tree stream.

template CollateralAgreementRequest

A request to enter into a collateral agreement with a counterparty.

Signatory: requestor, operator

Field	Type	Description
operator	Party	The Collateral App operator party..
requestor	Party	The requesting party.
counterparty	Party	The counterparty to the request.
id	Text	Agreement id.
requestorIsPartyA	Bool	Whether the requestor is PartyA in the CSA.
terms	Terms	Terms of the collateral agreement.

• Choice Archive

  Controller: requestor, operator

  Returns: ()

  (no fields)

• Choice CollateralAgreementRequest_Accept

  Receiver accepts the request.

  Controller: counterparty, operator

  Returns: CollateralAgreementRequest_Accept_Result

  (no fields)

• Choice CollateralAgreementRequest_Cancel

  Requestor cancels the request.

  Controller: requestor

  Returns: CollateralAgreementRequest_Cancel_Result

  (no fields)

• Choice CollateralAgreementRequest_Reject

  Receiver rejects the request.

  Controller: counterparty

  Returns: CollateralAgreementRequest_Reject_Result

  Field	Type	Description
  reason	Text	Rejection reason. The rejection reason is not recorded on-ledger but should be available in the requestor’s and the operator’s transaction tree stream.

template ExecutedCollateralTransfer

Settled collateral transfer.

Signatory: operator

Field	Type	Description
partyA	Party	The party for Party A in the CSA.
partyB	Party	The party for Party B in the CSA.
operator	Party	The Collateral App operator party.
agreementId	Text	Agreement id.
id	Text	Identifier of the collateral movement.
settledPositions	[CollateralPosition]	Executed collateral movements.

• Choice Archive

  Controller: operator

  Returns: ()

  (no fields)

template FailedCollateralTransfer

Failed collateral transfer.

Signatory: operator

Field	Type	Description
partyA	Party	The party for Party A in the CSA.
partyB	Party	The party for Party B in the CSA.
operator	Party	The Collateral App operator party.
agreementId	Text	Agreement id.
id	Text	Proposal id.
failedPledges	[InstrumentQuantity]	Proposed collateral pledges. A positive amount is used to post collateral from PartyA to PartyB. A negative amount is used to reduce posted collateral from PartyA to PartyB.

• Choice Archive

  Controller: operator

  Returns: ()

  (no fields)

template InstructedCollateral

Instructed collateral transfer.

Signatory: partyA, partyB, operator

Field	Type	Description
partyA	Party	The party for Party A in the CSA.
partyB	Party	The party for Party B in the CSA.
operator	Party	The Collateral App operator party.
agreementId	Text	Collateral Agreement id.
id	Text	Identifier of the collateral movement.
instructedPositions	[CollateralPosition]	Proposed collateral movements.
createdAt	Time	The creation time.
allocateBefore	Time	The time until which all allocations should be created.
settleBefore	Time	The time before which the trade should be settled.

• Choice Archive

  Controller: partyA, partyB, operator

  Returns: ()

  (no fields)

• Choice InstructedCollateral_Cancel

  Cancel the instructed collateral. This does not unlock allocated instruments yet.

  Controller: actor

  Returns: InstructedCollateral_Cancel_Result

  Field	Type	Description
  actor	Party	The party invoking this choice.
  allocations	[ContractId Allocation]	The allocations to settle.
  extraArgs	[ExtraArgs]	For each allocation, the arguments to the Allocation_Cancel choice.

• Choice InstructedCollateral_ExecuteTransfer

  Execute the collateral transfer. This choice is compatible with external signing as long as collateralStateCid is stable (i.e. no other transfer for the same collateral agreement gets settled during the signing window for this choice).

  Controller: actor

  Returns: InstructedCollateral_ExecuteTransfer_Result

  Field	Type	Description
  actor	Party	The party invoking this choice.
  allocations	[ContractId Allocation]	The allocations to settle.
  executeTransferArgs	[ExtraArgs]	For each allocation, the arguments to the Allocation_ExecuteTransfer choice.
  collateralStateCid	ContractId CollateralState	Collateral State contract to update.

• interface instance AllocationRequest for InstructedCollateral

Data Types

data CollateralAgreementChangeRequest_Accept_Result

Return record type for CollateralAgreementChangeRequest_Accept.

CollateralAgreementChangeRequest_Accept_Result

Field	Type	Description
collateralAgreementCid	ContractId CollateralAgreement	The modified collateral agreement.

data CollateralAgreementChangeRequest_Cancel_Result

Return record type for CollateralAgreementChangeRequest_Cancel.

CollateralAgreementChangeRequest_Cancel_Result

(no fields)

data CollateralAgreementChangeRequest_Reject_Result

Return record type for CollateralAgreementChangeRequest_Reject.

CollateralAgreementChangeRequest_Reject_Result

Field	Type	Description
reason	Text	Rejection reason.

data CollateralAgreementRequest_Accept_Result

Return record type for CollateralAgreementRequest_Accept.

CollateralAgreementRequest_Accept_Result

Field	Type	Description
collateralAgreementCid	ContractId CollateralAgreement	The created collateral agreement.
collateralStateCid	ContractId CollateralState	The companion contract tracking collateral state.

data CollateralAgreementRequest_Cancel_Result

Return record type for CollateralAgreementRequest_Cancel.

CollateralAgreementRequest_Cancel_Result

(no fields)

data CollateralAgreementRequest_Reject_Result

Return record type for CollateralAgreementRequest_Reject.

CollateralAgreementRequest_Reject_Result

Field	Type	Description
reason	Text	Rejection reason.

data CollateralAgreement_ProposeChange_Result

Return record type for CollateralAgreement_ProposeChange.

CollateralAgreement_ProposeChange_Result

Field	Type	Description
collateralAgreementChangeRequestCid	ContractId CollateralAgreementChangeRequest	The requested change to the collateral agreement.

data CollateralAgreement_Terminate_Result

Return record type for CollateralAgreement_Terminate.

CollateralAgreement_Terminate_Result

(no fields)

data CollateralAgreement_TransferCollateral_Result

Return record type for CollateralAgreement_TransferCollateral.

CollateralAgreement_TransferCollateral_Result

Field	Type	Description
instructedCollateralCid	ContractId InstructedCollateral	The instructed collateral movement.

data InstructedCollateral_Cancel_Result

InstructedCollateral_Cancel_Result

(no fields)

data InstructedCollateral_ExecuteTransfer_Result

Result of InstructedCollateral_ExecuteTransfer.

InstructedCollateral_ExecuteTransfer_Result

Field	Type	Description
collateralStateCid	ContractId CollateralState	The updated collateral state contract.