.. _module-utility-credential-app-v0-service-user-78885: Utility.Credential.App.V0.Service.User ====================================== Templates --------- .. _type-utility-credential-app-v0-service-user-userservice-51046: **template** `UserService `_ User service\. Signatory\: operator, user .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - operator - `Party `_ - App operator\. * - user - `Party `_ - App user\. * - dso - `Party `_ - Reference to the DSO party (Decentralized Synchronizer Operations)\. + **Choice** Archive Controller\: operator, user Returns\: () (no fields) + .. _type-utility-credential-app-v0-service-user-userserviceacceptfreecredentialoffer-26228: **Choice** `UserService_AcceptFreeCredentialOffer `_ Accepts a credential offer (of a free credential) from an issuer\. Controller\: user Returns\: :ref:`CredentialOffer_AcceptFree_Result ` .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - credentialOfferCid - `ContractId `_ :ref:`CredentialOffer ` - The offer to accept\. + .. _type-utility-credential-app-v0-service-user-userserviceacceptpaidcredentialoffer-7212: **Choice** `UserService_AcceptPaidCredentialOffer `_ Accepts a credential offer (of a paid credential) from an issuer\. Takes unlocked coins as input\. Beware of contention\. Retries may be required\. Controller\: user Returns\: :ref:`CredentialOffer_AcceptPaid_Result ` .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - credentialOfferCid - `ContractId `_ :ref:`CredentialOffer ` - The offer that the user accepts\. * - depositAmulets - \[`ContractId `_ `Amulet `_\] - Amulets to be locked as deposit\. * - appTransferContext - `AppTransferContext `_ - Canton Network transfer context required to perform locking\. + .. _type-utility-credential-app-v0-service-user-userserviceadjustbillingparams-27771: **Choice** `UserService_AdjustBillingParams `_ Changes the parameters of a credential billing\. Controller\: user Returns\: :ref:`CredentialBilling_AdjustBillingParams_Result ` .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - credentialBillingCid - `ContractId `_ :ref:`CredentialBilling ` - The credential billing that the user modifies\. * - billingParams - :ref:`BillingParams ` - The new parameters of the credential billing\. + .. _type-utility-credential-app-v0-service-user-userservicebillingparamsadjustmentrequestaccept-89481: **Choice** `UserService_BillingParamsAdjustmentRequest_Accept `_ Accepts a billing parameters adjustment request\. Controller\: user Returns\: :ref:`BillingParamsAdjustmentRequest_Accept_Result ` .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - requestCid - `ContractId `_ :ref:`BillingParamsAdjustmentRequest ` - The billing adjustment request to accept\. The ``credentialId`` must match with one in the given credential billing\. * - credentialBillingCid - `ContractId `_ :ref:`CredentialBilling ` - The credential billing that the user modifies\. The ``credentialId`` must match with the one in the given adjustment request\. + .. _type-utility-credential-app-v0-service-user-userservicebillingparamsadjustmentrequestcancel-24707: **Choice** `UserService_BillingParamsAdjustmentRequest_Cancel `_ Cancels a billing parameters adjustment request\. Controller\: user Returns\: :ref:`BillingParamsAdjustmentRequest_Cancel_Result ` .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - requestCid - `ContractId `_ :ref:`BillingParamsAdjustmentRequest ` - The billing adjustment request to cancel\. + .. _type-utility-credential-app-v0-service-user-userservicecancelcredentialbilling-24441: **Choice** `UserService_CancelCredentialBilling `_ Cancels a credential billing\. Controller\: user Returns\: :ref:`CredentialBilling_Cancel_Result ` .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - credentialBillingCid - `ContractId `_ :ref:`CredentialBilling ` - The credential billing that the user cancels\. * - appTransferContext - `AppTransferContext `_ - Canton Network transfer context required to perform locking\. + .. _type-utility-credential-app-v0-service-user-userservicecancelcredentialoffer-6992: **Choice** `UserService_CancelCredentialOffer `_ Cancels a credential offer made to a holder\. Controller\: user Returns\: :ref:`CredentialOffer_Cancel_Result ` .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - credentialOfferCid - `ContractId `_ :ref:`CredentialOffer ` - The offer to cancel\. + .. _type-utility-credential-app-v0-service-user-userservicedistribute-3789: **Choice** `UserService_Distribute `_ Distributes coins to a credential holder\. Takes unlocked coins as input\. Beware of contention\. Retries may be required\. Controller\: user Returns\: :ref:`CredentialBilling_Distribute_Result ` .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - credentialBillingCid - `ContractId `_ :ref:`CredentialBilling ` - Credential billing of the distribution recipient\. * - amountUsd - `Decimal `_ - Amount to distribute (in USD)\. * - coinCids - \[`ContractId `_ `Amulet `_\] - Coins to distribute\. * - appTransferContext - `AppTransferContext `_ - Coin transfer context\. + .. _type-utility-credential-app-v0-service-user-userservicedistributeandadjustdeposit-40237: **Choice** `UserService_DistributeAndAdjustDeposit `_ Distributes coins to and adjust / top up deposits for a credential holder\. Takes unlocked coins as input\. Beware of contention\. Retries may be required\. Controller\: user Returns\: :ref:`CredentialBilling_DistributeAndAdjustDeposit_Result ` .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - credentialBillingCid - `ContractId `_ :ref:`CredentialBilling ` - Credential billing of the distribution recipient\. * - amountUsd - `Decimal `_ - Amount to distribute (in USD)\. * - coinCids - \[`ContractId `_ `Amulet `_\] - Coins to distribute\. * - appTransferContext - `AppTransferContext `_ - Coin transfer context\. + .. _type-utility-credential-app-v0-service-user-userservicedistributeandadjustdepositmulti-59183: **Choice** `UserService_DistributeAndAdjustDepositMulti `_ Distributes coins to and adjust / top up deposits for multiple credential holders\. Takes unlocked coins as input\. Beware of contention\. Retries may be required\. Controller\: user Returns\: `UserService_DistributeAndAdjustDepositMulti_Result `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - distributionSlices - \[`DistributionSlice `_\] - Distribution slices to distribute to\. * - amountUsd - `Decimal `_ - Amount to distribute (in USD)\. * - coinCids - \[`ContractId `_ `Amulet `_\] - Coins to distribute\. * - appTransferContext - `AppTransferContext `_ - Coin transfer context\. + .. _type-utility-credential-app-v0-service-user-userservicedistributemulti-14607: **Choice** `UserService_DistributeMulti `_ Distributes coins to multiple credential holders\. Takes unlocked coins as input\. Beware of contention\. Retries may be required\. Controller\: user Returns\: `UserService_DistributeMulti_Result `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - distributionSlices - \[`DistributionSlice `_\] - Distribution slices to distribute to\. * - amountUsd - `Decimal `_ - Amount to distribute (in USD)\. * - coinCids - \[`ContractId `_ `Amulet `_\] - Coins to distribute\. * - appTransferContext - `AppTransferContext `_ - Coin transfer context\. + .. _type-utility-credential-app-v0-service-user-userserviceofferfreecredential-41720: **Choice** `UserService_OfferFreeCredential `_ Offers a free credential\. Controller\: user Returns\: `UserService_OfferFreeCredential_Result `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - holder - `Party `_ - Holder of the credential\. * - id - `Text `_ - Identifier of the credential\. * - description - `Text `_ - Description of the credential\. * - claims - \[`Claim `_\] - Claims contained in the credential\. + .. _type-utility-credential-app-v0-service-user-userserviceofferpaidcredential-58760: **Choice** `UserService_OfferPaidCredential `_ Offers a paid credential\. Controller\: user Returns\: `UserService_OfferPaidCredential_Result `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - holder - `Party `_ - Holder of the credential\. * - id - `Text `_ - Identifier of the credential\. * - description - `Text `_ - Description of the credential\. * - claims - \[`Claim `_\] - Claims contained in the credential\. * - billingParams - :ref:`BillingParams ` - Billing parameters of the credential\. * - depositInitialAmountUsd - `Optional `_ `Decimal `_ - The amount of USD to be initially locked (as CC) as a deposit to cover fee payments\. + .. _type-utility-credential-app-v0-service-user-userservicerejectcredentialoffer-52257: **Choice** `UserService_RejectCredentialOffer `_ Rejects a credential offer from an issuer\. Controller\: user Returns\: :ref:`CredentialOffer_Reject_Result ` .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - credentialOfferCid - `ContractId `_ :ref:`CredentialOffer ` - The offer to reject\. * - reason - `Text `_ - The reason for rejecting the offer\. + .. _type-utility-credential-app-v0-service-user-userservicerequesttoadjustbillingparams-20050: **Choice** `UserService_RequestToAdjustBillingParams `_ Changes the parameters of a credential billing\. Controller\: user Returns\: :ref:`CredentialBilling_RequestToAdjustBillingParams_Result ` .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - credentialBillingCid - `ContractId `_ :ref:`CredentialBilling ` - The credential billing that the user modifies\. * - billingParams - :ref:`BillingParams ` - The new parameters of the credential billing\. + .. _type-utility-credential-app-v0-service-user-userservicerevokecredential-29031: **Choice** `UserService_RevokeCredential `_ Revokes a (free or paid) credential\. Controller\: user Returns\: `Credential_Revoke_Result `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - credentialCid - `ContractId `_ `Credential `_ - The credential that the user revokes\. + .. _type-utility-credential-app-v0-service-user-userservicerevokecredentialandcancelbilling-55925: **Choice** `UserService_RevokeCredentialAndCancelBilling `_ Revokes a paid credential and cancels the corresponding credential billing\. Controller\: user Returns\: :ref:`CredentialBilling_Cancel_Result ` .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - credentialCid - `ContractId `_ `Credential `_ - The credential that the user revokes\. * - credentialBillingCid - `ContractId `_ :ref:`CredentialBilling ` - The credential billing that the user cancels\. * - appTransferContext - `AppTransferContext `_ - Canton Network transfer context required to perform locking\. + .. _type-utility-credential-app-v0-service-user-userserviceterminate-25248: **Choice** `UserService_Terminate `_ Terminates the user service\. Controller\: actor \`oneOf\` signatory this Returns\: `UserService_Terminate_Result `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - actor - `Party `_ - Party initiating the termination of this agreement\. + .. _type-utility-credential-app-v0-service-user-userservicetopup-73955: **Choice** `UserService_TopUp `_ Tops up a deposit for a paid credential\. Takes unlocked coins as input\. Beware of contention\. Retries may be required\. Controller\: user Returns\: :ref:`CredentialBilling_TopUp_Result ` .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - credentialBillingCid - `ContractId `_ :ref:`CredentialBilling ` - Credential billing to top up\. * - amountUsd - `Decimal `_ - Amount to top up (in USD)\. * - coinCids - \[`ContractId `_ `Amulet `_\] - Coins to be locked as deposit for the top\-up\. * - appTransferContext - `AppTransferContext `_ - Canton Network transfer context required to perform locking\. .. _type-utility-credential-app-v0-service-user-userservicerequest-47604: **template** `UserServiceRequest `_ Request for a UserService\. Signatory\: user .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - operator - `Party `_ - App operator\. * - user - `Party `_ - App user\. + **Choice** Archive Controller\: user Returns\: () (no fields) + .. _type-utility-credential-app-v0-service-user-userservicerequestaccept-22330: **Choice** `UserServiceRequest_Accept `_ Accepts a user service request\. Controller\: operator Returns\: `UserServiceRequest_Accept_Result `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - dso - `Party `_ - Reference to the DSO party (Decentralized Synchronizer Operations)\. + .. _type-utility-credential-app-v0-service-user-userservicerequestcancel-63924: **Choice** `UserServiceRequest_Cancel `_ Cancels a user service request\. Controller\: user Returns\: `UserServiceRequest_Cancel_Result `_ (no fields) + .. _type-utility-credential-app-v0-service-user-userservicerequestreject-18355: **Choice** `UserServiceRequest_Reject `_ Rejects a user service request\. Controller\: operator Returns\: `UserServiceRequest_Reject_Result `_ (no fields) Data Types ---------- .. _type-utility-credential-app-v0-service-user-distributionslice-75622: **data** `DistributionSlice `_ Encapsulates the percentage of a distribution a particular holder (represented by a credential billing) will receive\. .. _constr-utility-credential-app-v0-service-user-distributionslice-75575: `DistributionSlice `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - credentialBillingCid - `ContractId `_ :ref:`CredentialBilling ` - Credential billing of the recipient\. * - percentage - `Decimal `_ - Percentage of the total distribution distributed to the recipient\. .. _type-utility-credential-app-v0-service-user-userservicerequestacceptresult-77091: **data** `UserServiceRequest_Accept_Result `_ Result of ``UserServiceRequest_Accept``\. .. _constr-utility-credential-app-v0-service-user-userservicerequestacceptresult-64108: `UserServiceRequest_Accept_Result `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - userServiceCid - `ContractId `_ `UserService `_ - The created ``UserService``\. .. _type-utility-credential-app-v0-service-user-userservicerequestcancelresult-44773: **data** `UserServiceRequest_Cancel_Result `_ Result of ``UserServiceRequest_Cancel``\. .. _constr-utility-credential-app-v0-service-user-userservicerequestcancelresult-89426: `UserServiceRequest_Cancel_Result `_ (no fields) .. _type-utility-credential-app-v0-service-user-userservicerequestrejectresult-31340: **data** `UserServiceRequest_Reject_Result `_ Result of ``UserServiceRequest_Reject``\. .. _constr-utility-credential-app-v0-service-user-userservicerequestrejectresult-15431: `UserServiceRequest_Reject_Result `_ (no fields) .. _type-utility-credential-app-v0-service-user-userservicedistributeandadjustdepositmultiresult-34904: **data** `UserService_DistributeAndAdjustDepositMulti_Result `_ Result of ``UserService_DistributeAndAdjustDepositMulti``\. .. _constr-utility-credential-app-v0-service-user-userservicedistributeandadjustdepositmultiresult-35079: `UserService_DistributeAndAdjustDepositMulti_Result `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - transferResults - \[`TransferResult `_\] - The ``TransferResult`` for each distribution\. .. _type-utility-credential-app-v0-service-user-userservicedistributemultiresult-46776: **data** `UserService_DistributeMulti_Result `_ Result of ``UserService_DistributeMulti``\. .. _constr-utility-credential-app-v0-service-user-userservicedistributemultiresult-4699: `UserService_DistributeMulti_Result `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - transferResults - \[`TransferResult `_\] - The ``TransferResult`` for each distribution\. .. _type-utility-credential-app-v0-service-user-userserviceofferfreecredentialresult-85893: **data** `UserService_OfferFreeCredential_Result `_ Result of ``UserService_OfferFreeCredential``\. .. _constr-utility-credential-app-v0-service-user-userserviceofferfreecredentialresult-91770: `UserService_OfferFreeCredential_Result `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - credentialOfferCid - `ContractId `_ :ref:`CredentialOffer ` - The credential offer\. .. _type-utility-credential-app-v0-service-user-userserviceofferpaidcredentialresult-38933: **data** `UserService_OfferPaidCredential_Result `_ Result of ``UserService_OfferPaidCredential``\. .. _constr-utility-credential-app-v0-service-user-userserviceofferpaidcredentialresult-2774: `UserService_OfferPaidCredential_Result `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - credentialOfferCid - `ContractId `_ :ref:`CredentialOffer ` - The credential offer\. .. _type-utility-credential-app-v0-service-user-userserviceterminateresult-93905: **data** `UserService_Terminate_Result `_ Result of ``UserService_Terminate``\. .. _constr-utility-credential-app-v0-service-user-userserviceterminateresult-79030: `UserService_Terminate_Result `_ (no fields)