Utility.Credential.App.V0.Model.Offer

Templates

template CredentialOffer

An offer to create a credential, including the subscription price.

Signatory: operator, issuer

Field	Type	Description
operator	Party	Utility operator.
issuer	Party	Issuer of the credential.
holder	Party	Holder of the credential.
dso	Party	DSO (Decentralized Synchronizer Operations) party.
id	Text	Identifier of the credential.
description	Text	Description of the credential.
claims	[Claim]	Claims contained in the credential.
billingParams	Optional BillingParams	Billing parameters for the credential.
depositInitialAmountUsd	Optional Decimal	The amount of $ to be initially locked (as CC) as a deposit to cover fee payments. It can be different than the targetAmount specified in the credential billing parameters.

• Choice Archive

  Controller: operator, issuer

  Returns: ()

  (no fields)

• Choice CredentialOffer\_AcceptFree

  Accepts a free credential offer.

  Controller: holder

  Returns: CredentialOffer\_AcceptFree\_Result

  (no fields)

• Choice CredentialOffer\_AcceptPaid

  Accepts a paid credential offer.

  Controller: holder, operator

  Returns: CredentialOffer\_AcceptPaid\_Result

  Field	Type	Description
  holderInputs	[ContractId Amulet]	Amulet to be used to fund the deposit.
  appTransferContext	AppTransferContext	Context for the deposit funding transfer (effectively it is a lock rather than a Transfer).

• Choice CredentialOffer\_Cancel

  Cancels the credential offer.

  Controller: issuer, operator

  Returns: CredentialOffer\_Cancel\_Result

  (no fields)

• Choice CredentialOffer\_Reject

  Rejects the credential offer.

  Controller: holder, operator

  Returns: CredentialOffer\_Reject\_Result

  Field	Type	Description
  reason	Text	Reject reason.

template RejectedCredentialOffer

A rejected credential offer.

Signatory: (DA.Internal.Record.getField @”operator” offer)

Field	Type	Description
offer	CredentialOffer	Rejected offer payload.
reason	Text	Reject reason.

• Choice Archive

  Controller: (DA.Internal.Record.getField @”operator” offer)

  Returns: ()

  (no fields)

Data Types

data CredentialOffer\_AcceptFree\_Result

Result of accepting the offer for a free credential.

CredentialOffer\_AcceptFree\_Result

Field	Type	Description
credentialCid	ContractId Credential	The credential.

data CredentialOffer\_AcceptPaid\_Result

Result of accepting the offer for a paid credential.

CredentialOffer\_AcceptPaid\_Result

Field	Type	Description
credentialBillingCid	ContractId CredentialBilling	The credential billing.
credentialCid	ContractId Credential	The credential.

data CredentialOffer\_Cancel\_Result

Result of canceling the offer for a paid credential.

CredentialOffer\_Cancel\_Result

(no fields)

data CredentialOffer\_Reject\_Result

Result of rejecting the offer for a paid credential.

CredentialOffer\_Reject\_Result

Field	Type	Description
rejectedCredentialOfferCid	ContractId RejectedCredentialOffer	The rejected credential offer.