Skip to main content
POST
/
v1
/
programs
/
{id}
/
assets
/
{assetId}
/
burn
Burn program balance
curl --request POST \
  --url https://api.scrip.dev/v1/programs/{id}/assets/{assetId}/burn \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "amount": "500.00",
  "description": "Reduce Q1 budget"
}
'
{
  "available": "10000.00",
  "journal_entry_id": "550e8400-e29b-41d4-a716-446655440000",
  "message": "Program funded successfully"
}
Removes funds from a program’s wallet for a specific PREFUNDED asset. The burned amount is debited from the program wallet and credited to SYSTEM_BREAKAGE in the ledger. This is the inverse of the fund operation and is used to reduce a budget allocation after it has been set. This endpoint only applies to assets with an issuance_policy of PREFUNDED. Calling it on an UNLIMITED asset has no effect, since unlimited assets mint value on demand and do not use the wallet. You cannot burn more than the current wallet balance for the asset.
For usage patterns and examples, see the Programs guide.

Authorizations

​
X-API-Key
string
header
required

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

Path Parameters

​
id
string<uuid>
required

Program ID

​
assetId
string<uuid>
required

Asset ID

Body

application/json

Burn details

​
amount
string
required

Decimal amount to remove from the wallet

Minimum string length: 1
Example:

"500.00"

​
description
string

Reason for this burn

Maximum string length: 500
Example:

"Reduce Q1 budget"

Response

Burn successful

​
available
string

Wallet balance after the operation

Example:

"10000.00"

​
journal_entry_id
string<uuid>

Ledger journal entry created by this operation

Example:

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

​
message
string

Confirmation message

Example:

"Program funded successfully"