Utility.Settlement.App.V1.Model.Dvp

A delivery versus payment (Dvp) agreement between two counterparties.

Templates

template Dvp

A delivery versus payment (Dvp) agreement between two counterparties.

Signatory: operator, buyer, seller

Field	Type	Description
operator	Party	The operator party of the settlement App.
buyer	Party	The buyer party.
seller	Party	The seller party.
terms	Terms	Terms for the Dvp.

• Choice Archive

  Controller: operator, buyer, seller

  Returns: ()

  (no fields)

• Choice Dvp_Cancel

  Cancel the Dvp and withdraw its associated allocations. This choice withdraws the allocation request (i.e., this contract), consuming it. The provided allocations are also withdrawn as part of the cancellation process.

  Controller: operator

  Returns: Dvp_Cancel_Result

  Field	Type	Description
  allocationCids	[ContractId Allocation]	The allocations to withdraw.
  extraArgss	[ExtraArgs]	The extra arguments needed to withdraw each allocation.
  payload	AllocationRequest_Withdraw	The payload for withdrawing the Allocation Request (i.e., this contract).

• Choice Dvp_Settle

  Settle the Dvp.

  Controller: operator

  Returns: Dvp_Settle_Result

  Field	Type	Description
  allocationCids	[ContractId Allocation]	The allocations.
  extraArgss	[ExtraArgs]	The extra arguments needed to execute the transfer for each allocation.

• interface instance AllocationRequest for Dvp

template DvpProposal

Proposal to enter into a Dvp.

Signatory: operator, proposer

Field	Type	Description
operator	Party	The operator party of the settlement App.
proposer	Party	The proposing party.
proposerIsBuyer	Bool	Whether the proposer is the buyer.
counterparty	Party	The counterparty to the Dvp.
terms	Terms	Settlement terms.

• Choice Archive

  Controller: operator, proposer

  Returns: ()

  (no fields)

• Choice DvpProposal_Accept

  Accept the Dvp proposal.

  Controller: counterparty

  Returns: DvpProposal_Accept_Result

  (no fields)

• Choice DvpProposal_Cancel

  Cancel the Dvp proposal.

  Controller: proposer

  Returns: DvpProposal_Cancel_Result

  (no fields)

• Choice DvpProposal_Reject

  Reject the Dvp proposal.

  Controller: counterparty

  Returns: DvpProposal_Reject_Result

  Field	Type	Description
  reason	Text	Rejection reason.

template RejectedDvp

Rejected Dvp.

Signatory: (DA.Internal.Record.getField @"operator" dvp)

Field	Type	Description
dvp	Dvp	The rejected Dvp.
reason	Text	The reason for the rejection.
actor	Party	The party that rejected.

• Choice Archive

  Controller: (DA.Internal.Record.getField @"operator" dvp)

  Returns: ()

  (no fields)

template RejectedDvpProposal

Rejected Dvp proposal.

Signatory: (DA.Internal.Record.getField @"operator" dvpProposal)

Field	Type	Description
dvpProposal	DvpProposal	The rejected Dvp proposal.
reason	Text	The reason for the rejection.

• Choice Archive

  Controller: (DA.Internal.Record.getField @"operator" dvpProposal)

  Returns: ()

  (no fields)

template SettledDvp

Settled Dvp.

Signatory: (DA.Internal.Record.getField @"operator" dvp)

Field	Type	Description
dvp	Dvp	The settled Dvp.

• Choice Archive

  Controller: (DA.Internal.Record.getField @"operator" dvp)

  Returns: ()

  (no fields)

template WithdrawnDvp

Withdrawn Dvp.

Signatory: (DA.Internal.Record.getField @"operator" dvp)

Field	Type	Description
dvp	Dvp	The withdrawn Dvp.
reason	Text	The reason for the withdrawal.

• Choice Archive

  Controller: (DA.Internal.Record.getField @"operator" dvp)

  Returns: ()

  (no fields)

Data Types

data DvpProposal_Accept_Result

Result of DvpProposal_Accept.

DvpProposal_Accept_Result

Field	Type	Description
dvpCid	ContractId Dvp	The created Dvp contract.

data DvpProposal_Cancel_Result

Result of DvpProposal_Cancel.

DvpProposal_Cancel_Result

(no fields)

data DvpProposal_Reject_Result

Result of DvpProposal_Reject.

DvpProposal_Reject_Result

Field	Type	Description
rejectedDvpProposalCid	Optional (ContractId RejectedDvpProposal)	The rejected Dvp proposal. NOTE: This is an optional field to anticipate future changes where the rejection might not create a contract. This allows for backward compatibility.

data Dvp_Cancel_Result

Result of Dvp_Cancel.

Dvp_Cancel_Result

(no fields)

data Dvp_Settle_Result

Result of Dvp_Settle_Result.

Dvp_Settle_Result

Field	Type	Description
settledDvpCid	Optional (ContractId SettledDvp)	The contract id of the settled Dvp. NOTE: This is an optional field to anticipate future changes where the settlement might not create a contract. This allows for backward compatibility.

data Terms

Terms for a delivery versus payment (Dvp).

Terms

Field	Type	Description
id	Text	Identifier of the Dvp.
deliveries	[InstrumentQuantity]	Quantities to deliver.
payments	[InstrumentQuantity]	Quantities to pay.
createdAt	Time	The creation time of the Dvp (proposal).
allocateBefore	Time	The time until which all allocations should be created.
settleBefore	Time	The time before which the trade should be settled.