CashDesignAgreement¶
A cash design agreement describes the roles of a member in a cash design network. Members can have any or all of the following roles:
redeemer
- The member accepts cash of this design as payment for goods and services.
distributor
- The member has the ability to create and distribute cash of this design.
settler
- The member has the responsibility to settle transfers involving this design.
A list of CashDesignAgreement objects may contain both active and inactive agreements. Inactive agreements do not assign privileges or responsibilities to members.
Attributes¶
agreement_id
- String: the agreement ID.
profile_id
- String: the member’s profile ID.
active
- Boolean: true if the agreement is active.
redeemer
- Boolean: true if the member is a redeemer in this network (if the agreement is
active
) or may become a redeemer (if notactive
).
distributor
- Boolean: true if the member is a distributor in this network (if the agreement is
active
) or may become a distributor (if notactive
).
settler
- Boolean: true if the member is a settler in this network (if the agreement is
active
) or may become a settler (if notactive
).
terms_text
- String: a short, free form description of the terms of this agreement.
terms_link
- String: the URL to the terms of this agreement. May be empty.
active_since
- String: the ISO 8601 date and time when the agreement was accepted by both the network manager and the member.
null
if the agreement has not been accepted.
workflow_state
- String: the state of the agreement. Every agreement has a small workflow that can be in the
inactive
,active
,deactivated
, orremoved
state. New agreements start in theinactive
state.