Utility.Registry.App.V0.Model.TransferPreapproval

Templates

template TransferPreapproval

Transfer preapproval for specific utility instruments.

Signatory: receiver

Field	Type	Description
operator	Party	The party disclosing the contract.
receiver	Party	Party which preapproves.
instrumentAdmin	Party	The admin of the instruments being preapproved.
instrumentAllowances	[InstrumentAllowance]	The set of instrument-specific allowances granted under this preapproval. If the list is empty, all instruments of the admin are considered preapproved. For performance reasons, this list may contain at most 10 instrument identifiers. If more than 10 instruments need to be preapproved for the same admin, create additional TransferPreapproval instances for that admin.

• Choice Archive

  Controller: receiver

  Returns: ()

  (no fields)

• Choice TransferPreapproval_Modify

  Modifies a preapproval.

  Controller: receiver

  Returns: TransferPreapproval_Modify_Result

  Field	Type	Description
  newInstrumentAllowances	[InstrumentAllowance]	The new instrument allowances.

• Choice TransferPreapproval_Withdraw

  Withdraws a preapproval.

  Controller: actor

  Returns: TransferPreapproval_Withdraw_Result

  Field	Type	Description
  actor	Party	The party executing the withdrawal.

• interface instance TransferFactory for TransferPreapproval

Data Types

data InstrumentAllowance

An allowance for a specific instrument. A separate data type is used to facilitate future extensions.

InstrumentAllowance

Field	Type	Description
id	Text	The identifier of the instrument.

data TransferPreapproval_Modify_Result

The result type of the ‘TransferPreapproval_Modify’ choice.

TransferPreapproval_Modify_Result

Field	Type	Description
transferPreapprovalCid	ContractId TransferPreapproval	The contract ID of the modified transfer preapproval.

data TransferPreapproval_Withdraw_Result

The result type of the ‘TransferPreapproval_Withdraw’ choice.

TransferPreapproval_Withdraw_Result

(no fields)