Utility.Registry.V0.Holding.Transfer

Templates

template AcceptedTransfer

An accepted transfer.

Signatory: (DA.Internal.Record.getField @"sender" transfer), (DA.Internal.Record.getField @"receiver" transfer)

Field	Type	Description
transfer	Transfer	Accepted transfer payload.
senderLabel	Text	Label of the holding to send.
receiverLabel	Text	Label of the holding to receive.
observers	Optional Parties	Parties that can observe the transfer. This field is available starting from version 0.2.0 of this package.

• Choice AcceptedTransfer_Execute

  Execute an accepted transfer.

  Controller: (DA.Internal.Record.getField @"registrar" transfer)

  Returns: AcceptedTransfer_Execute_Result

  Field	Type	Description
  instrumentConfigurationCid	ContractId InstrumentConfiguration	Instrument configuration.
  senderCredentialCids	[ContractId Credential]	Sender credential cids.
  receiverCredentialCids	[ContractId Credential]	Receiver credential cids.
  holdingCid	ContractId Holding	Holding to transfer.

• Choice AcceptedTransfer_Fail

  Fail an accepted transfer.

  Controller: (DA.Internal.Record.getField @"registrar" transfer)

  Returns: AcceptedTransfer_Fail_Result

  Field	Type	Description
  reason	Text	Reason for failure.

• Choice Archive

  Controller: (DA.Internal.Record.getField @"sender" transfer), (DA.Internal.Record.getField @"receiver" transfer)

  Returns: ()

  (no fields)

template ExecutedTransfer

An executed transfer.

Signatory: (DA.Internal.Record.getField @"registrar" transfer)

Field	Type	Description
transfer	Transfer	Transfer payload.
senderLabel	Text	Label of sender holding.
receiverLabel	Text	Label of receiver holding
observers	Optional Parties	Parties that can observe the transfer. This field is available starting from version 0.2.0 of this package.

• Choice Archive

  Controller: (DA.Internal.Record.getField @"registrar" transfer)

  Returns: ()

  (no fields)

• Choice ExecutedTransfer_Delete

  Deletes an executed transfer.

  Controller: (DA.Internal.Record.getField @"registrar" transfer)

  Returns: ExecutedTransfer_Delete_Result

  (no fields)

template FailedTransfer

A failed transfer.

Signatory: (DA.Internal.Record.getField @"registrar" transfer)

Field	Type	Description
transfer	Transfer	Rejected transfer payload.
reason	Text	Reason for failure.
observers	Optional Parties	Parties that can observe the transfer. This field is available starting from version 0.2.0 of this package.

• Choice Archive

  Controller: (DA.Internal.Record.getField @"registrar" transfer)

  Returns: ()

  (no fields)

• Choice FailedTransfer_Delete

  Deletes a rejected transfer.

  Controller: (DA.Internal.Record.getField @"registrar" transfer)

  Returns: FailedTransfer_Delete_Result

  (no fields)

template RejectedTransfer

A rejected transfer.

Signatory: (DA.Internal.Record.getField @"sender" transfer), (DA.Internal.Record.getField @"receiver" transfer)

Field	Type	Description
transfer	Transfer	Rejected transfer payload.
reason	Text	Reason for rejection.
observers	Optional Parties	Parties that can observe the transfer. This field is available starting from version 0.2.0 of this package.

• Choice Archive

  Controller: (DA.Internal.Record.getField @"sender" transfer), (DA.Internal.Record.getField @"receiver" transfer)

  Returns: ()

  (no fields)

• Choice RejectedTransfer_Delete

  Deletes a rejected transfer.

  Controller: (DA.Internal.Record.getField @"registrar" transfer)

  Returns: RejectedTransfer_Delete_Result

  (no fields)

template TransferOffer

An offer to transfer a holding

Signatory: (DA.Internal.Record.getField @"provider" transfer), (DA.Internal.Record.getField @"sender" transfer)

Field	Type	Description
transfer	Transfer	Transfer offer payload.
senderLabel	Text	Label of the holding to transfer.

• Choice Archive

  Controller: (DA.Internal.Record.getField @"provider" transfer), (DA.Internal.Record.getField @"sender" transfer)

  Returns: ()

  (no fields)

• Choice TransferOffer_Accept

  Accepts a transfer offer.

  Controller: (DA.Internal.Record.getField @"receiver" transfer)

  Returns: TransferOffer_Accept_Result

  Field	Type	Description
  receiverLabel	Text	Label of the holding to receive.

