.. _module-utility-registry-v0-holding-forcetransfer-85324: Utility.Registry.V0.Holding.ForceTransfer ========================================= Templates --------- .. _type-utility-registry-v0-holding-forcetransfer-acceptedforcetransfer-12168: **template** `AcceptedForceTransfer `_ Signatory\: (DA\.Internal\.Record\.getField @\"provider\" (DA\.Internal\.Record\.getField @\"transfer\" forceTransfer)), (DA\.Internal\.Record\.getField @\"requestor\" forceTransfer), (DA\.Internal\.Record\.getField @\"sender\" (DA\.Internal\.Record\.getField @\"transfer\" forceTransfer)), (DA\.Internal\.Record\.getField @\"receiver\" (DA\.Internal\.Record\.getField @\"transfer\" forceTransfer)) .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - forceTransfer - `ForceTransfer `_ - The accepted force transfer payload\. * - registrarRationale - `Text `_ - Registrar's rationale for accepting the request\. + .. _type-utility-registry-v0-holding-forcetransfer-acceptedforcetransferexecute-52232: **Choice** `AcceptedForceTransfer_Execute `_ Executes the accepted force transfer request\. Controller\: (DA\.Internal\.Record\.getField @\"registrar\" (DA\.Internal\.Record\.getField @\"transfer\" forceTransfer)) Returns\: `AcceptedForceTransfer_Execute_Result `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - instrumentConfigurationCid - `ContractId `_ :ref:`InstrumentConfiguration ` - Instrument configuration\. * - holdingCids - \[`ContractId `_ `Holding `_\] - Holdings to use for transfer\. * - requestorCredentialCids - \[`ContractId `_ `Credential `_\] - Credentials of requestor\. + .. _type-utility-registry-v0-holding-forcetransfer-acceptedforcetransferfail-6372: **Choice** `AcceptedForceTransfer_Fail `_ Fail an accepted lock\. Controller\: (DA\.Internal\.Record\.getField @\"registrar\" (DA\.Internal\.Record\.getField @\"transfer\" forceTransfer)) Returns\: `AcceptedForceTransfer_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 @\"provider\" (DA\.Internal\.Record\.getField @\"transfer\" forceTransfer)), (DA\.Internal\.Record\.getField @\"requestor\" forceTransfer), (DA\.Internal\.Record\.getField @\"sender\" (DA\.Internal\.Record\.getField @\"transfer\" forceTransfer)), (DA\.Internal\.Record\.getField @\"receiver\" (DA\.Internal\.Record\.getField @\"transfer\" forceTransfer)) Returns\: () (no fields) .. _type-utility-registry-v0-holding-forcetransfer-executedforcetransfer-93124: **template** `ExecutedForceTransfer `_ An executed force transfer\. Signatory\: (DA\.Internal\.Record\.getField @\"registrar\" (DA\.Internal\.Record\.getField @\"transfer\" forceTransfer)) .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - forceTransfer - `ForceTransfer `_ - Force transfer payload\. * - registrarRationale - `Text `_ - Registrar's rationale for accepting the request\. + **Choice** Archive Controller\: (DA\.Internal\.Record\.getField @\"registrar\" (DA\.Internal\.Record\.getField @\"transfer\" forceTransfer)) Returns\: () (no fields) + .. _type-utility-registry-v0-holding-forcetransfer-executedforcetransferdelete-28131: **Choice** `ExecutedForceTransfer_Delete `_ Deletes an executed transfer\. Controller\: (DA\.Internal\.Record\.getField @\"registrar\" (DA\.Internal\.Record\.getField @\"transfer\" forceTransfer)) Returns\: `ExecutedForceTransfer_Delete_Result `_ (no fields) .. _type-utility-registry-v0-holding-forcetransfer-failedforcetransfer-67882: **template** `FailedForceTransfer `_ A failed force transfer\. Signatory\: (DA\.Internal\.Record\.getField @\"registrar\" (DA\.Internal\.Record\.getField @\"transfer\" forceTransfer)) .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - forceTransfer - `ForceTransfer `_ - Rejected force transfer payload\. * - reason - `Text `_ - Reason for failure\. + **Choice** Archive Controller\: (DA\.Internal\.Record\.getField @\"registrar\" (DA\.Internal\.Record\.getField @\"transfer\" forceTransfer)) Returns\: () (no fields) + .. _type-utility-registry-v0-holding-forcetransfer-failedforcetransferdelete-87169: **Choice** `FailedForceTransfer_Delete `_ Deletes a rejected force transfer\. Controller\: (DA\.Internal\.Record\.getField @\"registrar\" (DA\.Internal\.Record\.getField @\"transfer\" forceTransfer)) Returns\: `FailedForceTransfer_Delete_Result `_ (no fields) .. _type-utility-registry-v0-holding-forcetransfer-forcetransferrequest-23761: **template** `ForceTransferRequest `_ A request to force transfer\. Signatory\: (DA\.Internal\.Record\.getField @\"provider\" (DA\.Internal\.Record\.getField @\"transfer\" forceTransfer)), (DA\.Internal\.Record\.getField @\"requestor\" forceTransfer) .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - forceTransfer - `ForceTransfer `_ - The force transfer payload\. + **Choice** Archive Controller\: (DA\.Internal\.Record\.getField @\"provider\" (DA\.Internal\.Record\.getField @\"transfer\" forceTransfer)), (DA\.Internal\.Record\.getField @\"requestor\" forceTransfer) Returns\: () (no fields) + .. _type-utility-registry-v0-holding-forcetransfer-forcetransferrequestaccept-60537: **Choice** `ForceTransferRequest_Accept `_ Accepts request\. Controller\: (DA\.Internal\.Record\.getField @\"registrar\" (DA\.Internal\.Record\.getField @\"transfer\" forceTransfer)), (DA\.Internal\.Record\.getField @\"sender\" (DA\.Internal\.Record\.getField @\"transfer\" forceTransfer)), (DA\.Internal\.Record\.getField @\"receiver\" (DA\.Internal\.Record\.getField @\"transfer\" forceTransfer)) Returns\: `ForceTransferRequest_Accept_Result `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - registrarRationale - `Text `_ - Registrar's rationale for accepting the request\. + .. _type-utility-registry-v0-holding-forcetransfer-forcetransferrequestcancel-28243: **Choice** `ForceTransferRequest_Cancel `_ Cancels request\. Controller\: (DA\.Internal\.Record\.getField @\"requestor\" forceTransfer) Returns\: `ForceTransferRequest_Cancel_Result `_ (no fields) + .. _type-utility-registry-v0-holding-forcetransfer-forcetransferrequestreject-41560: **Choice** `ForceTransferRequest_Reject `_ Rejects request\. Controller\: (DA\.Internal\.Record\.getField @\"registrar\" (DA\.Internal\.Record\.getField @\"transfer\" forceTransfer)) Returns\: `ForceTransferRequest_Reject_Result `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - reason - `Text `_ - Rejection reason\. .. _type-utility-registry-v0-holding-forcetransfer-rejectedforcetransfer-5743: **template** `RejectedForceTransfer `_ A rejected force transfer\. Signatory\: (DA\.Internal\.Record\.getField @\"registrar\" (DA\.Internal\.Record\.getField @\"transfer\" forceTransfer)) .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - forceTransfer - `ForceTransfer `_ - The rejected request payload\. * - reason - `Text `_ - The rejection reason\. + **Choice** Archive Controller\: (DA\.Internal\.Record\.getField @\"registrar\" (DA\.Internal\.Record\.getField @\"transfer\" forceTransfer)) Returns\: () (no fields) + .. _type-utility-registry-v0-holding-forcetransfer-rejectedforcetransferdelete-91066: **Choice** `RejectedForceTransfer_Delete `_ Deletes a rejected enforcement service request\. Controller\: (DA\.Internal\.Record\.getField @\"registrar\" (DA\.Internal\.Record\.getField @\"transfer\" forceTransfer)) Returns\: `RejectedForceTransfer_Delete_Result `_ (no fields) Data Types ---------- .. _type-utility-registry-v0-holding-forcetransfer-acceptedforcetransferexecuteresult-35289: **data** `AcceptedForceTransfer_Execute_Result `_ Result of ``ForceTransferRequest_Execute``\. .. _constr-utility-registry-v0-holding-forcetransfer-acceptedforcetransferexecuteresult-79168: `AcceptedForceTransfer_Execute_Result `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - holdingTransferResult - `Holding_Transfer_Result `_ - Result of transferring the holding\. * - executedForceTransferCid - `ContractId `_ `ExecutedForceTransfer `_ - Executed force transfer\. * - remainingHoldingCids - \[`ContractId `_ `Holding `_\] - Remaining holdings\. .. _type-utility-registry-v0-holding-forcetransfer-acceptedforcetransferfailresult-94105: **data** `AcceptedForceTransfer_Fail_Result `_ Result of ``AcceptedLock_Fail``\. .. _constr-utility-registry-v0-holding-forcetransfer-acceptedforcetransferfailresult-49946: `AcceptedForceTransfer_Fail_Result `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - failedForceTransferCid - `ContractId `_ `FailedForceTransfer `_ - Failed force transfer\. .. _type-utility-registry-v0-holding-forcetransfer-executedforcetransferdeleteresult-28052: **data** `ExecutedForceTransfer_Delete_Result `_ Result of ``ExecutedForceTransfer_Delete``\. .. _constr-utility-registry-v0-holding-forcetransfer-executedforcetransferdeleteresult-49499: `ExecutedForceTransfer_Delete_Result `_ (no fields) .. _type-utility-registry-v0-holding-forcetransfer-failedforcetransferdeleteresult-28646: **data** `FailedForceTransfer_Delete_Result `_ Result of ``FailedForceTransfer_Delete``\. .. _constr-utility-registry-v0-holding-forcetransfer-failedforcetransferdeleteresult-77825: `FailedForceTransfer_Delete_Result `_ (no fields) .. _type-utility-registry-v0-holding-forcetransfer-forcetransfer-43885: **data** `ForceTransfer `_ Force transfer payload\. .. _constr-utility-registry-v0-holding-forcetransfer-forcetransfer-30574: `ForceTransfer `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - requestor - `Party `_ - Party requesting the force transfer\. * - requestorRationale - `Text `_ - Requestor rationale for the force transfer\. * - transfer - :ref:`Transfer ` - Transfer payload\. * - senderLabel - `Text `_ - Label of the holding to transfer\. * - receiverLabel - `Text `_ - Label of the holding to receive\. .. _type-utility-registry-v0-holding-forcetransfer-forcetransferrequestacceptresult-18066: **data** `ForceTransferRequest_Accept_Result `_ Result of ``ForceTransferRequest_Accept``\. .. _constr-utility-registry-v0-holding-forcetransfer-forcetransferrequestacceptresult-2027: `ForceTransferRequest_Accept_Result `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - acceptedForceTransferCid - `ContractId `_ `AcceptedForceTransfer `_ - Accepted force transfer\. .. _type-utility-registry-v0-holding-forcetransfer-forcetransferrequestcancelresult-59852: **data** `ForceTransferRequest_Cancel_Result `_ Result of ``ForceTransferRequest_Cancel``\. .. _constr-utility-registry-v0-holding-forcetransfer-forcetransferrequestcancelresult-7813: `ForceTransferRequest_Cancel_Result `_ (no fields) .. _type-utility-registry-v0-holding-forcetransfer-forcetransferrequestrejectresult-32205: **data** `ForceTransferRequest_Reject_Result `_ Result of ``ForceTransferRequest_Reject``\. .. _constr-utility-registry-v0-holding-forcetransfer-forcetransferrequestrejectresult-23456: `ForceTransferRequest_Reject_Result `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - rejectedForceTransferCid - `ContractId `_ `RejectedForceTransfer `_ - Rejected force transfer request\. .. _type-utility-registry-v0-holding-forcetransfer-rejectedforcetransferdeleteresult-87015: **data** `RejectedForceTransfer_Delete_Result `_ Result of ``RejectedForceTransfer_Delete``\. .. _constr-utility-registry-v0-holding-forcetransfer-rejectedforcetransferdeleteresult-27828: `RejectedForceTransfer_Delete_Result `_ (no fields) Functions --------- .. _function-utility-registry-v0-holding-forcetransfer-prepareholdingwithamount-90980: `prepareHoldingWithAmount `_ \: `Decimal `_ \-\> \[`ContractId `_ `Holding `_\] \-\> `Update `_ (`ContractId `_ `Holding `_, \[`ContractId `_ `Holding `_\]) Prepare holdings to meet the target amount\.