Products
Last updated
Was this helpful?
Last updated
Was this helpful?
A product represents a digital security or a crypto security issued by an entity on a distributed ledger network.
Products are referenced in the API using the product ID. Using the products endpoint you can retrieve all products that you have created.
Digital securities or security tokens are securities that are not issued under the eWpG regulation in Germany.
Crypto securities are issued under the eWpG law where a crypto security registrar is taking care of KYC, AML, issuer identifications and is running an on chain registrar that holds the relation between investors and investments. Cashlink is operating as a crypto security registrar.
To create a product ensure, that you have done these steps before hand:
You've created an and have the ID of the issuer resource available.
You've uploaded the issuance document and have the ID of the document resource available.
The following data is needed to create a product:
Name
Name of the product. This will be displayed in Cashlink Frontends and in the smart contract
Product type
The legal type of the product. These types are available: DIGITAL_COMPANY_SHARE
BOND
SUBORDINATED_LOAN
PARTICIPATION_PAPER
PARTICIPATION_RIGHT,
AIF
DEBT_SECURITY
CONVERTIBLE_BOND
FUND_SHARE
Ewpg
If set to true, a crypto security will be created. There ensure, that the issuer creating the crypto security has performed the KYC. If set to false, a digital security will be created
ISIN
For crypto securities this is mandatory, for digital securities this is optional
Nominal amount
The price of the token per unit as stated in the issuance document
Maximal issuable amount
The maximum number of tokens units for sale. Must be the same as in the issuance document
Step size
The size of which the investor can invest
Agio
If an agio applies, it can be defined here
Payment deadline
How long do investors have to meet their payment obligations (in days)?
DLT network
The network where the smart contract should be deployed to. These networks are available: ETH-MAINNET ETH-TEST POLYGON-MAINNET POLYGON-AMOY STELLAR-PUBNET STELLAR-TESTNET
Code
To identify the asset. Must be smaller than 12 characters.
Calculation factor
The relation between one token and one asset. Will be 1 in most cases.
backup wallet
Backup wallet address on the DLT network. If you do not have a backup wallet, you can reach out to Cashlink via Client Service Desk to request one.
lock in time
Date until the tokens cannot be transfered
issuance document id
id of the issuance document
issuer id
id of the issuer
With the product id, you can fetch the status of the product. The product can be in these status:
Created
You have submitted the product data or the validation by Cashlink was not successfull.
Validation pending
If it is a crypto security, the product is in manual review by Cashlink This status does not exist for digital securities
Validation success
If it is a crypto security, the product validation by Cashlink was successful This status does not exist for digital securities
Processing
After the validation was successfull for crypto securities, or the creation was done for digital securities, the deployment process of the smart contract is started
Succeeded
The deployment of the smart contract is done and you can retrieve the smart contract address
Failed
The deployment has failed. Reach out to Cashlink Service Desk
Queued
The deployment on the DLT network is queued due to too many requests.
Unknown
The process is in an unknown state. Reach out to Cashlink Service Desk
Products can have one or more campaigns used on the primary market for distribution. The total available allocation of a product can be split into any number of campaigns. The total allocation spread across all campaigns must not exceed the total allocation of the product.
Campaigns are referenced in the API using the campaign ID. You can use the campaigns endpoints to retrieve all campaigns for a product.
To create a campaign ensure, that you have done these steps before hand:
The following data is needed to create a campaign:
Distribution platform id
Id of the distribution platform where the product is listed on
Name
Name of the campaign
Allocation
Number of token that are allocated in this campaign
Minimum number of tokens
Minimum number of tokens that must be purchased in one investment
Maximum number of tokens
Maximum number of tokens that can be purchased in one investment
Legal persons allowed
If set to true, legal persons are allowed to invest
Natural persons allowed
If set to false, legal persons are allowed to invest
Country
Residence country of the investor(s)
Rule type
Two rule types can be set: MINIMUM INVESTMENT AMOUNT: Only allows investments starting at a specific investment amount PUBLIC OFFERING: No restrictions apply to the creation of new investments.
is campaign active
If set to true, distributors can create investements for the campaign. If set to false no new investments can be made
After creating a campaign the only value that can be changed is the is_campaign_active field. If any other data of a campaign needs to be changed after initial creation, a new campaign must be created and the old one must be set to inactive.
You've created a and have the ID available.
The for a distribution platform and you have the distribution platform id available.