.. _module-utility-registry-v0-holding-unlock-32937:

Utility.Registry.V0.Holding.Unlock
==================================

Templates
---------

.. _type-utility-registry-v0-holding-unlock-acceptedunlock-71558:

**template** `AcceptedUnlock <type-utility-registry-v0-holding-unlock-acceptedunlock-71558_>`_

  An accepted unlock\.

  Signatory\: (DA\.Internal\.Record\.getField @\"holder\" unlock), (DA\.Internal\.Record\.getField @\"locker\" unlock)

  .. list-table::
     :widths: 15 10 30
     :header-rows: 1

     * - Field
       - Type
       - Description
     * - unlock
       - `Unlock <type-utility-registry-v0-holding-unlock-unlock-40633_>`_
       - Accepted unlock payload\.
     * - holdingLabel
       - `Text <https://docs.daml.com/daml/stdlib/Prelude.html#type-ghc-types-text-51952>`_
       - Label of the holding to unlock\.

  + .. _type-utility-registry-v0-holding-unlock-acceptedunlockexecute-2222:

    **Choice** `AcceptedUnlock_Execute <type-utility-registry-v0-holding-unlock-acceptedunlockexecute-2222_>`_

    Execute an accepted unlock\.

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

    Returns\: `AcceptedUnlock_Execute_Result <type-utility-registry-v0-holding-unlock-acceptedunlockexecuteresult-26831_>`_

    .. list-table::
       :widths: 15 10 30
       :header-rows: 1

       * - Field
         - Type
         - Description
       * - instrumentConfigurationCid
         - `ContractId <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-contractid-95282>`_ :ref:`InstrumentConfiguration <type-utility-registry-v0-configuration-instrument-instrumentconfiguration-39219>`
         - Instrument configuration\.
       * - credentialCids
         - \[`ContractId <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-contractid-95282>`_ `Credential <https://docs.utility.canton.network.digitalasset.com/doc/daml-api/html/credential-model/Utility-Credential-V0-Credential.html#type-utility-credential-v0-credential-credential-66032>`_\]
         - Credentials of the holder\.
       * - holdingCids
         - \[`ContractId <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-contractid-95282>`_ `Holding <https://docs.utility.canton.network.digitalasset.com/doc/daml-api/html/registry-holding-model/Utility-Registry-Holding-V0-Holding.html#type-utility-registry-holding-v0-holding-holding-15575>`_\]
         - Holdings to unlock\.

  + .. _type-utility-registry-v0-holding-unlock-acceptedunlockfail-81830:

    **Choice** `AcceptedUnlock_Fail <type-utility-registry-v0-holding-unlock-acceptedunlockfail-81830_>`_

    Fail an accepted unlock\.

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

    Returns\: `AcceptedUnlock_Fail_Result <type-utility-registry-v0-holding-unlock-acceptedunlockfailresult-26955_>`_

    .. list-table::
       :widths: 15 10 30
       :header-rows: 1

       * - Field
         - Type
         - Description
       * - reason
         - `Text <https://docs.daml.com/daml/stdlib/Prelude.html#type-ghc-types-text-51952>`_
         - Reason for failure\.

  + **Choice** Archive

    Controller\: (DA\.Internal\.Record\.getField @\"holder\" unlock), (DA\.Internal\.Record\.getField @\"locker\" unlock)

    Returns\: ()

    (no fields)

.. _type-utility-registry-v0-holding-unlock-executedunlock-26346:

**template** `ExecutedUnlock <type-utility-registry-v0-holding-unlock-executedunlock-26346_>`_

  An executed unlock\.

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

  .. list-table::
     :widths: 15 10 30
     :header-rows: 1

     * - Field
       - Type
       - Description
     * - unlock
       - `Unlock <type-utility-registry-v0-holding-unlock-unlock-40633_>`_
       - Lock payload\.
     * - holdingLabel
       - `Text <https://docs.daml.com/daml/stdlib/Prelude.html#type-ghc-types-text-51952>`_
       - Label of the holding to unlock\.

  + **Choice** Archive

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

    Returns\: ()

    (no fields)

  + .. _type-utility-registry-v0-holding-unlock-executedunlockdelete-73525:

    **Choice** `ExecutedUnlock_Delete <type-utility-registry-v0-holding-unlock-executedunlockdelete-73525_>`_

    Deletes an executed unlock\.

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

    Returns\: `ExecutedUnlock_Delete_Result <type-utility-registry-v0-holding-unlock-executedunlockdeleteresult-29670_>`_

    (no fields)

.. _type-utility-registry-v0-holding-unlock-failedunlock-45636:

**template** `FailedUnlock <type-utility-registry-v0-holding-unlock-failedunlock-45636_>`_

  A failed unlock\.

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

  .. list-table::
     :widths: 15 10 30
     :header-rows: 1

     * - Field
       - Type
       - Description
     * - unlock
       - `Unlock <type-utility-registry-v0-holding-unlock-unlock-40633_>`_
       - Rejected unlock payload\.
     * - reason
       - `Text <https://docs.daml.com/daml/stdlib/Prelude.html#type-ghc-types-text-51952>`_
       - Reason for failure\.

  + **Choice** Archive

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

    Returns\: ()

    (no fields)

  + .. _type-utility-registry-v0-holding-unlock-failedunlockdelete-13699:

    **Choice** `FailedUnlock_Delete <type-utility-registry-v0-holding-unlock-failedunlockdelete-13699_>`_

    Deletes a rejected unlock\.

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

    Returns\: `FailedUnlock_Delete_Result <type-utility-registry-v0-holding-unlock-failedunlockdeleteresult-31500_>`_

    (no fields)

.. _type-utility-registry-v0-holding-unlock-rejectedunlock-48275:

**template** `RejectedUnlock <type-utility-registry-v0-holding-unlock-rejectedunlock-48275_>`_

  A rejected unlock\.

  Signatory\: (DA\.Internal\.Record\.getField @\"holder\" unlock), (DA\.Internal\.Record\.getField @\"locker\" unlock)

  .. list-table::
     :widths: 15 10 30
     :header-rows: 1

     * - Field
       - Type
       - Description
     * - unlock
       - `Unlock <type-utility-registry-v0-holding-unlock-unlock-40633_>`_
       - Rejected unlock payload\.
     * - reason
       - `Text <https://docs.daml.com/daml/stdlib/Prelude.html#type-ghc-types-text-51952>`_
       - Reason for rejection\.

  + **Choice** Archive

    Controller\: (DA\.Internal\.Record\.getField @\"holder\" unlock), (DA\.Internal\.Record\.getField @\"locker\" unlock)

    Returns\: ()

    (no fields)

  + .. _type-utility-registry-v0-holding-unlock-rejectedunlockdelete-85690:

    **Choice** `RejectedUnlock_Delete <type-utility-registry-v0-holding-unlock-rejectedunlockdelete-85690_>`_

    Deletes a rejected unlock\.

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

    Returns\: `RejectedUnlock_Delete_Result <type-utility-registry-v0-holding-unlock-rejectedunlockdeleteresult-88795_>`_

    (no fields)

.. _type-utility-registry-v0-holding-unlock-unlockoffer-45666:

**template** `UnlockOffer <type-utility-registry-v0-holding-unlock-unlockoffer-45666_>`_

  An offer to unlock a holding

  Signatory\: (DA\.Internal\.Record\.getField @\"provider\" unlock), (DA\.Internal\.Record\.getField @\"holder\" unlock)

  .. list-table::
     :widths: 15 10 30
     :header-rows: 1

     * - Field
       - Type
       - Description
     * - unlock
       - `Unlock <type-utility-registry-v0-holding-unlock-unlock-40633_>`_
       - Unlock payload\.
     * - holdingLabel
       - `Text <https://docs.daml.com/daml/stdlib/Prelude.html#type-ghc-types-text-51952>`_
       - Label of the holding to lock\.

  + **Choice** Archive

    Controller\: (DA\.Internal\.Record\.getField @\"provider\" unlock), (DA\.Internal\.Record\.getField @\"holder\" unlock)

    Returns\: ()

    (no fields)

  + .. _type-utility-registry-v0-holding-unlock-unlockofferaccept-29836:

    **Choice** `UnlockOffer_Accept <type-utility-registry-v0-holding-unlock-unlockofferaccept-29836_>`_

    Accepts a unlock offer\.

    Controller\: (DA\.Internal\.Record\.getField @\"locker\" unlock)

    Returns\: `UnlockOffer_Accept_Result <type-utility-registry-v0-holding-unlock-unlockofferacceptresult-15265_>`_

    (no fields)

  + .. _type-utility-registry-v0-holding-unlock-unlockoffercancel-75018:

    **Choice** `UnlockOffer_Cancel <type-utility-registry-v0-holding-unlock-unlockoffercancel-75018_>`_

    Cancels a unlock offer\.

    Controller\: (DA\.Internal\.Record\.getField @\"holder\" unlock)

    Returns\: `UnlockOffer_Cancel_Result <type-utility-registry-v0-holding-unlock-unlockoffercancelresult-55283_>`_

    (no fields)

  + .. _type-utility-registry-v0-holding-unlock-unlockofferreject-77157:

    **Choice** `UnlockOffer_Reject <type-utility-registry-v0-holding-unlock-unlockofferreject-77157_>`_

    Rejects a unlock offer\.

    Controller\: (DA\.Internal\.Record\.getField @\"locker\" unlock)

    Returns\: `UnlockOffer_Reject_Result <type-utility-registry-v0-holding-unlock-unlockofferrejectresult-94410_>`_

    .. list-table::
       :widths: 15 10 30
       :header-rows: 1

       * - Field
         - Type
         - Description
       * - reason
         - `Text <https://docs.daml.com/daml/stdlib/Prelude.html#type-ghc-types-text-51952>`_
         - Reason for rejection\.

.. _type-utility-registry-v0-holding-unlock-unlockrequest-57709:

**template** `UnlockRequest <type-utility-registry-v0-holding-unlock-unlockrequest-57709_>`_

  A request to unlock a holding

  Signatory\: (DA\.Internal\.Record\.getField @\"provider\" unlock), (DA\.Internal\.Record\.getField @\"locker\" unlock)

  .. list-table::
     :widths: 15 10 30
     :header-rows: 1

     * - Field
       - Type
       - Description
     * - unlock
       - `Unlock <type-utility-registry-v0-holding-unlock-unlock-40633_>`_
       - Lock offer payload\.

  + **Choice** Archive

    Controller\: (DA\.Internal\.Record\.getField @\"provider\" unlock), (DA\.Internal\.Record\.getField @\"locker\" unlock)

    Returns\: ()

    (no fields)

  + .. _type-utility-registry-v0-holding-unlock-unlockrequestaccept-33277:

    **Choice** `UnlockRequest_Accept <type-utility-registry-v0-holding-unlock-unlockrequestaccept-33277_>`_

    Accepts an unlock request\.

    Controller\: (DA\.Internal\.Record\.getField @\"holder\" unlock)

    Returns\: `UnlockRequest_Accept_Result <type-utility-registry-v0-holding-unlock-unlockrequestacceptresult-93514_>`_

    .. list-table::
       :widths: 15 10 30
       :header-rows: 1

       * - Field
         - Type
         - Description
       * - holdingLabel
         - `Text <https://docs.daml.com/daml/stdlib/Prelude.html#type-ghc-types-text-51952>`_
         - Label of the holding to lock\.

  + .. _type-utility-registry-v0-holding-unlock-unlockrequestcancel-92831:

    **Choice** `UnlockRequest_Cancel <type-utility-registry-v0-holding-unlock-unlockrequestcancel-92831_>`_

    Cancels an unlock request\.

    Controller\: (DA\.Internal\.Record\.getField @\"locker\" unlock)

    Returns\: `UnlockRequest_Cancel_Result <type-utility-registry-v0-holding-unlock-unlockrequestcancelresult-80824_>`_

    (no fields)

  + .. _type-utility-registry-v0-holding-unlock-unlockrequestreject-93744:

    **Choice** `UnlockRequest_Reject <type-utility-registry-v0-holding-unlock-unlockrequestreject-93744_>`_

    Rejects an unlock request\.

    Controller\: (DA\.Internal\.Record\.getField @\"holder\" unlock)

    Returns\: `UnlockRequest_Reject_Result <type-utility-registry-v0-holding-unlock-unlockrequestrejectresult-37617_>`_

    .. list-table::
       :widths: 15 10 30
       :header-rows: 1

       * - Field
         - Type
         - Description
       * - reason
         - `Text <https://docs.daml.com/daml/stdlib/Prelude.html#type-ghc-types-text-51952>`_
         - Reason for rejection\.

Data Types
----------

.. _type-utility-registry-v0-holding-unlock-acceptedunlockexecuteresult-26831:

**data** `AcceptedUnlock_Execute_Result <type-utility-registry-v0-holding-unlock-acceptedunlockexecuteresult-26831_>`_

  Result of ``AcceptedUnlock_Execute``\.

  .. _constr-utility-registry-v0-holding-unlock-acceptedunlockexecuteresult-21818:

  `AcceptedUnlock_Execute_Result <constr-utility-registry-v0-holding-unlock-acceptedunlockexecuteresult-21818_>`_

    .. list-table::
       :widths: 15 10 30
       :header-rows: 1

       * - Field
         - Type
         - Description
       * - holdingCid
         - `ContractId <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-contractid-95282>`_ `Holding <https://docs.utility.canton.network.digitalasset.com/doc/daml-api/html/registry-holding-model/Utility-Registry-Holding-V0-Holding.html#type-utility-registry-holding-v0-holding-holding-15575>`_
         - Result of unlock\.
       * - remainingCids
         - \[`ContractId <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-contractid-95282>`_ `Holding <https://docs.utility.canton.network.digitalasset.com/doc/daml-api/html/registry-holding-model/Utility-Registry-Holding-V0-Holding.html#type-utility-registry-holding-v0-holding-holding-15575>`_\]
         - Remaining locked holdings\.
       * - executedUnlockCid
         - `ContractId <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-contractid-95282>`_ `ExecutedUnlock <type-utility-registry-v0-holding-unlock-executedunlock-26346_>`_
         - Executed unlock\.

.. _type-utility-registry-v0-holding-unlock-acceptedunlockfailresult-26955:

**data** `AcceptedUnlock_Fail_Result <type-utility-registry-v0-holding-unlock-acceptedunlockfailresult-26955_>`_

  Result of ``AcceptedUnlock_Fail``\.

  .. _constr-utility-registry-v0-holding-unlock-acceptedunlockfailresult-20748:

  `AcceptedUnlock_Fail_Result <constr-utility-registry-v0-holding-unlock-acceptedunlockfailresult-20748_>`_

    .. list-table::
       :widths: 15 10 30
       :header-rows: 1

       * - Field
         - Type
         - Description
       * - failedUnlockCid
         - `ContractId <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-contractid-95282>`_ `FailedUnlock <type-utility-registry-v0-holding-unlock-failedunlock-45636_>`_
         - Failed unlock\.

.. _type-utility-registry-v0-holding-unlock-executedunlockdeleteresult-29670:

**data** `ExecutedUnlock_Delete_Result <type-utility-registry-v0-holding-unlock-executedunlockdeleteresult-29670_>`_

  Result of ``ExecutedUnlock_Delete``\.

  .. _constr-utility-registry-v0-holding-unlock-executedunlockdeleteresult-56513:

  `ExecutedUnlock_Delete_Result <constr-utility-registry-v0-holding-unlock-executedunlockdeleteresult-56513_>`_

    (no fields)

.. _type-utility-registry-v0-holding-unlock-failedunlockdeleteresult-31500:

**data** `FailedUnlock_Delete_Result <type-utility-registry-v0-holding-unlock-failedunlockdeleteresult-31500_>`_

  Result of ``FailedUnlock_Delete``\.

  .. _constr-utility-registry-v0-holding-unlock-failedunlockdeleteresult-69907:

  `FailedUnlock_Delete_Result <constr-utility-registry-v0-holding-unlock-failedunlockdeleteresult-69907_>`_

    (no fields)

.. _type-utility-registry-v0-holding-unlock-rejectedunlockdeleteresult-88795:

**data** `RejectedUnlock_Delete_Result <type-utility-registry-v0-holding-unlock-rejectedunlockdeleteresult-88795_>`_

  Result of ``RejectedUnlock_Delete``\.

  .. _constr-utility-registry-v0-holding-unlock-rejectedunlockdeleteresult-60896:

  `RejectedUnlock_Delete_Result <constr-utility-registry-v0-holding-unlock-rejectedunlockdeleteresult-60896_>`_

    (no fields)

.. _type-utility-registry-v0-holding-unlock-unlock-40633:

**data** `Unlock <type-utility-registry-v0-holding-unlock-unlock-40633_>`_

  Unlock payload\.

  .. _constr-utility-registry-v0-holding-unlock-unlock-76702:

  `Unlock <constr-utility-registry-v0-holding-unlock-unlock-76702_>`_

    .. list-table::
       :widths: 15 10 30
       :header-rows: 1

       * - Field
         - Type
         - Description
       * - operator
         - `Party <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-party-57932>`_
         - Utility operator\.
       * - provider
         - `Party <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-party-57932>`_
         - Provider of the initiator of the unlock\.
       * - registrar
         - `Party <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-party-57932>`_
         - Registrar of holding\.
       * - holder
         - `Party <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-party-57932>`_
         - Holder\.
       * - locker
         - `Party <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-party-57932>`_
         - Locker\.
       * - lockContext
         - `Text <https://docs.daml.com/daml/stdlib/Prelude.html#type-ghc-types-text-51952>`_
         - Context for the lock\.
       * - instrumentIdentifier
         - `InstrumentIdentifier <https://docs.utility.canton.network.digitalasset.com/doc/daml-api/html/registry-holding-model/Utility-Registry-Holding-V0-Types.html#type-utility-registry-holding-v0-types-instrumentidentifier-9531>`_
         - Instrument id to unlock\.
       * - amount
         - `Decimal <https://docs.daml.com/daml/stdlib/Prelude.html#type-ghc-types-decimal-18135>`_
         - Amount to unlock\.
       * - reference
         - `Text <https://docs.daml.com/daml/stdlib/Prelude.html#type-ghc-types-text-51952>`_
         - Reference for the unlock\.
       * - batch
         - :ref:`Batch <type-utility-registry-v0-types-batch-47769>`
         - Batch the unlock belongs to\.

.. _type-utility-registry-v0-holding-unlock-unlockofferacceptresult-15265:

**data** `UnlockOffer_Accept_Result <type-utility-registry-v0-holding-unlock-unlockofferacceptresult-15265_>`_

  Result of ``UnlockOffer_Accept``\.

  .. _constr-utility-registry-v0-holding-unlock-unlockofferacceptresult-88332:

  `UnlockOffer_Accept_Result <constr-utility-registry-v0-holding-unlock-unlockofferacceptresult-88332_>`_

    .. list-table::
       :widths: 15 10 30
       :header-rows: 1

       * - Field
         - Type
         - Description
       * - acceptedUnlockCid
         - `ContractId <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-contractid-95282>`_ `AcceptedUnlock <type-utility-registry-v0-holding-unlock-acceptedunlock-71558_>`_
         - Accepted unlock\.

.. _type-utility-registry-v0-holding-unlock-unlockoffercancelresult-55283:

**data** `UnlockOffer_Cancel_Result <type-utility-registry-v0-holding-unlock-unlockoffercancelresult-55283_>`_

  Result of ``UnlockOffer_Cancel``\.

  .. _constr-utility-registry-v0-holding-unlock-unlockoffercancelresult-11302:

  `UnlockOffer_Cancel_Result <constr-utility-registry-v0-holding-unlock-unlockoffercancelresult-11302_>`_

    (no fields)

.. _type-utility-registry-v0-holding-unlock-unlockofferrejectresult-94410:

**data** `UnlockOffer_Reject_Result <type-utility-registry-v0-holding-unlock-unlockofferrejectresult-94410_>`_

  Result of ``UnlockOffer_Reject``\.

  .. _constr-utility-registry-v0-holding-unlock-unlockofferrejectresult-33923:

  `UnlockOffer_Reject_Result <constr-utility-registry-v0-holding-unlock-unlockofferrejectresult-33923_>`_

    .. list-table::
       :widths: 15 10 30
       :header-rows: 1

       * - Field
         - Type
         - Description
       * - rejectedUnlockCid
         - `ContractId <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-contractid-95282>`_ `RejectedUnlock <type-utility-registry-v0-holding-unlock-rejectedunlock-48275_>`_
         - Rejected unlock\.

.. _type-utility-registry-v0-holding-unlock-unlockrequestacceptresult-93514:

**data** `UnlockRequest_Accept_Result <type-utility-registry-v0-holding-unlock-unlockrequestacceptresult-93514_>`_

  Result of ``UnlockRequest_Accept``\.

  .. _constr-utility-registry-v0-holding-unlock-unlockrequestacceptresult-1955:

  `UnlockRequest_Accept_Result <constr-utility-registry-v0-holding-unlock-unlockrequestacceptresult-1955_>`_

    .. list-table::
       :widths: 15 10 30
       :header-rows: 1

       * - Field
         - Type
         - Description
       * - acceptedUnlockCid
         - `ContractId <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-contractid-95282>`_ `AcceptedUnlock <type-utility-registry-v0-holding-unlock-acceptedunlock-71558_>`_
         - Accepted unlock\.

.. _type-utility-registry-v0-holding-unlock-unlockrequestcancelresult-80824:

**data** `UnlockRequest_Cancel_Result <type-utility-registry-v0-holding-unlock-unlockrequestcancelresult-80824_>`_

  Result of ``UnlockRequest_Cancel``\.

  .. _constr-utility-registry-v0-holding-unlock-unlockrequestcancelresult-90881:

  `UnlockRequest_Cancel_Result <constr-utility-registry-v0-holding-unlock-unlockrequestcancelresult-90881_>`_

    (no fields)

.. _type-utility-registry-v0-holding-unlock-unlockrequestrejectresult-37617:

**data** `UnlockRequest_Reject_Result <type-utility-registry-v0-holding-unlock-unlockrequestrejectresult-37617_>`_

  Result of ``UnlockRequest_Reject``\.

  .. _constr-utility-registry-v0-holding-unlock-unlockrequestrejectresult-98748:

  `UnlockRequest_Reject_Result <constr-utility-registry-v0-holding-unlock-unlockrequestrejectresult-98748_>`_

    .. list-table::
       :widths: 15 10 30
       :header-rows: 1

       * - Field
         - Type
         - Description
       * - rejectedUnlockCid
         - `ContractId <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-contractid-95282>`_ `RejectedUnlock <type-utility-registry-v0-holding-unlock-rejectedunlock-48275_>`_
         - Rejected unlock\.