Module Daml.Finance.Interface.Settlement.Types

Data Types

data Allocation

Describes an allocation of an Instruction.

Unallocated

An unallocated instruction.

Pledge (ContractId I)

Settle the instruction with the pledged asset.

CreditReceiver

Settle the instruction by crediting the receiver account (where the sender is custodian).

SettleOffledger

Settle the instruction off-ledger.

PassThroughFrom (AccountKey, InstructionKey)

Settle the instruction with the holding coming from the specified instruction and account.

instance Eq Allocation

instance Show Allocation

data Approval

Describes an approval of an Instruction.

Unapproved

An unapproved instruction.

TakeDelivery AccountKey

Take delivery to the specified account.

DebitSender

Debit the sender account with the provided asset (where the receiver is custodian).

SettleOffledgerAcknowledge

Acknowledge settlement of the instruction off-ledger.

PassThroughTo (AccountKey, InstructionKey)

Take delivery to the specified account. The holding is then immediately allocated to the specified instruction.

instance Eq Approval

instance Show Approval

data InstructionKey

A unique key for Instructions.

InstructionKey

Field	Type	Description
requestors	Parties	Parties requesting settlement of the instruction.
batchId	Id	Id of the batch the instruction belongs to.
id	Id	A unique identifier for an instruction.

instance Eq InstructionKey

instance Ord InstructionKey

instance Show InstructionKey

instance HasExerciseByKey Instruction InstructionKey Archive ()

instance HasFetchByKey Instruction InstructionKey

instance HasFromAnyContractKey Instruction InstructionKey

instance HasKey Instruction InstructionKey

instance HasLookupByKey Instruction InstructionKey

instance HasMaintainer Instruction InstructionKey

instance HasToAnyContractKey Instruction InstructionKey

data RoutedStep

Describes a transfer of a position between two parties. The custodian at which the position is held is also specified.

RoutedStep

Field	Type	Description
sender	Party	Party transferring the asset.
receiver	Party	Party receiving the asset.
custodian	Party	The custodian at which the asset is held.
quantity	InstrumentQuantity	The instrument and amount to be transferred.

instance Eq RoutedStep

instance Ord RoutedStep

instance Show RoutedStep

instance HasMethod RouteProvider "discover" (Discover -> Update [RoutedStep])

data Step

Describes a transfer of a position between two parties.

Step

Field	Type	Description
sender	Party	Party transferring the asset.
receiver	Party	Party receiving the asset.
quantity	InstrumentQuantity	The instrument and amount to be transferred.

instance Eq Step

instance Ord Step

instance Show Step