Instrument Types are used with reference to the InstrumentPayload field found in the Instrument Definition, Instrument Creation and Instrument Modification actions.
A Membership
| Field | Type | Description |
|---|---|---|
| AgeRestriction | AgeRestriction | Age restriction is used to specify required ages for instrument ownership. |
| ValidFrom | Timestamp | Example: Fri Nov 09 2018 09:00:00 GMT+1000 (AEST) |
| ExpirationTimestamp | Timestamp | Example: Fri Nov 09 2018 09:00:00 GMT+1000 (AEST) |
| ID | varchar(tiny) | Example: 34536457575486868 |
| MembershipClass | varchar(tiny) | Example: Owner, Administrator, Manager, General, can be NULL. |
| RoleType | varchar(tiny) | Example: Director, Partner, CEO, COO, etc., can be NULL from Roles in Resources/Roles |
| MembershipType | varchar(tiny) | Example: Silver, Platinum, can be NULL. |
| Description | varchar(small) | This field is always required. Example: Rights and duties listed. |
| TransfersPermitted | bool | Set to true if transfers are permitted between two parties, otherwise set to false to prevent peer-to-peer transfers. |
Currency, fiat money, cash. Issued by a monetary authority (eg. Reserve Bank of Australia, ECB, Bank of England). Currency is free of counterparty risk except for the risks associated with the management of the currency by the monetary authority and its recognition as acceptable legal tender by the market and associated government(s). Custody of currency must be backed by a 1:1 ratio, or a full reserve. A currency instrument type should be considered the digital equivalent of physical cash.
| Field | Type | Description |
|---|---|---|
| CurrencyCode | CurrencyType | International Organization for Standardization code for Currency. (Specification/Resources) This field is always required. Example: AUD |
| MonetaryAuthority | varchar(tiny) | Example: Reserve Bank of Australia |
| (Deprecated)Description | deprecated | Deprecated because the currency instrument should be distinguished by its meta data and contract. Example: Australian dollar |
| Precision | uint(8) | Required field to specify the decimal precision of a currency. It will normally be the "precision" value associated with the CurrencyCode. It is the number of decimal places between the number of tokens and the common unit of measure. For example, in AUD, the common unit is the dollar, but a token would only be worth a penny. So the precision should be 2 for the two decimal places in a dollar amount "$1.00". In this scenario 100 tokens are worth $1. This field is always required. Example: 100 |
Common stock represents ownership interests in companies.
| Field | Type | Description |
|---|---|---|
| Ticker | fixedchar(5) | Ticker symbol assigned by exchanges to represent the instrument. Example: AAPL |
| ISIN | fixedchar(12) | International Securities Identification Number Example: US0004026250 |
| Description | varchar(small) | This field is always required. Example: Class C |
| TransfersPermitted | bool | Set to true if transfers are permitted between two parties, otherwise set to false to prevent peer-to-peer transfers. |
A fixed rate bond is a bond that pays the same level of interest over its entire term. An investor who wants to earn a guaranteed interest rate for a specified term could purchase a fixed rate bond in the form of a Treasury, corporate bond, municipal bond, or certificate of deposit (CD).
| Field | Type | Description |
|---|---|---|
| Name | varchar(tiny) | Name of bond Example: City of Chicago, Midway Airport, Series 2001A |
| BondType | fixedchar(1) |
Type of bond.
C - Corporate M - Municipal G - Government / Sovereign This field is always required. Example: C |
| ISIN | varchar(tiny) | International Securities Identification Number or Committee on Uniform Securities Identification Procedures. Example: US0004026250 |
| Collateral | varchar(small) | An instrument that secures securing the bond. If null, then the bond is unsecured. |
| ParValue | CurrencyValue | Par value of the bond. The value that will be paid at maturity. This field is always required. |
| InterestRate | Rate | The fixed interest rate of the bond. |
| InterestPaymentInitialDate | TimestampSeconds | Unix epoch date time (in seconds) for the first interest payment. This field is required when the field InterestRate is specified. This field is only valid when the field InterestRate is specified. |
| InterestPaymentDateDeltas | uint[0] | Number of seconds from the previous interest payment until the next payment. A delta in seconds from the previous payment. This field is required when the field InterestRate is specified. This field is only valid when the field InterestRate is specified. |
| LatePaymentPenaltyRate | Rate | The rate of the penalty per the penalty period. |
| LatePaymentWindow | TimestampSeconds | The amount of time after a payment is due before the late payment penalty is applied. This field is only valid when the field LatePaymentPenaltyRate is specified. |
| LatePaymentPenaltyPeriod | TimestampSeconds | The period at which the late payment penalty accrues. This field is only valid when the field LatePaymentPenaltyRate is specified. |
| MaturityDate | Timestamp | The date of the maturity of the bond. When the par value is paid. This field is always required. |
| AgeRestriction | AgeRestriction | Age restriction is used to specify required ages for instrument ownership. |
| TransfersPermitted | bool | Set to true if transfers are permitted between two parties, otherwise set to false to prevent peer-to-peer transfers. |
A voucher entitling the holder to a discount on a particular product or service.
| Field | Type | Description |
|---|---|---|
| RedeemingEntity | varchar(tiny) | The entity responsible for redemption of this coupon. Example: Woolworths - Robina Town Centre |
| ValidFromTimestamp | Timestamp | |
| ExpirationTimestamp | Timestamp | |
| (Deprecated)Value | deprecated | Deprecated for FaceValue. |
| (Deprecated)Currency | deprecated | Deprecated for FaceValue. |
| CouponName | varchar(tiny) | This field is always required. Example: Gift Card |
| (Deprecated)Precision | deprecated | Deprecated for FaceValue. |
| TransfersPermitted | bool | Set to true if transfers are permitted between two parties, otherwise set to false to prevent peer-to-peer transfers. |
| FaceValue | CurrencyValue | Face value of each coupon specified in a currency. |
| RedemptionVenue | varchar(tiny) | |
| Details | varchar(small) |
A Loyalty Point
| Field | Type | Description |
|---|---|---|
| AgeRestriction | AgeRestriction | Age restriction is used to specify required ages for instrument ownership. |
| ProgramName | varchar(tiny) | This field is always required. Example: Qantas Frequent Flyer Points |
| (Deprecated)ValidFrom | deprecated | |
| ExpirationTimestamp | Timestamp | |
| Details | varchar(small) | |
| TransfersPermitted | bool | Set to true if transfers are permitted between two parties, otherwise set to false to prevent peer-to-peer transfers. |
Admission ticket
| Field | Type | Description |
|---|---|---|
| AgeRestriction | AgeRestriction | Age restriction is used to specify required ages for instrument ownership. |
| (Deprecated)AdmissionType | deprecated | |
| Venue | varchar(tiny) | Example: Orion Cinemas - 293 Stehpens St, Vancouver, BC V4A 9V1 |
| (Deprecated)Class | deprecated | Example: Gold Class, Platinum, VIP, Section A, etc. |
| Area | varchar(tiny) | Example: Upper Bowl |
| Seat | varchar(tiny) | Example: Seat 5, or A122 |
| EventStartTimestamp | Timestamp | |
| (Deprecated)ValidFrom | deprecated | |
| (Deprecated)ExpirationTimestamp | deprecated | |
| EventName | varchar(tiny) | This field is always required. Example: Coingeek Conference - London (November 2018). |
| TransfersPermitted | bool | Set to true if transfers are permitted between two parties, otherwise set to false to prevent peer-to-peer transfers. |
| Details | varchar(small) | |
| Section | varchar(tiny) | Example: Sec 1 |
| Row | varchar(tiny) | Example: Sec 1 |
| EventEndTimestamp | Timestamp |
Casino Chip
| Field | Type | Description |
|---|---|---|
| (Deprecated)CurrencyCode | deprecated | Deprecated for FaceValue |
| UseType | fixedchar(1) | Real Money (R), Free Play (F) This field is always required. Example: R |
| AgeRestriction | AgeRestriction | Age restriction is used to specify required ages for instrument ownership. |
| (Deprecated)ValidFrom | deprecated | |
| ExpirationTimestamp | Timestamp | |
| (Deprecated)Precision | deprecated | Deprecated for FaceValue |
| TransfersPermitted | bool | Set to true if transfers are permitted between two parties, otherwise set to false to prevent peer-to-peer transfers. |
| CasinoName | varchar(tiny) | The name of the casino, or host, of the chip. This field is always required. |
| FaceValue | CurrencyValue | Face value of each coupon specified in a currency. This field is always required. |
Information Service License
| Field | Type | Description |
|---|---|---|
| AgeRestriction | AgeRestriction | Age restriction is used to specify required ages for instrument ownership. |
| ExpirationTimestamp | Timestamp | |
| ServiceName | varchar(tiny) | This field is always required. |
| TransfersPermitted | bool | Set to true if transfers are permitted between two parties, otherwise set to false to prevent peer-to-peer transfers. |
| URL | varchar(small) | URL linking to any related documents or media |
Age restriction is used to specify required ages for instrument ownership.
| Field | Type | Description |
|---|---|---|
| Lower | uint(1) | The lowest age valid to own instrument. Zero for no restriction. |
| Upper | uint(1) | The highest age valid to own instrument. Zero for no restriction. |
A value specified in terms of a currency.
| Field | Type | Description |
|---|---|---|
| Value | uint(8) | Denominated in precision specified in Precision field. This field is always required. Example: 100 |
| CurrencyCode | CurrencyType | International Organization for Standardization code for Currency. Currency for coupon. From resources/currency. This field is always required. Example: AUD |
| Precision | uint(1) | Required field to specify the decimal precision of the value. It will normally be the "precision" value associated with the Currency. It is the number of decimal places between the number of tokens and the common unit of measure. For example, in AUD, the common unit is the dollar, but a token would only be worth a penny. So the precision should be 2 for the two decimal places in a dollar amount "$1.00". In this scenario 100 tokens are worth $1. This field is always required. Example: 2 |
A rate value specified in terms of a precision.
| Field | Type | Description |
|---|---|---|
| Precision | uint(1) | Required field to specify the decimal precision of the value. It will normally be the "precision" value associated with the Currency. It is the number of decimal places between the number of tokens and the common unit of measure. For example, in AUD, the common unit is the dollar, but a token would only be worth a penny. So the precision should be 2 for the two decimal places in a dollar amount "$1.00". In this scenario 100 tokens are worth $1. Example: 2 |
| Value | uint(8) | Example: Denominated in precision specified in Precision field. |
| Field | Type | Description |
|---|---|---|
| CurrencyType | fixedchar(3) | International Organization for Standardization code for Currency. 3 character code. Example: AUD |
| Timestamp | uint(8) | Represents a time, encoded as a 64 bit unsigned integer representing the number of nanoseconds since the Unix epoch. Example: 1594668650000000000 |
| TimestampSeconds | uint(8) | Represents a time encoded as a 64 bit unsigned integer representing the number of seconds since the Unix epoch. Example: 1594668654 |
| Seconds | uint(8) | Represents a time delta encoded as a 64 bit unsigned integer representing the number of seconds since a previous timestamp. Example: 1500 |