Skip to main content
POST
/
v1
/
assets
Create an asset
curl --request POST \
  --url https://api.scrip.dev/v1/assets \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "inventory_mode": "SIMPLE",
  "issuance_policy": "UNLIMITED",
  "name": "Bonus Points",
  "program_id": "550e8400-e29b-41d4-a716-446655440000",
  "scale": 2,
  "symbol": "PTS",
  "max_transaction_amount": "10000.00"
}
'
{
  "created_at": "2024-01-15T10:30:00Z",
  "deleted_at": "2023-11-07T05:31:56Z",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "inventory_mode": "SIMPLE",
  "issuance_policy": "UNLIMITED",
  "max_transaction_amount": "10000.00",
  "name": "Bonus Points",
  "program_ids": [
    "550e8400-e29b-41d4-a716-446655440001"
  ],
  "scale": 2,
  "status": "ACTIVE",
  "symbol": "PTS",
  "updated_at": "2024-01-15T10:30:00Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.scrip.dev/llms.txt

Use this file to discover all available pages before exploring further.

Creates a new asset in your organization. The asset is automatically linked to the specified program on creation. All fields are required:
  • program_id: the program to link this asset to
  • name and symbol: display name and short code
  • inventory_mode: SIMPLE tracks a single balance per participant; LOT tracks individual batches with expiration and vesting dates
  • issuance_policy: UNLIMITED mints value on demand with no budget cap; PREFUNDED draws from the program wallet
  • scale: decimal precision from 0 to 18 (e.g., 2 for dollars and cents)
The inventory_mode, issuance_policy, and scale fields are immutable after creation because they affect how the ledger records and resolves balances. If you need a different configuration, create a new asset.
For usage patterns and examples, see the Asset Configuration guide.

Authorizations

​
X-API-Key
string
header
required

API key passed in the X-API-Key header.

Body

application/json

Asset configuration

​
inventory_mode
enum<string>
required

SIMPLE tracks one balance per participant. LOT tracks individual batches with expiration and vesting dates. Immutable after creation

Available options:
SIMPLE,
LOT
Example:

"SIMPLE"

​
issuance_policy
enum<string>
required

UNLIMITED mints on demand with no budget cap. PREFUNDED draws from the program wallet. Immutable after creation

Available options:
UNLIMITED,
PREFUNDED
Example:

"UNLIMITED"

​
name
string
required

Asset name

Required string length: 1 - 255
Example:

"Bonus Points"

​
program_id
string<uuid>
required

Program to link this asset to

Example:

"550e8400-e29b-41d4-a716-446655440000"

​
scale
integer
required

Number of decimal places for amounts (e.g., 2 for dollars and cents). Immutable after creation

Required range: 0 <= x <= 18
Example:

2

​
symbol
string
required

Short code for this asset

Required string length: 1 - 16
Example:

"PTS"

​
max_transaction_amount
string

Optional per-transaction ceiling. Must be a positive decimal string. Null means no limit

Example:

"10000.00"

Response

Asset created

​
created_at
string<date-time>

When the asset was created

Example:

"2024-01-15T10:30:00Z"

​
deleted_at
string<date-time>

Set when the asset is archived

​
id
string<uuid>

Asset ID

Example:

"550e8400-e29b-41d4-a716-446655440000"

​
inventory_mode
string

How balances are tracked

Example:

"SIMPLE"

​
issuance_policy
string

How value is issued

Example:

"UNLIMITED"

​
max_transaction_amount
string

Optional per-transaction ceiling. Null means no limit

Example:

"10000.00"

​
name
string

Asset name

Example:

"Bonus Points"

​
program_ids
string[]

Programs this asset is linked to

Example:
["550e8400-e29b-41d4-a716-446655440001"]
​
scale
integer

Decimal precision

Example:

2

​
status
string

Lifecycle state

Example:

"ACTIVE"

​
symbol
string

Short code for this asset

Example:

"PTS"

​
updated_at
string<date-time>

When the asset was last modified

Example:

"2024-01-15T10:30:00Z"