Skip to main content
POST
/
api
/
v1
/
tokenization
/
collections
/
{id}
/
tokens
/
burn
Burn Token
curl --request POST \
  --url https://sandbox.oumla.com/api/v1/tokenization/collections/{id}/tokens/burn \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "addressId": "<string>",
  "clientShare": "<string>",
  "tokenId": "<string>",
  "from": "<string>",
  "amount": "<string>"
}'
{
  "message": "<string>",
  "data": {},
  "success": true,
  "status": 123
}

Authorizations

x-api-key
string
header
required

API key for authentication

Headers

x-sdk-version
string
default:1.0.0

SDK version for tracking and compatibility

Path Parameters

id
string
required

Collection ID

Body

application/json
addressId
string
required

Address ID for burning

Minimum length: 1
clientShare
string
required

Client share for signing

Minimum length: 1
tokenId
string
required

Token ID

Minimum length: 1
from
string

Address to burn from

amount
string

Token amount to burn

Response

200 - application/json

Token burned successfully

message
string
required

Response message

success
boolean
required

Indicates successful response

status
integer
required

HTTP status code

data
object

Response data