.. _module-utility-registry-v0-holding-transfer-86156: Utility.Registry.V0.Holding.Transfer ==================================== Templates --------- .. _type-utility-registry-v0-holding-transfer-acceptedtransfer-97492: **template** `AcceptedTransfer `_ An accepted transfer\. Signatory\: (DA\.Internal\.Record\.getField @\"sender\" transfer), (DA\.Internal\.Record\.getField @\"receiver\" transfer) .. list-table:: :widths: 15 10 30 :header-rows: 1 * - 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\. + .. _type-utility-registry-v0-holding-transfer-acceptedtransferexecute-8956: **Choice** `AcceptedTransfer_Execute `_ Execute an accepted transfer\. Controller\: (DA\.Internal\.Record\.getField @\"registrar\" transfer) Returns\: `AcceptedTransfer_Execute_Result `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - instrumentConfigurationCid - `ContractId `_ :ref:`InstrumentConfiguration ` - Instrument configuration\. * - senderCredentialCids - \[`ContractId `_ `Credential `_\] - Sender credential cids\. * - receiverCredentialCids - \[`ContractId `_ `Credential `_\] - Receiver credential cids\. * - holdingCid - `ContractId `_ `Holding `_ - Holding to transfer\. + .. _type-utility-registry-v0-holding-transfer-acceptedtransferfail-11628: **Choice** `AcceptedTransfer_Fail `_ Fail an accepted transfer\. Controller\: (DA\.Internal\.Record\.getField @\"registrar\" transfer) Returns\: `AcceptedTransfer_Fail_Result `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - 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) .. _type-utility-registry-v0-holding-transfer-executedtransfer-89640: **template** `ExecutedTransfer `_ An executed transfer\. Signatory\: (DA\.Internal\.Record\.getField @\"registrar\" transfer) .. list-table:: :widths: 15 10 30 :header-rows: 1 * - 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) + .. _type-utility-registry-v0-holding-transfer-executedtransferdelete-51991: **Choice** `ExecutedTransfer_Delete `_ Deletes an executed transfer\. Controller\: (DA\.Internal\.Record\.getField @\"registrar\" transfer) Returns\: `ExecutedTransfer_Delete_Result `_ (no fields) .. _type-utility-registry-v0-holding-transfer-failedtransfer-5622: **template** `FailedTransfer `_ A failed transfer\. Signatory\: (DA\.Internal\.Record\.getField @\"registrar\" transfer) .. list-table:: :widths: 15 10 30 :header-rows: 1 * - 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) + .. _type-utility-registry-v0-holding-transfer-failedtransferdelete-28465: **Choice** `FailedTransfer_Delete `_ Deletes a rejected transfer\. Controller\: (DA\.Internal\.Record\.getField @\"registrar\" transfer) Returns\: `FailedTransfer_Delete_Result `_ (no fields) .. _type-utility-registry-v0-holding-transfer-rejectedtransfer-49437: **template** `RejectedTransfer `_ A rejected transfer\. Signatory\: (DA\.Internal\.Record\.getField @\"sender\" transfer), (DA\.Internal\.Record\.getField @\"receiver\" transfer) .. list-table:: :widths: 15 10 30 :header-rows: 1 * - 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) + .. _type-utility-registry-v0-holding-transfer-rejectedtransferdelete-27620: **Choice** `RejectedTransfer_Delete `_ Deletes a rejected transfer\. Controller\: (DA\.Internal\.Record\.getField @\"registrar\" transfer) Returns\: `RejectedTransfer_Delete_Result `_ (no fields) .. _type-utility-registry-v0-holding-transfer-transferoffer-5624: **template** `TransferOffer `_ An offer to transfer a holding Signatory\: (DA\.Internal\.Record\.getField @\"provider\" transfer), (DA\.Internal\.Record\.getField @\"sender\" transfer) .. list-table:: :widths: 15 10 30 :header-rows: 1 * - 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) + .. _type-utility-registry-v0-holding-transfer-transferofferaccept-70270: **Choice** `TransferOffer_Accept `_ Accepts a transfer offer\. Controller\: (DA\.Internal\.Record\.getField @\"receiver\" transfer) Returns\: `TransferOffer_Accept_Result `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - receiverLabel - `Text `_ - Label of the holding to receive\. + .. _type-utility-registry-v0-holding-transfer-transferoffercancel-11984: **Choice** `TransferOffer_Cancel `_ Cancels a transfer request\. Controller\: (DA\.Internal\.Record\.getField @\"sender\" transfer) Returns\: `TransferOffer_Cancel_Result `_ (no fields) + .. _type-utility-registry-v0-holding-transfer-transferofferreject-69595: **Choice** `TransferOffer_Reject `_ Rejects a transfer offer\. Controller\: (DA\.Internal\.Record\.getField @\"receiver\" transfer) Returns\: `TransferOffer_Reject_Result `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - reason - `Text `_ - Reason for rejection\. .. _type-utility-registry-v0-holding-transfer-transferrequest-51487: **template** `TransferRequest `_ A request to transfer a holding Signatory\: (DA\.Internal\.Record\.getField @\"provider\" transfer), (DA\.Internal\.Record\.getField @\"receiver\" transfer) .. list-table:: :widths: 15 10 30 :header-rows: 1 * - 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) + .. _type-utility-registry-v0-holding-transfer-transferrequestaccept-29759: **Choice** `TransferRequest_Accept `_ Accepts a transfer request\. Controller\: (DA\.Internal\.Record\.getField @\"sender\" transfer) Returns\: `TransferRequest_Accept_Result `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - senderLabel - `Text `_ - Label of the holding to send\. + .. _type-utility-registry-v0-holding-transfer-transferrequestcancel-72749: **Choice** `TransferRequest_Cancel `_ Cancels a transfer request\. Controller\: (DA\.Internal\.Record\.getField @\"receiver\" transfer) Returns\: `TransferRequest_Cancel_Result `_ (no fields) + .. _type-utility-registry-v0-holding-transfer-transferrequestreject-58990: **Choice** `TransferRequest_Reject `_ Rejects a transfer request\. Controller\: (DA\.Internal\.Record\.getField @\"sender\" transfer) Returns\: `TransferRequest_Reject_Result `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - reason - `Text `_ - Reason for rejection\. Data Types ---------- .. _type-utility-registry-v0-holding-transfer-acceptedtransferexecuteresult-66997: **data** `AcceptedTransfer_Execute_Result `_ Result of ``AcceptedTransfer_Execute``\. .. _constr-utility-registry-v0-holding-transfer-acceptedtransferexecuteresult-46592: `AcceptedTransfer_Execute_Result `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - holdingTransferResult - `Holding_Transfer_Result `_ - Holding transfer result\. * - executedTransferCid - `ContractId `_ `ExecutedTransfer `_ - Executed transfer\. .. _type-utility-registry-v0-holding-transfer-acceptedtransferfailresult-10845: **data** `AcceptedTransfer_Fail_Result `_ Result of ``AcceptedTransfer_Fail``\. .. _constr-utility-registry-v0-holding-transfer-acceptedtransferfailresult-17362: `AcceptedTransfer_Fail_Result `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - failedTransferCid - `ContractId `_ `FailedTransfer `_ - Failed transfer\. .. _type-utility-registry-v0-holding-transfer-executedtransferdeleteresult-15560: **data** `ExecutedTransfer_Delete_Result `_ Result of ``ExecutedTransfer_Delete``\. .. _constr-utility-registry-v0-holding-transfer-executedtransferdeleteresult-19535: `ExecutedTransfer_Delete_Result `_ (no fields) .. _type-utility-registry-v0-holding-transfer-failedtransferdeleteresult-5778: **data** `FailedTransfer_Delete_Result `_ Result of ``FailedTransfer_Delete``\. .. _constr-utility-registry-v0-holding-transfer-failedtransferdeleteresult-13709: `FailedTransfer_Delete_Result `_ (no fields) .. _type-utility-registry-v0-holding-transfer-rejectedtransferdeleteresult-74833: **data** `RejectedTransfer_Delete_Result `_ Result of ``RejectedTransfer_Delete``\. .. _constr-utility-registry-v0-holding-transfer-rejectedtransferdeleteresult-21706: `RejectedTransfer_Delete_Result `_ (no fields) .. _type-utility-registry-v0-holding-transfer-transfer-5535: **data** `Transfer `_ Transfer payload\. .. _constr-utility-registry-v0-holding-transfer-transfer-72776: `Transfer `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - 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 - :ref:`Batch ` - Batch the transfer belongs to\. .. _type-utility-registry-v0-holding-transfer-transferofferacceptresult-6675: **data** `TransferOffer_Accept_Result `_ Result of ``TransferOffer_Accept``\. .. _constr-utility-registry-v0-holding-transfer-transferofferacceptresult-11622: `TransferOffer_Accept_Result `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - acceptedTransferCid - `ContractId `_ `AcceptedTransfer `_ - Accepted transfer\. .. _type-utility-registry-v0-holding-transfer-transferoffercancelresult-23889: **data** `TransferOffer_Cancel_Result `_ .. _constr-utility-registry-v0-holding-transfer-transferoffercancelresult-55260: `TransferOffer_Cancel_Result `_ (no fields) .. _type-utility-registry-v0-holding-transfer-transferofferrejectresult-30476: **data** `TransferOffer_Reject_Result `_ Result of ``TransferOffer_Reject``\. .. _constr-utility-registry-v0-holding-transfer-transferofferrejectresult-86309: `TransferOffer_Reject_Result `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - rejectedTransferCid - `ContractId `_ `RejectedTransfer `_ - Rejected transfer\. .. _type-utility-registry-v0-holding-transfer-transferrequestacceptresult-4416: **data** `TransferRequest_Accept_Result `_ Result of ``TransferRequest_Accept``\. .. _constr-utility-registry-v0-holding-transfer-transferrequestacceptresult-89313: `TransferRequest_Accept_Result `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - acceptedTransferCid - `ContractId `_ `AcceptedTransfer `_ - Accepted transfer\. .. _type-utility-registry-v0-holding-transfer-transferrequestcancelresult-53074: **data** `TransferRequest_Cancel_Result `_ Result of ``TransferRequest_Cancel``\. .. _constr-utility-registry-v0-holding-transfer-transferrequestcancelresult-76123: `TransferRequest_Cancel_Result `_ (no fields) .. _type-utility-registry-v0-holding-transfer-transferrequestrejectresult-27311: **data** `TransferRequest_Reject_Result `_ Result of ``TransferRequest_Reject``\. .. _constr-utility-registry-v0-holding-transfer-transferrequestrejectresult-52682: `TransferRequest_Reject_Result `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - rejectedTransferCid - `ContractId `_ `RejectedTransfer `_ - Rejected transfer\.