Assets

Create an asset

Create an asset in your organization and link it to the program in program_id.

post/v1/assets

Request

  • Base URL: https://api.scrip.dev
  • URL: https://api.scrip.dev/v1/assets
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

A key you choose to make this request safe to retry: 1 to 255 printable ASCII characters. Send the same key with the same request to get the first response again, marked Idempotent-Replayed: true. Routes that return a secret once, and claim links, do not replay a response. Event ingest uses the key as the event's identity.

Request body

inventory_mode'SIMPLE' | 'LOT' required

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

issuance_policy'UNLIMITED' | 'PREFUNDED' required

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

max_transaction_amountstring

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

namestring required

The name people see for the asset, such as Points.

program_idstring uuid required

Program to link this asset to

scaleinteger required

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

symbolstring required

Short code for this asset, unique in your organization.

Example request

{
  "inventory_mode": "SIMPLE",
  "issuance_policy": "UNLIMITED",
  "max_transaction_amount": "10000.00",
  "name": "Points",
  "program_id": "8f14e45f-ceea-4e70-9df8-2a7d1b3c9f01",
  "scale": 2,
  "symbol": "PTS"
}

Response

Asset created

created_atstring date-time

When the asset was created

deleted_atstring date-time

Set when the asset is archived

idstring uuid

The id of the asset. Use it in asset_id fields and paths.

inventory_modestring

How balances are tracked

issuance_policystring

How value is issued

max_transaction_amountstring

Optional per-transaction ceiling. Null means no limit

namestring

The name people see for the asset, such as Points.

program_idsstring[]

Programs this asset is linked to

scaleinteger

Decimal precision

status'ACTIVE' | 'ARCHIVED'

Whether the asset is in use (ACTIVE) or retired (ARCHIVED).

symbolstring

Short code for this asset

updated_atstring date-time

When the asset was last modified

Example response

{
  "created_at": "2027-01-15T10:30:00Z",
  "deleted_at": "2027-01-15T10:30:00Z",
  "id": "a3bb189e-8bf9-4c8b-9be0-6b5d2f4e7a02",
  "inventory_mode": "SIMPLE",
  "issuance_policy": "UNLIMITED",
  "max_transaction_amount": "10000.00",
  "name": "Points",
  "program_ids": [
    "8f14e45f-ceea-4e70-9df8-2a7d1b3c9f01"
  ],
  "scale": 2,
  "status": "ACTIVE",
  "symbol": "PTS",
  "updated_at": "2027-01-15T10:30:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.