Issue & Transfer
to issue or issue+transfer SRR
Last updated
Was this helpful?
to issue or issue+transfer SRR
Last updated
Was this helpful?
POST
<base_url>/port/api/v1/commerce/srrs
Please replace <base_url>
as explained .
Feel free to include more than one issuance in a single request via the payload
array. The minimum number of issue requests is one. Though there is no fixed upper limit for the number of issue requests you can submit at one time, we recommend limiting batches to no more than 250 issue requests for optimal processing.
commerce-api-key*
string
Commerce API Key
issuer-address*
string
Contract Address of API Key owner
requestId
string
A requestId
given by the caller, to ensure requests are only processed once. If the requestId
is known and processed before, api will not process this call again, and respond with an error. A good practice is using random UUID.
*requestId
must be unique for a given issuer-address
. As a result any duplicate combination of requestId
and issuer-address
is instantly rejected with no impact on either.
payload*
array
payload[*].externalId*
string
An ID to identify the record in your system. We recommend to use UUID, but it can use any string as long it is unique in your system.
payload[*].metadata*
object
The API accepts versions 2.0 and higher.
payload[*].artistAddress*
string
The ethereum address of the artist of the artwork.
payload[*].isPrimaryIssuer*
boolean
If you are the primary issuer of this NFT, set this to true.
payload[*].lockExternalTransfer*
boolean
If you want to prevent your NFTs to be transferred on decentralized marketplaces, set this to true.
payload[*].to
string
Ethereum address target the NFT should be sent to after minting (Issue on Buyer).
If none is given the NFT will be minted into your LUW by default.
payload[*].attachmentFiles
Array<object>
Attachment files that will be included in SRR.
payload[*].attachmentFiles[*].name
string
The name of file.
This is used for when the file is downloaded or shown. The extension is recommended to be the same as the actual uploaded file.
payload[*].attachmentFiles[*].category
string
Please note that contract terms and thumbnail are NOT attachment files. The URL for contract terms and thumbnail are needed for metadata. (See metadata attribute)
payload[*].attachmentFiles[*].url
string
payload[*].collectionAddress
string
The address of collection that the SRR will belong to. This collection must be owned by the caller issuer-address
.
The API responds with 201. see Response Body results[*].status for details of each entry.
results
results of the request
Array
results[*].srr
Detail of the SRR. Please check example for detailed information.
object
results[*].externalId
ID to identify the SRR. Defined by client when calling.
string
results[*].status
string
If you have a TAG for a physical artwork please add
chipUIDs
and startbahnCertICTagUIDs both at the same time and they both need to contain the same value. The value is an array containing the list of the Chip UIDs. For example
Array of issue requests. Further constraints explained .
The metadata to be issued as a complex object. Detailed schema specification can be found .
Please refer to to understand the difference among the categories.
For the time being, the URL must be under Startbahn's GCS bucket. This can include finalUrl's that is the field in the response of the or a URL that has already been prepared for the client by Startbahn's team. Any other URL will result to rejecting the request without issuing the SRR
waiting_for_mining
wait for completion of blockchain mining. The status can be confirmed via or less favorably via REST endpoint.
Check the .
Check .