• Choice TransferOffer_Cancel

  Cancels a transfer request.

  Controller: (DA.Internal.Record.getField @"sender" transfer)

  Returns: TransferOffer_Cancel_Result

  (no fields)

• Choice TransferOffer_Reject

  Rejects a transfer offer.

  Controller: (DA.Internal.Record.getField @"receiver" transfer)

  Returns: TransferOffer_Reject_Result

  Field	Type	Description
  reason	Text	Reason for rejection.

template TransferRequest

A request to transfer a holding

Signatory: (DA.Internal.Record.getField @"provider" transfer), (DA.Internal.Record.getField @"receiver" transfer)

Field	Type	Description
transfer	Transfer	Transfer offer payload.
receiverLabel	Text	Label of the holding to receive.

• Choice Archive

  Controller: (DA.Internal.Record.getField @"provider" transfer), (DA.Internal.Record.getField @"receiver" transfer)

  Returns: ()

  (no fields)

• Choice TransferRequest_Accept

  Accepts a transfer request.

  Controller: (DA.Internal.Record.getField @"sender" transfer)

  Returns: TransferRequest_Accept_Result

  Field	Type	Description
  senderLabel	Text	Label of the holding to send.

• Choice TransferRequest_Cancel

  Cancels a transfer request.

  Controller: (DA.Internal.Record.getField @"receiver" transfer)

  Returns: TransferRequest_Cancel_Result

  (no fields)

• Choice TransferRequest_Reject

  Rejects a transfer request.

  Controller: (DA.Internal.Record.getField @"sender" transfer)

  Returns: TransferRequest_Reject_Result

  Field	Type	Description
  reason	Text	Reason for rejection.

Data Types

data AcceptedTransfer_Execute_Result

Result of AcceptedTransfer_Execute.

AcceptedTransfer_Execute_Result

Field	Type	Description
holdingTransferResult	Holding_Transfer_Result	Holding transfer result.
executedTransferCid	ContractId ExecutedTransfer	Executed transfer.

data AcceptedTransfer_Fail_Result

Result of AcceptedTransfer_Fail.

AcceptedTransfer_Fail_Result

Field	Type	Description
failedTransferCid	ContractId FailedTransfer	Failed transfer.

data ExecutedTransfer_Delete_Result

Result of ExecutedTransfer_Delete.

ExecutedTransfer_Delete_Result

(no fields)

data FailedTransfer_Delete_Result

Result of FailedTransfer_Delete.

FailedTransfer_Delete_Result

(no fields)

data RejectedTransfer_Delete_Result

Result of RejectedTransfer_Delete.

RejectedTransfer_Delete_Result

(no fields)

data Transfer

Transfer payload.

Transfer

Field	Type	Description
operator	Party	Utility operator.
provider	Party	Provider of the initiator of the transfer.
registrar	Party	Registrar of the holding.
sender	Party	Holding sender.
receiver	Party	Holding receiver.
instrumentIdentifier	InstrumentIdentifier	Instrument id to transfer.
amount	Decimal	Amount to transfer.
reference	Text	Reference for the transfer.
batch	Batch	Batch the transfer belongs to.

data TransferOffer_Accept_Result

Result of TransferOffer_Accept.

TransferOffer_Accept_Result

Field	Type	Description
acceptedTransferCid	ContractId AcceptedTransfer	Accepted transfer.

data TransferOffer_Cancel_Result

TransferOffer_Cancel_Result

(no fields)

data TransferOffer_Reject_Result

Result of TransferOffer_Reject.

TransferOffer_Reject_Result

Field	Type	Description
rejectedTransferCid	ContractId RejectedTransfer	Rejected transfer.

data TransferRequest_Accept_Result

Result of TransferRequest_Accept.

TransferRequest_Accept_Result

Field	Type	Description
acceptedTransferCid	ContractId AcceptedTransfer	Accepted transfer.

data TransferRequest_Cancel_Result

Result of TransferRequest_Cancel.

TransferRequest_Cancel_Result

(no fields)

data TransferRequest_Reject_Result

Result of TransferRequest_Reject.

TransferRequest_Reject_Result

Field	Type	Description
rejectedTransferCid	ContractId RejectedTransfer	Rejected transfer.